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
Name | Type | Description | Default | Optional |
---|---|---|---|---|
; |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
use_cache | bool | Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. | True | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
; |
Data
- standard
- econdb
- imf
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |
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 | int | Order of the data, relative to the table. |