Consumer Price Index
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ConsumerPriceIndex | ConsumerPriceIndexQueryParams | ConsumerPriceIndexData |
Import Statement
from openbb_core.provider.standard_models.consumer_price_index import (
ConsumerPriceIndexData,
ConsumerPriceIndexQueryParams,
)
Parameters
- standard
- fred
- imf
- oecd
country: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): fred, imf, oecd.
Choices
- G20
- G7
- argentina
- australia
- austria
- belgium
- brazil
- canada
- chile
- china
- colombia
- costa_rica
- czech_republic
- denmark
- estonia
- euro_area_20
- europe
- european_union_27
- finland
- france
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd_total
- poland
- portugal
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkey
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: Literal['annual', 'quarter', 'monthly'] | None
Default: monthly
The frequency of the data.
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): fred, imf, oecd.
Choices
- G20
- G7
- argentina
- australia
- austria
- belgium
- brazil
- canada
- chile
- china
- colombia
- costa_rica
- czech_republic
- denmark
- estonia
- euro_area_20
- europe
- european_union_27
- finland
- france
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd_total
- poland
- portugal
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkey
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: Literal['annual', 'quarter', 'monthly'] | None
Default: monthly
The frequency of the data.
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): fred, imf, oecd.
Choices
- G20
- G7
- argentina
- australia
- austria
- belgium
- brazil
- canada
- chile
- china
- colombia
- costa_rica
- czech_republic
- denmark
- estonia
- euro_area_20
- europe
- european_union_27
- finland
- france
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd_total
- poland
- portugal
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkey
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: Literal['annual', 'quarter', 'monthly'] | None
Default: monthly
The frequency of the data.
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
Default: total
Expenditure component of CPI.
limit: int | None
Maximum number of records to retrieve per series and country. If None, retrieves all available records.
country: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): fred, imf, oecd.
Choices
- G20
- G7
- argentina
- australia
- austria
- belgium
- brazil
- canada
- chile
- china
- colombia
- costa_rica
- czech_republic
- denmark
- estonia
- euro_area_20
- europe
- european_union_27
- finland
- france
- germany
- greece
- hungary
- iceland
- india
- indonesia
- ireland
- israel
- italy
- japan
- korea
- latvia
- lithuania
- luxembourg
- mexico
- netherlands
- new_zealand
- norway
- oecd_total
- poland
- portugal
- russia
- saudi_arabia
- slovak_republic
- slovenia
- south_africa
- spain
- sweden
- switzerland
- turkey
- united_kingdom
- united_states
- all
transform: str | None
Default: yoy
Transformation of the CPI data.
Choices
- index
- yoy
- period
frequency: Literal['annual', 'quarter', 'monthly'] | None
Default: monthly
The frequency of the data.
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
Default: total
Expenditure component of CPI.
Data
- standard
- fred
- imf
- 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.
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: int | float
Unit multiplier for the observation value.
country_code: str
ISO3 country code.
series_id: str
IMF series identifier.
expenditure: str
Expenditure category.
title: str
Complete reference title for the series.
order: int | None
Sort order for expenditure categories and table presentations.
date: date | str
The date of the data.
country: str
None
value: float
CPI index value or period change.
expenditure: str
Expenditure component of CPI.