Skip to main content
Version: v5

Fred Bond Indices


Implementation details​

Class names​

Model nameParameters classData class
FredBondIndicesFredBondIndicesQueryParamsFredBondIndicesData

Import Statement​

from openbb_core.provider.standard_models. import (
FredBondIndicesData,
FredBondIndicesQueryParams,
)

Parameters​

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.

index_type: str | None
Default: yield
The type of series. OAS is the option-adjusted spread. Default is yield.

Choices
  • yield
  • yield_to_worst
  • total_return
  • oas

Data​

date: date | str
The date of the data.