STIR
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
STIR | STIRQueryParams | STIRData |
Import Statement
from openbb_core.provider.standard_models.short_term_interest_rate import (
STIRData,
STIRQueryParams,
)
Parameters
- standard
- oecd
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
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: Literal['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']
Country to get interest rate for.
• Default: united_states
• Optional: True
frequency: Literal['monthly', 'quarterly', '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
Interest rate (given as a whole number, i.e 10=10%)
country: str
Country for which interest rate is given
date: Union[date, str]
The date of the data.
value: float
Interest rate (given as a whole number, i.e 10=10%)
country: str
Country for which interest rate is given