interest_rates
Get interest rates by country(s) and duration. Most OECD countries publish short-term, a long-term, and immediate rates monthly.
Examples
from openbb import obb
obb.economy.interest_rates(provider='oecd')
# For OECD, duration can be 'immediate', 'short', or 'long'. Default is 'short', which is the 3-month rate. Overnight interbank rate is 'immediate', and 10-year rate is 'long'.
obb.economy.interest_rates(provider='oecd', country='all', duration=immediate, frequency=quarter)
# Multiple countries can be passed in as a list.
obb.economy.interest_rates(duration=long, country='united_kingdom,germany', frequency=monthly, provider='oecd')
Parameters
- standard
- oecd
country: str | list[str]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
- belgium
- bulgaria
- brazil
- ireland
- mexico
- indonesia
- new_zealand
- japan
- united_kingdom
- france
- chile
- canada
- netherlands
- united_states
- south_korea
- norway
- austria
- south_africa
- denmark
- switzerland
- hungary
- luxembourg
- australia
- germany
- sweden
- iceland
- turkey
- greece
- israel
- czech_republic
- latvia
- slovenia
- poland
- estonia
- lithuania
- portugal
- costa_rica
- slovakia
- finland
- spain
- romania
- russia
- euro_area19
- colombia
- italy
- india
- china
- croatia
- all
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
country: str | list[str]
Default: united_states
The country to get data. Multiple items allowed for provider(s): oecd.
Choices
- belgium
- bulgaria
- brazil
- ireland
- mexico
- indonesia
- new_zealand
- japan
- united_kingdom
- france
- chile
- canada
- netherlands
- united_states
- south_korea
- norway
- austria
- south_africa
- denmark
- switzerland
- hungary
- luxembourg
- australia
- germany
- sweden
- iceland
- turkey
- greece
- israel
- czech_republic
- latvia
- slovenia
- poland
- estonia
- lithuania
- portugal
- costa_rica
- slovakia
- finland
- spain
- romania
- russia
- euro_area19
- colombia
- italy
- india
- china
- croatia
- all
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
duration: Literal['immediate', 'short', 'long']
Default: short
Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate.
frequency: Literal['monthly', 'quarter', 'annual']
Default: monthly
Frequency to get interest rate for for.
Returns
results: list[CountryInterestRates]
Serializable results.
provider: Optional[Literal['oecd']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- oecd
date: date | str
The date of the data.
value: float
The interest rate value.
country: str
Country for which the interest rate is given.
date: date | str
The date of the data.
value: float
The interest rate value.
country: str
Country for which the interest rate is given.