house_price_index
Get the House Price Index by country from the OECD.
Examples
from openbb import obb
obb.oecd.house_price_index(provider='oecd')
obb.oecd.house_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')
Parameters
- standard
- oecd
country: str | None | list[str | None]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
frequency: str | None
Default: quarter
The frequency of the data.
Choices
- monthly
- quarter
- annual
transform: str | None
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).
Choices
- index
- yoy
- period
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
Default: united_states
The country to get data.
frequency: str | None
Default: quarter
The frequency of the data.
Choices
- monthly
- quarter
- annual
transform: str | None
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).
Choices
- index
- yoy
- period
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.
Returns
results: OecdHousePriceIndex
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.
country: str | None
value: float | None
Share price index value.
date: date | None | str
The date of the data.
country: str | None
value: float | None
Share price index value.