Skip to main content
Version: v5

Oecd House Price Index


Implementation details​

Class names​

Model nameParameters classData class
OecdHousePriceIndexOecdHousePriceIndexQueryParamsOecdHousePriceIndexData

Import Statement​

from openbb_core.provider.standard_models. import (
OecdHousePriceIndexData,
OecdHousePriceIndexQueryParams,
)

Parameters​

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.

Data​

date: date | None | str
The date of the data.

country: str | None
value: float | None
Share price index value.