Calendar Events
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
CalendarEvents | CalendarEventsQueryParams | CalendarEventsData |
Import Statement
from openbb_core.provider.standard_models.calendar_events import (
CalendarEventsData,
CalendarEventsQueryParams,
)
Parameters
- standard
- fmp
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Data
- standard
- fmp
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. The date of the event. |
symbol | str | Symbol representing the entity requested in the data. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. The date of the event. |
symbol | str | Symbol representing the entity requested in the data. |
exchange | str | Exchange where the symbol is listed. |
time | str | The estimated time of the event, local to the exchange. |
timing | str | The timing of the event - e.g. before, during, or after market hours. |
description | str | The title of the event. |
url | str | The URL to the press release for the announcement. |
announcement_date | date | The date when the event was announced. |