indicators
Get economic indicators by country and indicator symbol from the OECD.
Examples
from openbb import obb
# Fetch a single indicator series by ``dataflow::code`` symbol.
obb.oecd.indicators(provider='oecd', symbol='DF_KEI::ULC', country='united_states', start_date='2020-01-01')
Parameters
- standard
- oecd
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): oecd.
country: str | None | list[str | None]
The country to get data. Multiple items allowed for provider(s): oecd.
frequency: str | None
The frequency of the data.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
symbol: str
OECD indicator symbol(s). Format: 'DATAFLOW::INDICATOR' or 'DATAFLOW::TABLE_ID'. Multiple symbols from the same dataflow can be comma-separated.
country: str | None
Country name or ISO code. Comma-separated for multiples. 'all' for all.
frequency: str | None
Frequency: 'annual'/'yearly', 'quarterly'/'quarter', 'monthly'/'month', or SDMX code (A/Q/M).
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
transform: str | None
Transformation code (dataflow-specific, e.g. 'GY' for growth rate).
dimension_values: list[str] | str | None | list[list[str] | str | None]
Additional dimension constraints. Format: 'DIM_ID:VALUE'. e.g. ['SECTOR:S1', 'UNIT_MEASURE:USD_PPP'] Multiple items allowed.
limit: int | None
Maximum number of most recent observations per series.
pivot: bool | None
Default: False
If True, pivot dates to columns for presentation-table output.
Returns
results: OecdIndicators
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
- oecd
date: date | None | str
The date of the data.
symbol_root: str | None
The root symbol for the indicator (e.g. GDP).
symbol: str | None
Symbol representing the entity requested in the data.
country: str | None
The country represented by the data.
value: float | int | None
date: date | None | str
The date of the data.
symbol_root: str | None
The root symbol for the indicator (e.g. GDP).
symbol: str | None
Symbol representing the entity requested in the data.
country: str | None
The country represented by the data.
value: float | int | None
unit: str | None
Unit of measurement.
unit_multiplier: float | int | None
Unit multiplier (power of 10).
scale: str | None
Scale description (e.g. Thousands, Millions).
order: float | int | None
Sort order within the table hierarchy.
level: int | None
Indentation level in the table hierarchy.
title: str | None
Human-readable title of the series.
description: str | None
Indicator description.
country_code: str | None
ISO country code.