Immediate Interest Rate
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ImmediateInterestRate | ImmediateInterestRateQueryParams | ImmediateInterestRateData |
Import Statement
from openbb_core.provider.standard_models.immediate_interest_rate import (
ImmediateInterestRateData,
ImmediateInterestRateQueryParams,
)
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 |
| provider | Literal['oecd'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. | 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 |
| provider | Literal['oecd'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. | None | True |
| frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
Data
- standard
- oecd
| Name | Type | Description |
|---|---|---|
| date | date | 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 | date | The date of the data. |
| country | str | Country for which interest rate is given |
| value | float | Immediate interest rates, call money, interbank rate. |