Available Indicators
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
AvailableIndicators | AvailableIndicatorsQueryParams | AvailableIndicatorsData |
Import Statement
from openbb_core.provider.standard_models.available_indicators import (
AvailableIndicatorsData,
AvailableIndicatorsQueryParams,
)
Parameters
- standard
- econdb
- imf
use_cache: bool
Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.
• Default: True
• Optional: True
query: Union[str, list[str]]
The query string to search through the available indicators. Use semicolons to separate multiple terms. Multiple items allowed for provider(s): imf.
• Optional: True
Data
- standard
- econdb
- imf
symbol_root: str
The root symbol representing the indicator.
symbol: str
Symbol representing the entity requested in the data. The root symbol with additional codes.
country: str
The name of the country, region, or entity represented by the symbol.
iso: str
The ISO code of the country, region, or entity represented by the symbol.
description: str
The description of the indicator.
frequency: str
The frequency of the indicator data.
symbol_root: str
The root symbol representing the indicator.
symbol: str
Symbol representing the entity requested in the data. The root symbol with additional codes.
country: str
The name of the country, region, or entity represented by the symbol.
iso: str
The ISO code of the country, region, or entity represented by the symbol.
description: str
The description of the indicator.
frequency: str
The frequency of the indicator data.
currency: str
The currency, or unit, the data is based in.
scale: str
The scale of the data.
multiplier: int
The multiplier of the data to arrive at whole units.
transformation: str
Transformation type.
source: str
The original source of the data.
first_date: date
The first date of the data.
last_date: date
The last date of the data.
last_insert_timestamp: datetime
The time of the last update. Data is typically reported with a lag.
symbol_root: str
The root symbol representing the indicator.
symbol: str
Symbol representing the entity requested in the data. The root symbol with additional codes.
country: str
The name of the country, region, or entity represented by the symbol.
iso: str
The ISO code of the country, region, or entity represented by the symbol.
description: str
The description of the indicator.
frequency: str
The frequency of the indicator data.
dataset: str
The IMF dataset associated with the symbol.
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.
children: str
The symbol of the child data, if any.
unit: str
The unit of the data.