Country Interest Rates
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
CountryInterestRates | CountryInterestRatesQueryParams | CountryInterestRatesData |
Import Statement
from openbb_core.provider.standard_models.country_interest_rates import (
CountryInterestRatesData,
CountryInterestRatesQueryParams,
)
Parameters
- standard
- oecd
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): oecd. | united_states | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): oecd. | united_states | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
duration | Literal['immediate', 'short', 'long'] | Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate. | short | True |
frequency | Literal['monthly', 'quarter', 'annual'] | Frequency to get interest rate for for. | monthly | True |
Data
- standard
- oecd
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
value | float | The interest rate value. |
country | str | Country for which the interest rate is given. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
value | float | The interest rate value. |
country | str | Country for which the interest rate is given. |