immediate_interest_rate
Deprecated
This endpoint will be removed in a future version. Use, /economy/interest_rates
, instead. Deprecated in OpenBB Platform V4.3 to be removed in V4.5.
Get immediate interest rates by country.
Examples
from openbb import obb
obb.economy.immediate_interest_rate(provider='oecd')
# Multiple countries can be passed in as a list.
obb.economy.immediate_interest_rate(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 | str | The country to get data. | 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 |
frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
Returns
OBBject
results : List[ImmediateInterestRate]
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. |
country | str | Country for which interest rate is given |
value | float | Immediate interest rates, call money, interbank rate. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
country | str | Country for which interest rate is given |
value | float | Immediate interest rates, call money, interbank rate. |