diff options
Diffstat (limited to 'openbb_platform/core/openbb_core/provider/standard_models/immediate_interest_rate.py')
-rw-r--r-- | openbb_platform/core/openbb_core/provider/standard_models/immediate_interest_rate.py | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/immediate_interest_rate.py b/openbb_platform/core/openbb_core/provider/standard_models/immediate_interest_rate.py new file mode 100644 index 00000000000..2143fc519bc --- /dev/null +++ b/openbb_platform/core/openbb_core/provider/standard_models/immediate_interest_rate.py @@ -0,0 +1,45 @@ +"""Immediate Interest Rates Standard Model.""" + +from datetime import date as dateType +from typing import Optional + +from pydantic import Field + +from openbb_core.provider.abstract.data import Data +from openbb_core.provider.abstract.query_params import QueryParams +from openbb_core.provider.utils.descriptions import ( + DATA_DESCRIPTIONS, + QUERY_DESCRIPTIONS, +) + + +class ImmediateInterestRateQueryParams(QueryParams): + """Immediate (Call money, interbank rate) Rate Query.""" + + country: str = Field( + description=QUERY_DESCRIPTIONS.get("country", ""), + default="united_states", + ) + start_date: Optional[dateType] = Field( + default=None, description=QUERY_DESCRIPTIONS.get("start_date") + ) + end_date: Optional[dateType] = Field( + default=None, description=QUERY_DESCRIPTIONS.get("end_date") + ) + + +class ImmediateInterestRateData(Data): + """Immediate Interest Rates Data.""" + + date: Optional[dateType] = Field( + default=None, description=DATA_DESCRIPTIONS.get("date") + ) + country: Optional[str] = Field( + default=None, + description="Country for which interest rate is given", + ) + value: Optional[float] = Field( + default=None, + description="Immediate interest rates, call money, interbank rate.", + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, + ) |