Oecd Consumer Price Index
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
OecdConsumerPriceIndex | OecdConsumerPriceIndexQueryParams | OecdConsumerPriceIndexData |
Import Statement
from openbb_core.provider.standard_models. import (
OecdConsumerPriceIndexData,
OecdConsumerPriceIndexQueryParams,
)
Parameters
- standard
- oecd
country: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
- argentina
- australia
- austria
- belgium
- brazil
- bulgaria
- canada
- chile
- china
- colombia
- costa_rica
- croatia
- czechia
- denmark
- estonia
- eu27
- euro_area_20_countries
- finland
- france
- g20
- g7
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd
- oecd_europe
- poland
- portugal
- romania
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkiye
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: str | None
Default: monthly
The frequency of the data.
Choices
- annual
- quarter
- monthly
harmonized: bool | None
Default: False
If true, returns harmonized 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.
country: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
- argentina
- australia
- austria
- belgium
- brazil
- bulgaria
- canada
- chile
- china
- colombia
- costa_rica
- croatia
- czechia
- denmark
- estonia
- eu27
- euro_area_20_countries
- finland
- france
- g20
- g7
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd
- oecd_europe
- poland
- portugal
- romania
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkiye
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: str | None
Default: monthly
The frequency of the data.
Choices
- annual
- quarter
- monthly
harmonized: bool | None
Default: False
If true, returns harmonized 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.
expenditure: str | None | list[str | None]
Default: total
Expenditure component of CPI. Multiple items allowed.
Choices
- actual_rentals
- alcoholic_beverages_tobacco_narcotics
- all_non_food_non_energy
- clothing_footwear
- communication
- education
- electricity_gas_other_fuels
- energy
- food_non_alcoholic_beverages
- fuels_lubricants_personal
- furniture_household_equipment
- goods
- health
- housing
- housing_excluding_rentals
- housing_water_electricity_gas
- imputed_rentals
- maintenance_repair_dwelling
- miscellaneous_goods_services
- overall_excl_energy_food_alcohol_tobacco
- recreation_culture
- residuals
- restaurants_hotels
- services
- services_less_house_excl_rentals
- services_less_housing
- total
- transport
- water_supply_other_services
- all
Data
- standard
- oecd
date: date | str
The date of the data.
country: str
None
value: float
CPI index value or period change.
date: date | str
The date of the data.
country: str
None
value: float
CPI index value or period change.
unit: str
Unit of measurement.
unit_multiplier: float | int
Unit multiplier for the observation value.
country_code: str
ISO3 country code.
series_id: str
OECD series identifier.
expenditure: str
Expenditure component of CPI.
title: str
Complete reference title for the series.
order: int | None
Sort order for expenditure categories.