Economic Calendar
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EconomicCalendar | EconomicCalendarQueryParams | EconomicCalendarData |
Import Statement
from openbb_core.provider.standard_models.economic_calendar import (
EconomicCalendarData,
EconomicCalendarQueryParams,
)
Parameters
- standard
- fmp
- nasdaq
- tradingeconomics
| 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 |
| provider | Literal['fmp', 'nasdaq', 'tradingeconomics'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq, tradingeconomics. | 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 |
| provider | Literal['fmp', 'nasdaq', 'tradingeconomics'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq, tradingeconomics. | 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 |
| provider | Literal['fmp', 'nasdaq', 'tradingeconomics'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq, tradingeconomics. | None | True |
| country | Union[str, List[str]] | Country of the event Multiple items allowed for provider(s): nasdaq, tradingeconomics. | 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 |
| provider | Literal['fmp', 'nasdaq', 'tradingeconomics'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq, tradingeconomics. | None | True |
| country | Union[str, List[str]] | Country of the event. Multiple items allowed for provider(s): tradingeconomics. | None | True |
| importance | Literal['low', 'medium', 'high'] | Importance of the event. | None | True |
| group | Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business'] | Grouping of events. | None | True |
| calendar_id | Union[Union[str, int], List[Union[str, int]]] | Get events by TradingEconomics Calendar ID. Multiple items allowed for provider(s): tradingeconomics. | None | True |
Data
- standard
- fmp
- nasdaq
- tradingeconomics
| Name | Type | Description |
|---|---|---|
| date | datetime | The date of the data. |
| country | str | Country of event. |
| category | str | Category of event. |
| event | str | Event name. |
| importance | str | The importance level for the event. |
| source | str | Source of the data. |
| currency | str | Currency of the data. |
| unit | str | Unit of the data. |
| consensus | Union[float, str] | Average forecast among a representative group of economists. |
| previous | Union[float, str] | Value for the previous period after the revision (if revision is applicable). |
| revised | Union[float, str] | Revised previous value, if applicable. |
| actual | Union[float, str] | Latest released value. |
| Name | Type | Description |
|---|---|---|
| date | datetime | The date of the data. |
| country | str | Country of event. |
| category | str | Category of event. |
| event | str | Event name. |
| importance | str | The importance level for the event. |
| source | str | Source of the data. |
| currency | str | Currency of the data. |
| unit | str | Unit of the data. |
| consensus | Union[float, str] | Average forecast among a representative group of economists. |
| previous | Union[float, str] | Value for the previous period after the revision (if revision is applicable). |
| revised | Union[float, str] | Revised previous value, if applicable. |
| actual | Union[float, str] | Latest released value. |
| change | float | Value change since previous. |
| change_percent | float | Percentage change since previous. |
| last_updated | datetime | Last updated timestamp. |
| created_at | datetime | Created at timestamp. |
| Name | Type | Description |
|---|---|---|
| date | datetime | The date of the data. |
| country | str | Country of event. |
| category | str | Category of event. |
| event | str | Event name. |
| importance | str | The importance level for the event. |
| source | str | Source of the data. |
| currency | str | Currency of the data. |
| unit | str | Unit of the data. |
| consensus | Union[float, str] | Average forecast among a representative group of economists. |
| previous | Union[float, str] | Value for the previous period after the revision (if revision is applicable). |
| revised | Union[float, str] | Revised previous value, if applicable. |
| actual | Union[float, str] | Latest released value. |
| description | str | Event description. |
| Name | Type | Description |
|---|---|---|
| date | datetime | The date of the data. |
| country | str | Country of event. |
| category | str | Category of event. |
| event | str | Event name. |
| importance | str | The importance level for the event. |
| source | str | Source of the data. |
| currency | str | Currency of the data. |
| unit | str | Unit of the data. |
| consensus | Union[float, str] | Average forecast among a representative group of economists. |
| previous | Union[float, str] | Value for the previous period after the revision (if revision is applicable). |
| revised | Union[float, str] | Revised previous value, if applicable. |
| actual | Union[float, str] | Latest released value. |
| forecast | Union[str, float] | TradingEconomics projections. |
| reference | str | Abbreviated period for which released data refers to. |
| reference_date | date | Date for the reference period. |
| calendar_id | int | TradingEconomics Calendar ID. |
| date_span | int | Date span of the event. |
| symbol | str | TradingEconomics Symbol. |
| ticker | str | TradingEconomics Ticker symbol. |
| te_url | str | TradingEconomics URL path. |
| source_url | str | Source URL. |
| last_updated | datetime | Last update of the data. |