available_indicators
Search the IMF SDMX indicator catalog by query, dataflow, or keyword.
Examples
from openbb import obb
# Search the full IMF indicator catalog.
obb.imf.available_indicators(provider='imf')
# Filter the catalog to specific dataflows.
obb.imf.available_indicators(provider='imf', dataflows='CPI,PCPS')
Parameters
- standard
- imf
query: str | None | list[str | None]
The search query string. Multiple search phrases can be separated by semicolons. Each phrase can use AND (+) and OR (|) operators, as well as quoted phrases. Semicolon separation allows commas to be used within search phrases. Multiple items allowed.
dataflows: list[str] | str | None | list[list[str] | str | None]
List of IMF dataflow IDs to filter the indicators. Use semicolons to separate multiple dataflow IDs. Multiple items allowed.
keywords: list[str] | str | None | list[list[str] | str | None]
List of keywords to filter results. Each keyword is a single word that must appear in the indicator's label or description. Keywords prefixed with 'not' will exclude indicators containing that word (e.g., 'not USD' excludes indicators with 'USD' in them). Multiple items allowed.
symbol: str | None | list[str | None]
Dummy field to allow grouping by symbol. Multiple items allowed.
Returns
results: AvailableImfIndicators
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- imf
symbol_root: str | None
The root symbol representing the indicator.
symbol: str | None
Symbol representing the entity requested in the data. The root symbol with additional codes.
country: str | None
The name of the country, region, or entity represented by the symbol.
iso: str | None
The ISO code of the country, region, or entity represented by the symbol.
description: str | None
The description of the indicator.
frequency: str | None
The frequency of the indicator data.
symbol_root: str | None
The root symbol representing the indicator.
symbol: str | None
Symbol representing the entity requested in the data. The root symbol with additional codes.
country: str | None
The name of the country, region, or entity represented by the symbol.
iso: str | None
The ISO code of the country, region, or entity represented by the symbol.
description: str | None
The description of the indicator.
frequency: str | None
The frequency of the indicator data.
agency_id: str
The agency ID responsible for the indicator.
dataflow_id: str
The IMF dataflow ID associated with the indicator.
dataflow_name: str
The name of the IMF dataflow (symbol root).
structure_id: str
The data structure ID associated with the indicator.
dimension_id: str
The dimension ID of the indicator in the data structure.
long_description: str | None
Detailed description of the indicator.
member_of: list[str] | None
List of table symbols (dataflow_id::table_id) this indicator belongs to.
extra_dimensions: list[str] | None
Non-standard dimensions the dataflow exposes beyond country / frequency / indicator / transform. Pass each as DIM_ID:DIM_VALUE in the dimension_values parameter when calling obb.economy.indicators.