Skip to main content

mortgage_indices

Mortgage Indices.

Examples

from openbb import obb
# The default state for FRED are the primary mortgage indices from Optimal Blue.
obb.fixedincome.mortgage_indices(provider='fred')
# Multiple indices can be requested.
obb.fixedincome.mortgage_indices(index=jumbo_30y,conforming_30y,conforming_15y, provider='fred')

Parameters

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


Returns

results: list[MortgageIndices]

Serializable results.


provider: Optional[Literal['fred']]

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data

date: Union[date, str]

The date of the data.

symbol: str

Symbol representing the entity requested in the data.

name: str

Name of the index.

rate: float

Mortgage rate.