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
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 |
Returns
OBBject
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
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. |