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: Union[str, list[str]]

The country to get data. Multiple items allowed for provider(s): oecd.

• Default: united_states

• Optional: True

---

frequency: Literal['monthly', 'quarter', 'annual']

The frequency of the data.

• Default: quarter

• Optional: True

---

transform: Literal['index', 'yoy', 'period']

Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).

• Default: index

• Optional: True

---

start_date: Union[date, str]

Start date of the data, in YYYY-MM-DD format.

• Optional: True

---

end_date: Union[date, str]

End date of the data, in YYYY-MM-DD format.

• Optional: True

country: str

The country to get data.

• Default: united_states

• Optional: True

---

frequency: Literal['monthly', 'quarter', 'annual']

The frequency of the data.

• Default: quarter

• Optional: True

---

transform: Literal['index', 'yoy', 'period']

Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).

• Default: index

• Optional: True

---

start_date: Union[date, str]

Start date of the data, in YYYY-MM-DD format.

• Optional: True

---

end_date: Union[date, str]

End date of the data, in YYYY-MM-DD format.

• Optional: True

Data

• standard
• oecd

date: Union[date, str]

The date of the data.

country: str

value: float

Share price index value.

date: Union[date, str]

The date of the data.

country: str

value: float

Share price index value.