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
- standard
- fred
Name | Type | Description | Default | Optional |
---|---|---|---|---|
date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True |
inflation_adjusted | bool | Get inflation adjusted rates. | False | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
date | Union[date, str] | A specific date to get data for. Defaults to the most recent FRED entry. | None | True |
inflation_adjusted | bool | Get inflation adjusted rates. | False | True |
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
- standard
- fred
Name | Type | Description |
---|---|---|
maturity | float | Maturity of the treasury rate in years. |
rate | float | Associated rate given in decimal form (0.05 is 5%) |
Name | Type | Description |
---|---|---|
maturity | float | Maturity of the treasury rate in years. |
rate | float | Associated rate given in decimal form (0.05 is 5%) |