house_price_index
Get the House Price Index by country from the OECD Short-Term Economics Statistics.
Examples
from openbb import obb
obb.economy.house_price_index(provider='oecd')
# Multiple countries can be passed in as a list.
obb.economy.house_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')
Parameters
- standard
- oecd
country: str | list[str]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
frequency: Literal['monthly', 'quarter', 'annual']
Default: quarter
The frequency of the data.
transform: Literal['index', 'yoy', 'period']
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
country: str
Default: united_states
The country to get data.
frequency: Literal['monthly', 'quarter', 'annual']
Default: quarter
The frequency of the data.
transform: Literal['index', 'yoy', 'period']
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
Returns
results: list[HousePriceIndex]
Serializable results.
provider: Optional[Literal['oecd']]
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 | str
The date of the data.
country: str
value: float
Share price index value.
date: date | str
The date of the data.
country: str
value: float
Share price index value.