available_indicators
Get the available economic indicators for a provider.
Parameters
- standard
- econdb
- imf
use_cache: bool | None
Default: True
Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.
query: 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.
dataflows: str | list[str] | None
list of IMF dataflow IDs to filter the indicators. Use semicolons to separate multiple dataflow IDs.
keywords: str | list[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).
symbol: str | None
Dummy field to allow grouping by symbol.
Returns
results: AvailableIndicators
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
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.
currency: str | None
The currency, or unit, the data is based in.
scale: str | None
The scale of the data.
multiplier: int | None
The multiplier of the data to arrive at whole units.
transformation: str
Transformation type.
source: str | None
The original source of the data.
first_date: date | None
The first date of the data.
last_date: date | None
The last date of the data.
last_insert_timestamp: datetime | None
The time of the last update. Data is typically reported with a lag.
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.