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

Name	Type	Description	Default	Optional
country	Union[str, List[str]]	The country to get data. Multiple items allowed for provider(s): oecd.	united_states	True
frequency	Literal['monthly', 'quarter', 'annual']	The frequency of the data.	quarter	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).	index	True
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True

Name	Type	Description	Default	Optional
country	str	The country to get data.	united_states	True
frequency	Literal['monthly', 'quarter', 'annual']	The frequency of the data.	quarter	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).	index	True
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True

---

Returns

OBBject
    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

Name	Type	Description
date	Union[date, str]	The date of the data.
country	str
value	float	Share price index value.

Name	Type	Description
date	Union[date, str]	The date of the data.
country	str
value	float	Share price index value.