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[date, str]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[date, str]End date of the data, in YYYY-MM-DD format.NoneTrue
maturityUnion[Union[float, str], List[Union[float, str]]]Maturities in years. Multiple items allowed for provider(s): fred.10.0True
categoryUnion[str, List[str]]Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.spot_rateTrue
providerLiteral['fred']The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred.NoneTrue

Data​

NameTypeDescription
datedateThe date of the data.
ratefloatSpot Rate.