STIR

Implementation details

Model name	Parameters class	Data class
`STIR`	`STIRQueryParams`	`STIRData`

from openbb_core.provider.standard_models.short_term_interest_rate import (
STIRData,
STIRQueryParams,
)

Name	Type	Description	Default	Optional
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 for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.	oecd	True

Name	Type	Description	Default	Optional
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 for the query, by default None. If None, the provider specified in defaults is selected or 'oecd' if there is no default.	oecd	True
country	Literal['belgium', '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', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']	Country to get GDP for.	united_states	True
frequency	Literal['monthly', 'quarterly', 'annual']	Frequency to get interest rate for for.	monthly	True

Name	Type	Description
date	date	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