Skip to main content

Spot Rate


Implementation details​

Class names​

Model nameParameters classData class
SpotRateSpotRateQueryParamsSpotRateData

Import Statement​

from openbb_core.provider.standard_models.spot import (
SpotRateData,
SpotRateQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
start_dateUnion[str, date]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[str, date]End date of the data, in YYYY-MM-DD format.NoneTrue
maturityList[float]The maturities in years.[10.0]True
categoryList[Literal['par_yield', 'spot_rate']]The category.['spot_rate']True
providerLiteral['fred']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default.fredTrue

Data​

NameTypeDescription
datedateThe date of the data.
ratefloatSpot Rate.