indicators
Get economic indicators by country and indicator.
Examples
from openbb import obb
obb.economy.indicators(provider='econdb', symbol=PCOCO)
# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.
obb.economy.indicators(symbol=CPI, country='united_states,jp', provider='econdb')
# Use the `main` symbol to get the group of main indicators for a country.
obb.economy.indicators(provider='econdb', symbol=main, country='eu')
# When the provider is 'imf', the absence of a symbol will default to 'irfcl_top_lines'. Use 'IRFCL' to get all the data from the set of indicators.
obb.economy.indicators(provider='imf')
# When the provider is 'imf', complete tables are returned by using a 'preset'. Refer to the function's docstring for descriptions of each preset. When no country is supplied, the data is returned for all countries.
obb.economy.indicators(provider='imf', symbol=gold_reserves)
# When the provider is 'imf', multiple countries and symbols can be supplied. Enter countries as a two-letter ISO country code, or the country name in lower_snake_case.
obb.economy.indicators(provider='imf', symbol=RAFA_USD,RAPFA_USD,RAFA_RAPFA_RO, country='us,china,jp,4f,gb', start_date='2010-01-01', end_date='2020-12-31', frequency=annual)
# When the provider is 'imf', additional presets return the core Financial Soundness Indicators.
'fsi_core' - Core FSIs
'fsi_encouraged_set' - Encouraged Set of FSIs,
'fsi_core_underlying' - Underlying data for the Core FSIs.
'fsi_other' - Additional/Other FSIs that are not in the Core or Encouraged Set.
'fsi_all' - all FSI data for a single country.
obb.economy.indicators(provider='imf', symbol=fsi_encouraged_set, country='us,fr,gb', start_date='2022-01-01', end_date='2023-12-31', frequency=annual)
Parameters
- standard
- econdb
- imf
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, imf.
Choices
allafghanistanalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaargentinaarmeniaarubaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilehong_kongmacaochinacolombiacomorosdemocratic_republic_of_the_congocongocosta_ricaivory_coastcroatiacubacuracaocyprusczech_republicdenmarkdjiboutidominicadominican_republicecuadoregyptel_salvadorequatorial_guineaeritreaestoniaeswatiniethiopiafalkland_islandsfaroe_islandsfijifinlandfrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitivatican_city_statehondurashungaryicelandindiaindonesiairaniraqirelandisraelitalyjamaicajapanjordankazakhstankenyakiribatinorth_koreasouth_koreakosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalantillesnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_macedonianorwayomanpakistanpalaupanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbia_and_montenegroserbiaseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_sudanspainsri_lankasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvenezuelaviet_nampalestineyemenzambiazimbabweeuro_areaeuropeeuropean_unionunspecified
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
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, imf.
Choices
allafghanistanalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaargentinaarmeniaarubaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilehong_kongmacaochinacolombiacomorosdemocratic_republic_of_the_congocongocosta_ricaivory_coastcroatiacubacuracaocyprusczech_republicdenmarkdjiboutidominicadominican_republicecuadoregyptel_salvadorequatorial_guineaeritreaestoniaeswatiniethiopiafalkland_islandsfaroe_islandsfijifinlandfrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitivatican_city_statehondurashungaryicelandindiaindonesiairaniraqirelandisraelitalyjamaicajapanjordankazakhstankenyakiribatinorth_koreasouth_koreakosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalantillesnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_macedonianorwayomanpakistanpalaupanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbia_and_montenegroserbiaseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_sudanspainsri_lankasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvenezuelaviet_nampalestineyemenzambiazimbabweeuro_areaeuropeeuropean_unionunspecified
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Use available_indicators() to get a list of available symbols. Multiple items allowed for provider(s): econdb.
• Optional: False
transform: Literal['toya', 'tpop', 'tusd', 'tpgp']
Description
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.
• Optional: True
frequency: Literal['annual', 'quarter', 'month']
The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.
• Default: quarter
• Optional: 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.
• Default: True
• Optional: True
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, imf.
Choices
allafghanistanalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaargentinaarmeniaarubaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilehong_kongmacaochinacolombiacomorosdemocratic_republic_of_the_congocongocosta_ricaivory_coastcroatiacubacuracaocyprusczech_republicdenmarkdjiboutidominicadominican_republicecuadoregyptel_salvadorequatorial_guineaeritreaestoniaeswatiniethiopiafalkland_islandsfaroe_islandsfijifinlandfrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitivatican_city_statehondurashungaryicelandindiaindonesiairaniraqirelandisraelitalyjamaicajapanjordankazakhstankenyakiribatinorth_koreasouth_koreakosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalantillesnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_macedonianorwayomanpakistanpalaupanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbia_and_montenegroserbiaseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_sudanspainsri_lankasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvenezuelaviet_nampalestineyemenzambiazimbabweeuro_areaeuropeeuropean_unionunspecified
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol: Union[str, list[str]]
Description
Symbol to get data for. Use available_indicators() to get the list of available symbols. Use 'IRFCL' to get all the data from International Reserves & Foreign Currency Liquidity indicators. Use 'core_fsi' to get the core Financial Soundness Indicators. Use 'core_fsi_underlying' to include underlying data for the core Financial Soundness Indicators. Complete tables are available only by single country, and are keyed as described below. The default is 'irfcl_top_lines'. Available presets not listed in available_indicators() are:
'IRFCL': All the data from the set of indicators. Not compatible with multiple countries.
'irfcl_top_lines': The default, top line items from the IRFCL data. Compatible with multiple countries.
'reserve_assets_and_other_fx_assets': Table I of the IRFCL data. Not compatible with multiple countries.
'predetermined_drains_on_fx_assets': Table II of the IRFCL data. Not compatible with multiple countries.
'contingent_drains_fx_assets': Table III of the IRFCL data. Not compatible with multiple countries.
'memorandum_items': The memorandum items table of the IRFCL data. Not compatible with multiple countries.
'gold_reserves': Gold reserves as value in USD and Fine Troy Ounces. Compatible with multiple countries.
'derivative_assets': Net derivative assets as value in USD. Compatible with multipile countries.
'fsi_core': The core Financial Soundness Indicators. Compatible with multiple countries.
'fsi_core_underlying': The core FSIs underlying series data. Not compatible with country='all'.
'fsi_encouraged_set': The encouraged set of Financial Soundness Indicators. Not compatible with country='all'.
'fsi_other': The other Financial Soundness Indicators. Not compatible with country='all'.
'fsi_balance_sheets': Data categorized as Balance Sheets and Income Statements. Not compatible with country='all'.
'fsi_all': All the Financial Soundness Indicators. Not compatible with multiple countries. Multiple items allowed for provider(s): imf.
• Default: irfcl_top_lines
• Optional: True
frequency: Literal['annual', 'quarter', 'month']
Frequency of the data, default is 'quarter'.
• Default: quarter
• Optional: True
Returns
results: list[EconomicIndicators]
Serializable results.
provider: Optional[Literal['econdb', 'imf']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- econdb
- imf
date: Union[date, str]
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]
date: Union[date, str]
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]
date: Union[date, str]
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]
unit: str
The unit of the value.
scale: str
The scale of the value.
table: str
The name of the table associated with the symbol.
level: int
The indentation level of the data, relative to the table and symbol_root
order: Union[float, int]
Order of the data, relative to the table.
reference_sector: str
The reference sector for the data.
title: str
The title of the series associated with the symbol.