short_term_interest_rate
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 Short-term interest rates.
They are the rates at which short-term borrowings are effected between financial institutions or the rate at which short-term government paper is issued or traded in the market.
Short-term interest rates are generally averages of daily rates, measured as a percentage. Short-term interest rates are based on three-month money market rates where available. Typical standardised names are "money market rate" and "treasury bill rate".
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
Returns
results: list[STIR]
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: 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