Economic Indicators
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EconomicIndicators | EconomicIndicatorsQueryParams | EconomicIndicatorsData |
Import Statement
from openbb_core.provider.standard_models.economic_indicators import (
EconomicIndicatorsData,
EconomicIndicatorsQueryParams,
)
Parameters
- standard
- econdb
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb. | False | |
| country | Union[str, List[str]] | The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb. | None | True |
| 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['econdb'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb. | False | |
| country | Union[str, List[str]] | The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb. | None | True |
| 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['econdb'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. | None | True |
| transform | Literal['toya', 'tpop', 'tusd', 'tpgp'] | The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. tusd should only be used where values are currencies. | None | True |
| frequency | Literal['annual', 'quarter', 'month'] | The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. | quarter | True |
| use_cache | bool | If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. | True | True |
Data
- standard
- econdb
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| symbol_root | str | The root symbol for the indicator (e.g. GDP). |
| symbol | str | Symbol representing the entity requested in the data. |
| country | str | The country represented by the data. |
| value | Union[float, int] |
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| symbol_root | str | The root symbol for the indicator (e.g. GDP). |
| symbol | str | Symbol representing the entity requested in the data. |
| country | str | The country represented by the data. |
| value | Union[float, int] |