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[str, date] | 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 |
| provider | Literal['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. | fred | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| date | Union[str, date] | 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 |
| provider | Literal['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. | fred | 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%) |