Skip to main content

US Yield Curve


Implementation details​

Class names​

Model nameParameters classData class
USYieldCurveUSYieldCurveQueryParamsUSYieldCurveData

Import Statement​

from openbb_core.provider.standard_models.us_yield_curve import (
USYieldCurveData,
USYieldCurveQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
dateUnion[str, date]A specific date to get data for. Defaults to the most recent FRED entry.NoneTrue
inflation_adjustedboolGet inflation adjusted rates.FalseTrue
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
maturityfloatMaturity of the treasury rate in years.
ratefloatAssociated rate given in decimal form (0.05 is 5%)