US Yield Curve
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
USYieldCurve | USYieldCurveQueryParams | USYieldCurveData |
Import Statement
from openbb_core.provider.standard_models.us_yield_curve import (
USYieldCurveData,
USYieldCurveQueryParams,
)
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 |
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%) |