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
country: Union[str, list[str]]
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
belgiumbulgariabrazilirelandmexicoindonesianew_zealandjapanunited_kingdomfrancechilecanadanetherlandsunited_statessouth_koreanorwayaustriasouth_africadenmarkswitzerlandhungaryluxembourgaustraliagermanyswedenicelandturkeygreeceisraelczech_republiclatviasloveniapolandestonialithuaniaportugalcosta_ricaslovakiafinlandspainromaniarussiaeuro_area19colombiaitalyindiachinacroatiaall
• Default: united_states
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
country: Union[str, list[str]]
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
belgiumbulgariabrazilirelandmexicoindonesianew_zealandjapanunited_kingdomfrancechilecanadanetherlandsunited_statessouth_koreanorwayaustriasouth_africadenmarkswitzerlandhungaryluxembourgaustraliagermanyswedenicelandturkeygreeceisraelczech_republiclatviasloveniapolandestonialithuaniaportugalcosta_ricaslovakiafinlandspainromaniarussiaeuro_area19colombiaitalyindiachinacroatiaall
• Default: united_states
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: 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.
• Default: short
• Optional: True
frequency: Literal['monthly', 'quarter', 'annual']
Frequency to get interest rate for for.
• Default: monthly
• Optional: True
Data
- standard
- oecd
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.
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.