Skip to main content

us_yield_curve

Deprecated

This endpoint will be removed in a future version. Use, /fixedincome/government/yield_curve, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.

US Yield Curve. Get United States yield curve.

Examples

from openbb import obb
obb.fixedincome.government.us_yield_curve(provider='fred')
obb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')

Parameters

NameTypeDescriptionDefaultOptional
dateUnion[date, str]A specific date to get data for. Defaults to the most recent FRED entry.NoneTrue
inflation_adjustedboolGet inflation adjusted rates.FalseTrue

Returns

OBBject
results : List[USYieldCurve]
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

NameTypeDescription
maturityfloatMaturity of the treasury rate in years.
ratefloatAssociated rate given in decimal form (0.05 is 5%)