Risk Premium
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
RiskPremium | RiskPremiumQueryParams | RiskPremiumData |
Import Statement
from openbb_core.provider.standard_models.risk_premium import (
RiskPremiumData,
RiskPremiumQueryParams,
)
Parameters
- standard
- fmp
Name | Type | Description | Default | Optional |
---|---|---|---|---|
provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Data
- standard
- fmp
Name | Type | Description |
---|---|---|
country | str | Market country. |
continent | str | Continent of the country. |
total_equity_risk_premium | Annotated[float, Gt(gt=0)] | Total equity risk premium for the country. |
country_risk_premium | Annotated[float, Ge(ge=0)] | Country-specific risk premium. |
Name | Type | Description |
---|---|---|
country | str | Market country. |
continent | str | Continent of the country. |
total_equity_risk_premium | Annotated[float, Gt(gt=0)] | Total equity risk premium for the country. |
country_risk_premium | Annotated[float, Ge(ge=0)] | Country-specific risk premium. |