refactored RiskPremium for economy.risk

This commit is contained in:
Pratyush Shukla
2023-08-02 01:51:36 +05:30
parent 60f9033909
commit 4bbb18ebf1
2 changed files with 20 additions and 17 deletions

View File

@@ -13,13 +13,18 @@ class FMPRiskPremiumQueryParams(RiskPremiumQueryParams):
"""FMP Risk Premium query.
Source: https://site.financialmodelingprep.com/developer/docs/market-risk-premium-api/
"""
class FMPRiskPremiumData(RiskPremiumData):
"""FMP Risk Premium data."""
class Config:
fields = {
"total_equity_risk_premium": "totalEquityRiskPremium",
"country_risk_premium": "countryRiskPremium",
}
class FMPRiskPremiumFetcher(
Fetcher[
@@ -38,7 +43,9 @@ class FMPRiskPremiumFetcher(
query: FMPRiskPremiumQueryParams, credentials: Optional[Dict[str, str]]
) -> List[FMPRiskPremiumData]:
api_key = credentials.get("fmp_api_key") if credentials else ""
url = create_url(4, "market_risk_premium", api_key)
return get_data_many(url, FMPRiskPremiumData)
@staticmethod

View File

@@ -3,28 +3,24 @@
from typing import Optional
from pydantic import Field, NonNegativeFloat, PositiveFloat
from openbb_provider.abstract.data import Data
from openbb_provider.abstract.query_params import QueryParams
from pydantic import Field, NonNegativeFloat, PositiveFloat
class RiskPremiumQueryParams(QueryParams):
"""Risk Premium query."""
"""Risk Premium Query."""
class RiskPremiumData(Data):
"""Risk Premium data.
"""Risk Premium Data."""
Returns
-------
country : str
continent : str
totalEquityRiskPremium : PositiveFloat
countryRiskPremium : PositiveFloat
"""
country: str
continent: Optional[str]
totalEquityRiskPremium: PositiveFloat = Field(alias="total_equity_risk_premium")
countryRiskPremium: NonNegativeFloat = Field(alias="country_risk_premium")
country: str = Field(description="Market country.")
continent: Optional[str] = Field(description="Continent of the country.")
total_equity_risk_premium: PositiveFloat = Field(
description="The total equity risk premium for the country."
)
country_risk_premium: NonNegativeFloat = Field(
description="The country-specific risk premium."
)