Skip to main content

bond_indices

Bond Indices.

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


index_type: Literal['yield', 'yield_to_worst', 'total_return', 'oas']

The type of series. OAS is the option-adjusted spread. Default is yield.

Default: yield

Optional: True


Returns

results: list[BondIndices]

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.

value: float

Index values.