House Price Index

---

Implementation details

Class names

Model name	Parameters class	Data class
HousePriceIndex	HousePriceIndexQueryParams	HousePriceIndexData

Import Statement

from openbb_core.provider.standard_models.house_price_index import (
HousePriceIndexData,
HousePriceIndexQueryParams,
)

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: Literal['monthly', 'quarter', 'annual'] | None
Default: quarter
The frequency of the data.

transform: Literal['index', 'yoy', 'period'] | None
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).

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: Literal['monthly', 'quarter', 'annual'] | None
Default: quarter
The frequency of the data.

transform: Literal['index', 'yoy', 'period'] | None
Default: index
Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).

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.

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.