diff --git a/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py b/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py index 743ec65a746c..93149d1c3776 100644 --- a/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py +++ b/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py @@ -33,65 +33,65 @@ class TreasuryRatesData(Data): week_4: Optional[float] = Field( default=None, description="4 week Treasury bills rate (secondary market).", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_1: Optional[float] = Field( description="1 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_2: Optional[float] = Field( description="2 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_3: Optional[float] = Field( description="3 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_6: Optional[float] = Field( description="6 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_1: Optional[float] = Field( description="1 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_2: Optional[float] = Field( description="2 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_3: Optional[float] = Field( description="3 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_5: Optional[float] = Field( description="5 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_7: Optional[float] = Field( description="7 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_10: Optional[float] = Field( description="10 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_20: Optional[float] = Field( description="20 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_30: Optional[float] = Field( description="30 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py index f5cf40a2a5a8..c4aeba334165 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py @@ -90,19 +90,19 @@ class BenzingaAnalystSearchData(AnalystSearchData): overall_success_rate: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) overall_avg_return_percentile: Optional[float] = Field( default=None, description="The percentile (normalized) of this analyst's overall average" + " return per rating in comparison to other analysts' overall average returns per rating.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_ratings_percentile: Optional[float] = Field( default=None, description="The percentile (normalized) of this analyst's total number of ratings" + " in comparison to the total number of ratings published by all other analysts", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_ratings: Optional[int] = Field( default=None, @@ -119,13 +119,13 @@ class BenzingaAnalystSearchData(AnalystSearchData): overall_average_return: Optional[float] = Field( default=None, description="The average percent (normalized) price difference per rating since the date of recommendation", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) overall_std_dev: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings since the date of recommendation", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="overall_stdev", ) gain_count_1m: Optional[int] = Field( @@ -141,14 +141,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): average_return_1m: Optional[float] = Field( default=None, description="The average percent (normalized) price difference per rating over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_average_return", ) std_dev_1m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_stdev", ) smart_score_1m: Optional[float] = Field( @@ -159,7 +159,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_1m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_success_rate", ) gain_count_3m: Optional[int] = Field( @@ -176,14 +176,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_average_return", ) std_dev_3m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_stdev", ) smart_score_3m: Optional[float] = Field( @@ -194,7 +194,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_3m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_success_rate", ) gain_count_6m: Optional[int] = Field( @@ -211,14 +211,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 6 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="6m_average_return", ) std_dev_6m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 6 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="6m_stdev", ) gain_count_9m: Optional[int] = Field( @@ -235,14 +235,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_average_return", ) std_dev_9m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_stdev", ) smart_score_9m: Optional[float] = Field( @@ -253,7 +253,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_9m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_success_rate", ) gain_count_1y: Optional[int] = Field( @@ -270,14 +270,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_average_return", ) std_dev_1y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_stdev", ) smart_score_1y: Optional[float] = Field( @@ -288,7 +288,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_1y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_success_rate", ) gain_count_2y: Optional[int] = Field( @@ -305,14 +305,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_average_return", ) std_dev_2y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_stdev", ) smart_score_2y: Optional[float] = Field( @@ -323,7 +323,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_2y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_success_rate", ) gain_count_3y: Optional[int] = Field( @@ -340,14 +340,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_average_return", ) std_dev_3y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_stdev", ) smart_score_3y: Optional[float] = Field( @@ -358,7 +358,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_3y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_success_rate", ) diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py b/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py index 4c53fde9cf29..5a1c76c07a1d 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py @@ -79,42 +79,42 @@ class FinvizCompareGroupsData(CompareGroupsData): performance_1D: Optional[float] = Field( default=None, description="The performance in the last day, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1W: Optional[float] = Field( default=None, description="The performance in the last week, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1M: Optional[float] = Field( default=None, description="The performance in the last month, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_3M: Optional[float] = Field( default=None, description="The performance in the last quarter, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_6M: Optional[float] = Field( default=None, description="The performance in the last half year, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1Y: Optional[float] = Field( default=None, description="The performance in the last year, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_YTD: Optional[float] = Field( default=None, description="The performance in the year to date, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) dividend_yield: Optional[float] = Field( default=None, description="The dividend yield of the group, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) pe: Optional[float] = Field( default=None, @@ -132,23 +132,23 @@ class FinvizCompareGroupsData(CompareGroupsData): eps_growth_past_5_years: Optional[float] = Field( default=None, description="The EPS growth of the group for the past 5 years, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) eps_growth_next_5_years: Optional[float] = Field( default=None, description="The estimated EPS growth of the groupo for the next 5 years," + " as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) sales_growth_past_5_years: Optional[float] = Field( default=None, description="The sales growth of the group for the past 5 years, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) float_short: Optional[float] = Field( default=None, description="The percent of the float shorted for the group, as a normalized value.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) analyst_recommendation: Optional[float] = Field( default=None, diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py index f6f29c1791a3..a81fe6c5085e 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py @@ -1,8 +1,9 @@ """Finviz Equity Profile Model.""" # pylint: disable=unused-argument -import warnings + from typing import Any, Dict, List, Optional +from warnings import warn from finvizfinance.quote import finvizfinance from openbb_core.provider.abstract.fetcher import Fetcher @@ -12,8 +13,6 @@ ) from pydantic import Field -_warn = warnings.warn - class FinvizEquityProfileQueryParams(EquityInfoQueryParams): """ @@ -59,7 +58,7 @@ class FinvizEquityProfileData(EquityInfoData): institutional_ownership: Optional[float] = Field( default=None, description="The institutional ownership of the stock, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) market_cap: Optional[str] = Field( default=None, @@ -68,7 +67,7 @@ class FinvizEquityProfileData(EquityInfoData): dividend_yield: Optional[float] = Field( default=None, description="The dividend yield of the stock, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) earnings_date: Optional[str] = Field( default=None, @@ -99,17 +98,17 @@ def extract_data( ) -> List[Dict]: """Extract the raw data from Finviz.""" - results = [] + results: List = [] def get_one(symbol) -> Dict: """Get the data for one symbol.""" - result = {} + result: Dict = {} try: data = finvizfinance(symbol) fundament = data.ticker_fundament() description = data.ticker_description() except Exception as e: # pylint: disable=W0718 - _warn(f"Failed to get data for {symbol} -> {e}") + warn(f"Failed to get data for {symbol} -> {e}") return result div_yield = ( float(str(fundament.get("Dividend %", None)).replace("%", "")) / 100 diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py index ec7096dc6a17..9ff3a002ed33 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py @@ -61,42 +61,42 @@ class FinvizKeyMetricsData(KeyMetricsData): gross_margin: Optional[float] = Field( default=None, description="Gross margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) profit_margin: Optional[float] = Field( default=None, description="Profit margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) operating_margin: Optional[float] = Field( default=None, description="Operating margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_on_assets: Optional[float] = Field( default=None, description="Return on assets (ROA), as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_on_investment: Optional[float] = Field( default=None, description="Return on investment (ROI), as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_on_equity: Optional[float] = Field( default=None, description="Return on equity (ROE), as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) payout_ratio: Optional[float] = Field( default=None, description="Payout ratio, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) dividend_yield: Optional[float] = Field( default=None, description="Dividend yield, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) @@ -118,11 +118,11 @@ def extract_data( ) -> List[Dict]: """Extract the raw data from Finviz.""" - results = [] + results: List = [] def get_one(symbol) -> Dict: """Get the data for one symbol.""" - result = {} + result: Dict = {} try: data = finvizfinance(symbol) fundament = data.ticker_fundament() diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_holdings.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_holdings.py index 6c6566828dee..385a24039262 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_holdings.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_holdings.py @@ -73,7 +73,7 @@ class FMPEtfHoldingsData(EtfHoldingsData): description="The weight of the holding, as a normalized percent.", alias="pctVal", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) payoff_profile: Optional[str] = Field( description="The payoff profile of the holding.", diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py b/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py index 21cfab00a8aa..af21d5e8f27f 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/etf_info.py @@ -43,7 +43,7 @@ class FMPEtfInfoData(EtfInfoData): expense_ratio: Optional[float] = Field( default=None, description="The expense ratio, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) holdings_count: Optional[int] = Field( default=None, description="Number of holdings." @@ -76,7 +76,7 @@ async def aextract_data( """Return the raw data from the FMP endpoint.""" api_key = credentials.get("fmp_api_key") if credentials else "" symbols = query.symbol.split(",") - results = [] + results: List = [] async def get_one(symbol): """Get one symbol.""" diff --git a/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py b/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py index 3f7f7b0ce3f9..7c8241aca9d0 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py +++ b/openbb_platform/providers/fmp/openbb_fmp/models/key_metrics.py @@ -122,7 +122,7 @@ class FMPKeyMetricsData(KeyMetricsData): dividend_yield: Optional[float] = Field( default=None, description="Dividend yield, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) payout_ratio: Optional[float] = Field(default=None, description="Payout ratio") sales_general_and_administrative_to_revenue: Optional[float] = Field( @@ -229,7 +229,7 @@ async def aextract_data( symbols = query.symbol.split(",") - results = [] + results: List = [] async def get_one(symbol): """Get data for one symbol.""" diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_historical.py b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_historical.py index 809bef703379..f1c9e5ba57d4 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_historical.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/models/equity_historical.py @@ -97,7 +97,7 @@ class IntrinioEquityHistoricalData(EquityHistoricalData): default=None, description="Percent change in the price of the symbol from the previous day.", alias="percent_change", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) adj_open: Optional[float] = Field( default=None, @@ -213,24 +213,24 @@ async def callback(response: ClientResponse, session: ClientSession) -> list: init_response = await response.json() if "error" in init_response: raise RuntimeError( - f"Intrinio Error Message -> {init_response['error']}: {init_response.get('message')}" + f"Intrinio Error Message -> {init_response['error']}: {init_response.get('message')}" # type: ignore ) - all_data: list = init_response.get(data_key, []) + all_data: list = init_response.get(data_key, []) # type: ignore - next_page = init_response.get("next_page", None) + next_page = init_response.get("next_page", None) # type: ignore while next_page: url = response.url.update_query(next_page=next_page).human_repr() response_data = await session.get_json(url) - all_data.extend(response_data.get(data_key, [])) - next_page = response_data.get("next_page", None) + all_data.extend(response_data.get(data_key, [])) # type: ignore + next_page = response_data.get("next_page", None) # type: ignore return all_data url = f"{base_url}&{query_str}&api_key={api_key}" - return await amake_request(url, response_callback=callback, **kwargs) + return await amake_request(url, response_callback=callback, **kwargs) # type: ignore @staticmethod def transform_data( diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/bond_prices.py b/openbb_platform/providers/tmx/openbb_tmx/models/bond_prices.py index 2e730316ce71..7bc9c06b5bd0 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/bond_prices.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/bond_prices.py @@ -65,7 +65,7 @@ class TmxBondPricesData(BondReferenceData): + " coupons are reinvested at the same rate." + " Values are returned as a normalized percent.", alias="lastYield", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) price: Optional[float] = Field( default=None, diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/calendar_earnings.py b/openbb_platform/providers/tmx/openbb_tmx/models/calendar_earnings.py index 87082ce61300..4647210f7ab0 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/calendar_earnings.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/calendar_earnings.py @@ -45,7 +45,7 @@ class TmxCalendarEarningsData(CalendarEarningsData): surprise_percent: Optional[float] = Field( default=None, description="The EPS surprise as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) reporting_time: Optional[str] = Field( default=None, diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py b/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py index f81c10e06f93..1e13cb46e2dc 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/equity_historical.py @@ -100,7 +100,7 @@ class TmxEquityHistoricalData(EquityHistoricalData): change_percent: Optional[float] = Field( description="Change in price, as a normalized percentage.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) transactions: Optional[int] = Field( description="Total number of transactions recorded.", default=None diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py b/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py index a97659e5f7a6..17392971948a 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/equity_quote.py @@ -99,7 +99,7 @@ class TmxEquityQuoteData(EquityQuoteData): change_percent: Optional[float] = Field( default=None, description="The change in price as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_high: Optional[float] = Field( description="Fifty-two week high.", default=None, alias="weeks52high" @@ -151,7 +151,7 @@ class TmxEquityQuoteData(EquityQuoteData): description="The dividend yield as a normalized percentage.", default=None, alias="dividendYield", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) div_freq: Optional[str] = Field( description="The frequency of dividend payments.", @@ -170,13 +170,13 @@ class TmxEquityQuoteData(EquityQuoteData): description="The three year dividend growth as a normalized percentage.", default=None, alias="dividend3Years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) div_growth_5y: Optional[Union[float, str]] = Field( description="The five year dividend growth as a normalized percentage.", default=None, alias="dividend5Years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) pe: Optional[Union[float, str]] = Field( description="The price to earnings ratio.", default=None, alias="peRatio" @@ -199,13 +199,13 @@ class TmxEquityQuoteData(EquityQuoteData): description="The return on equity, as a normalized percentage.", default=None, alias="returnOnEquity", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_on_assets: Optional[Union[float, str]] = Field( description="The return on assets, as a normalized percentage.", default=None, alias="returnOnAssets", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) beta: Optional[Union[float, str]] = Field( description="The beta relative to the TSX Composite.", default=None diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/etf_holdings.py b/openbb_platform/providers/tmx/openbb_tmx/models/etf_holdings.py index cdd334d6ef28..3476d6982ba4 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/etf_holdings.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/etf_holdings.py @@ -36,7 +36,7 @@ class TmxEtfHoldingsData(EtfHoldingsData): weight: Optional[float] = Field( description="The weight of the asset in the portfolio, as a normalized percentage.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) shares: Optional[Union[int, str]] = Field( description="The value of the assets under management.", @@ -50,7 +50,7 @@ class TmxEtfHoldingsData(EtfHoldingsData): share_percentage: Optional[float] = Field( description="The share percentage of the holding, as a normalized percentage.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) share_change: Optional[Union[float, str]] = Field( description="The change in shares of the holding.", default=None diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py b/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py index da1b720c9091..ea5963ecb780 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/etf_info.py @@ -48,47 +48,47 @@ class TmxEtfInfoData(EtfInfoData): return_1m: Optional[float] = Field( description="The one-month return of the ETF, as a normalized percent", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_3m: Optional[float] = Field( description="The three-month return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_6m: Optional[float] = Field( description="The six-month return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_ytd: Optional[float] = Field( description="The year-to-date return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_1y: Optional[float] = Field( description="The one-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_3y: Optional[float] = Field( description="The three-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_5y: Optional[float] = Field( description="The five-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_10y: Optional[float] = Field( description="The ten-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_from_inception: Optional[float] = Field( description="The return from inception of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) avg_volume: Optional[int] = Field( description="The average daily volume of the ETF.", @@ -110,17 +110,17 @@ class TmxEtfInfoData(EtfInfoData): management_fee: Optional[float] = Field( description="The management fee of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) mer: Optional[float] = Field( description="The management expense ratio of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) distribution_yield: Optional[float] = Field( description="The distribution yield of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) dividend_frequency: Optional[str] = Field( description="The dividend payment frequency of the ETF.", default=None diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/etf_search.py b/openbb_platform/providers/tmx/openbb_tmx/models/etf_search.py index b4a1e9833ead..260ac2ab3da7 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/etf_search.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/etf_search.py @@ -77,57 +77,57 @@ class TmxEtfSearchData(EtfSearchData): return_1m: Optional[float] = Field( description="The one-month return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_3m: Optional[float] = Field( description="The three-month return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_6m: Optional[float] = Field( description="The six-month return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_ytd: Optional[float] = Field( description="The year-to-date return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_1y: Optional[float] = Field( description="The one-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) beta_1y: Optional[float] = Field( description="The one-year beta of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_3y: Optional[float] = Field( description="The three-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) beta_3y: Optional[float] = Field( description="The three-year beta of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_5y: Optional[float] = Field( description="The five-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) beta_5y: Optional[float] = Field( description="The five-year beta of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_10y: Optional[float] = Field( description="The ten-year return of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) beta_10y: Optional[float] = Field( description="The ten-year beta of the ETF.", default=None @@ -138,7 +138,7 @@ class TmxEtfSearchData(EtfSearchData): return_from_inception: Optional[float] = Field( description="The return from inception of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) avg_volume: Optional[int] = Field( description="The average daily volume of the ETF.", @@ -160,17 +160,17 @@ class TmxEtfSearchData(EtfSearchData): management_fee: Optional[float] = Field( description="The management fee of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) mer: Optional[float] = Field( description="The management expense ratio of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) distribution_yield: Optional[float] = Field( description="The distribution yield of the ETF, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) dividend_frequency: Optional[str] = Field( description="The dividend payment frequency of the ETF.", default=None diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/index_snapshots.py b/openbb_platform/providers/tmx/openbb_tmx/models/index_snapshots.py index e3f81710561f..42a9114ce648 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/index_snapshots.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/index_snapshots.py @@ -64,17 +64,17 @@ class TmxIndexSnapshotsData(IndexSnapshotsData): return_mtd: Optional[float] = Field( default=None, description="The month-to-date return of the index, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_qtd: Optional[float] = Field( default=None, description="The quarter-to-date return of the index, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_ytd: Optional[float] = Field( default=None, description="The year-to-date return of the index, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_market_value: Optional[float] = Field( default=None, @@ -103,7 +103,7 @@ class TmxIndexSnapshotsData(IndexSnapshotsData): constituent_largest_weight: Optional[float] = Field( default=None, description="The largest weight of the index constituents, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) constituent_smallest_market_value: Optional[float] = Field( default=None, @@ -112,7 +112,7 @@ class TmxIndexSnapshotsData(IndexSnapshotsData): constituent_smallest_weight: Optional[float] = Field( default=None, description="The smallest weight of the index constituents, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) @field_validator( diff --git a/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py b/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py index 1ee9a9f71353..4d304d6fbb0f 100644 --- a/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py +++ b/openbb_platform/providers/tmx/openbb_tmx/models/price_target_consensus.py @@ -42,7 +42,7 @@ class TmxPriceTargetConsensusData(PriceTargetConsensusData): target_upside: Optional[float] = Field( default=None, description="Percent of upside, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_analysts: Optional[int] = Field( default=None, description="Total number of analyst." diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py index 7150bc7be502..d74ffc2e352d 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/equity_profile.py @@ -91,7 +91,7 @@ class YFinanceEquityProfileData(EquityInfoData): dividend_yield: Optional[float] = Field( description="The dividend yield of the asset, as a normalized percent.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="yield", ) beta: Optional[float] = Field( diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py index 915fb44bf4f5..639b01e6aaa4 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/etf_info.py @@ -78,7 +78,7 @@ class YFinanceEtfInfoData(EtfInfoData): dividend_yield: Optional[float] = Field( default=None, description="The dividend yield of the fund, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="yield", ) dividend_rate_ttm: Optional[float] = Field( @@ -89,7 +89,7 @@ class YFinanceEtfInfoData(EtfInfoData): dividend_yield_ttm: Optional[float] = Field( default=None, description="The trailing twelve month annual dividend yield of the fund, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="trailingAnnualDividendYield", ) year_high: Optional[float] = Field( @@ -115,19 +115,19 @@ class YFinanceEtfInfoData(EtfInfoData): return_ytd: Optional[float] = Field( default=None, description="The year-to-date return of the fund, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="ytdReturn", ) return_3y_avg: Optional[float] = Field( default=None, description="The three year average return of the fund, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="threeYearAverageReturn", ) return_5y_avg: Optional[float] = Field( default=None, description="The five year average return of the fund, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="fiveYearAverageReturn", ) beta_3y_avg: Optional[float] = Field( diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py index ae176d2d7631..3dbff8487aa6 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/key_metrics.py @@ -67,7 +67,7 @@ class YFinanceKeyMetricsData(KeyMetricsData): earnings_growth_quarterly: Optional[float] = Field( default=None, description="Quarterly earnings growth (Year Over Year), as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="earningsQuarterlyGrowth", ) revenue_per_share: Optional[float] = Field( @@ -78,7 +78,7 @@ class YFinanceKeyMetricsData(KeyMetricsData): revenue_growth: Optional[float] = Field( default=None, description="Revenue growth (Year Over Year), as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="revenueGrowth", ) enterprise_to_revenue: Optional[float] = Field( @@ -109,49 +109,49 @@ class YFinanceKeyMetricsData(KeyMetricsData): gross_margin: Optional[float] = Field( default=None, description="Gross margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="grossMargins", ) operating_margin: Optional[float] = Field( default=None, description="Operating margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="operatingMargins", ) ebitda_margin: Optional[float] = Field( default=None, description="EBITDA margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="ebitdaMargins", ) profit_margin: Optional[float] = Field( default=None, description="Profit margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="profitMargins", ) return_on_assets: Optional[float] = Field( default=None, description="Return on assets, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="returnOnAssets", ) return_on_equity: Optional[float] = Field( default=None, description="Return on equity, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="returnOnEquity", ) dividend_yield: Optional[float] = Field( default=None, description="Dividend yield, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="dividendYield", ) dividend_yield_5y_avg: Optional[float] = Field( default=None, description="5-year average dividend yield, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="fiveYearAvgDividendYield", ) payout_ratio: Optional[float] = Field( @@ -205,7 +205,7 @@ class YFinanceKeyMetricsData(KeyMetricsData): price_return_1y: Optional[float] = Field( default=None, description="One-year price return, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="52WeekChange", ) currency: Optional[str] = Field( diff --git a/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py b/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py index d7dba5e4589e..11a789596daf 100644 --- a/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py +++ b/openbb_platform/providers/yfinance/openbb_yfinance/models/share_statistics.py @@ -49,7 +49,7 @@ class YFinanceShareStatisticsData(ShareStatisticsData): short_percent_of_float: Optional[float] = Field( default=None, description="Percentage of shares that are reported short, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="shortPercentOfFloat", ) days_to_cover: Optional[float] = Field( @@ -70,19 +70,19 @@ class YFinanceShareStatisticsData(ShareStatisticsData): insider_ownership: Optional[float] = Field( default=None, description="Percentage of shares held by insiders, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="heldPercentInsiders", ) institution_ownership: Optional[float] = Field( default=None, description="Percentage of shares held by institutions, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="heldPercentInstitutions", ) institution_float_ownership: Optional[float] = Field( default=None, description="Percentage of float held by institutions, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="institutionsFloatPercentHeld", ) institutions_count: Optional[int] = Field(