diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py index b2942d73300..4a2a8103640 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/__extensions__.py @@ -1,15 +1,24 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### + from openbb_core.app.static.container import Container class Extensions(Container): @property - def news(self): # route = "/news" - from openbb_core.app.static.package import news + def crypto(self): # route = "/crypto" + from openbb_core.app.static.package import crypto - return news.CLASS_news(command_runner_session=self._command_runner_session) + return crypto.CLASS_crypto(command_runner_session=self._command_runner_session) + + @property + def economy(self): # route = "/economy" + from openbb_core.app.static.package import economy + + return economy.CLASS_economy( + command_runner_session=self._command_runner_session + ) @property def fixedincome(self): # route = "/fixedincome" @@ -26,24 +35,10 @@ class Extensions(Container): return forex.CLASS_forex(command_runner_session=self._command_runner_session) @property - def economy(self): # route = "/economy" - from openbb_core.app.static.package import economy + def news(self): # route = "/news" + from openbb_core.app.static.package import news - return economy.CLASS_economy( - command_runner_session=self._command_runner_session - ) - - @property - def crypto(self): # route = "/crypto" - from openbb_core.app.static.package import crypto - - return crypto.CLASS_crypto(command_runner_session=self._command_runner_session) - - @property - def stocks(self): # route = "/stocks" - from openbb_core.app.static.package import stocks - - return stocks.CLASS_stocks(command_runner_session=self._command_runner_session) + return news.CLASS_news(command_runner_session=self._command_runner_session) @property def qa(self): # route = "/qa" @@ -51,6 +46,12 @@ class Extensions(Container): return qa.CLASS_qa(command_runner_session=self._command_runner_session) + @property + def stocks(self): # route = "/stocks" + from openbb_core.app.static.package import stocks + + return stocks.CLASS_stocks(command_runner_session=self._command_runner_session) + @property def ta(self): # route = "/ta" from openbb_core.app.static.package import ta diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py index 79fec6c462b..f8447f19594 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/crypto.py @@ -2,12 +2,11 @@ import datetime import typing -from typing import Annotated, Literal, Optional, Union +from typing import Literal, Optional, Union from pydantic import validate_arguments from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -17,26 +16,14 @@ class CLASS_crypto(Container): @validate_arguments def load( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + symbol: str, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: - """Crypto Intraday Price. + r"""Crypto Intraday Price. openbb @@ -44,7 +31,7 @@ class CLASS_crypto(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -85,6 +72,30 @@ class CLASS_crypto(Container): vwap : PositiveFloat Volume Weighted Average Price of the symbol. + fmp + === + + Parameters + ---------- + timeseries : Optional[NonNegativeInt] + Number of days to look back. + + + CryptoEOD + --------- + adjClose : float + Adjusted Close Price of the symbol. + unadjustedVolume : float + Unadjusted volume of the symbol. + change : float + Change in the price of the symbol from the previous day. + changePercent : float + Change \% in the price of the symbol. + label : str + Human readable format of the date. + changeOverTime : float + Change \% in the price of the symbol over a period of time. + polygon ======= @@ -107,6 +118,54 @@ class CLASS_crypto(Container): n : PositiveInt The number of transactions for the symbol in the time period. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + CryptoEOD + --------- + date : datetime + The date of the data. + open : PositiveFloat + The open price of the symbol. + high : PositiveFloat + The high price of the symbol. + low : PositiveFloat + The low price of the symbol. + close : PositiveFloat + The close price of the symbol. + volume : PositiveFloat + The volume of the symbol. + vwap : PositiveFloat + Volume Weighted Average Price of the symbol. + fmp === @@ -125,11 +184,33 @@ class CLASS_crypto(Container): change : float Change in the price of the symbol from the previous day. changePercent : float - Change \\% in the price of the symbol. + Change \% in the price of the symbol. label : str Human readable format of the date. changeOverTime : float - Change \\% in the price of the symbol over a period of time.""" + Change \% in the price of the symbol over a period of time. + + polygon + ======= + + Parameters + ---------- + timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'] + The timespan of the data. + sort : Literal['asc', 'desc'] + Sort order of the data. + limit : PositiveInt + The number of data entries to return. + adjusted : bool + Whether the data is adjusted. + multiplier : PositiveInt + The multiplier of the timespan. + + + CryptoEOD + --------- + n : PositiveInt + The number of transactions for the symbol in the time period.""" inputs = filter_inputs( provider_choices={ "provider": provider, diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py index 936f448ead8..1e4d29ae7a0 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/economy.py @@ -2,14 +2,13 @@ import datetime import typing -from typing import Annotated, List, Literal, Optional, Union +from typing import List, Literal, Optional, Union from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -41,12 +40,7 @@ class CLASS_economy(Container): @validate_arguments def const( self, - index: Annotated[ - Literal["nasdaq", "sp500", "dowjones"], - OpenBBCustomParameter( - description="The index for which we want to fetch the constituents." - ), - ] = "dowjones", + index: Literal["nasdaq", "sp500", "dowjones"] = "dowjones", chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -54,6 +48,64 @@ class CLASS_economy(Container): """Get the constituents of an index. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + index : Literal['nasdaq', 'sp500', 'dowjones'] + The index for which we want to fetch the constituents. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + MajorIndicesConstituents + ------------------------ + symbol : ConstrainedStrValue + Symbol to get data for. + name : str + The name of the constituent company in the index. + sector : str + The sector the constituent company in the index belongs to. + sub_sector : Optional[str] + The sub-sector the constituent company in the index belongs to. + headquarter : Optional[str] + The location of the headquarter of the constituent company in the index. + date_first_added : Union[date, str, NoneType] + The date the constituent company was added to the index. + cik : int + The Central Index Key of the constituent company in the index. + founded : Union[date, str] + The founding year of the constituent company in the index. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + MajorIndicesConstituents + ------------------------ + All fields are standardized. + + + openbb ====== @@ -131,88 +183,64 @@ class CLASS_economy(Container): @validate_arguments def cpi( self, - countries: Annotated[ - List[ - Literal[ - "australia", - "austria", - "belgium", - "brazil", - "bulgaria", - "canada", - "chile", - "china", - "croatia", - "cyprus", - "czech_republic", - "denmark", - "estonia", - "euro_area", - "finland", - "france", - "germany", - "greece", - "hungary", - "iceland", - "india", - "indonesia", - "ireland", - "israel", - "italy", - "japan", - "korea", - "latvia", - "lithuania", - "luxembourg", - "malta", - "mexico", - "netherlands", - "new_zealand", - "norway", - "poland", - "portugal", - "romania", - "russian_federation", - "slovak_republic", - "slovakia", - "slovenia", - "south_africa", - "spain", - "sweden", - "switzerland", - "turkey", - "united_kingdom", - "united_states", - ] - ], - OpenBBCustomParameter(description="The country or countries to get data."), + countries: List[ + Literal[ + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "croatia", + "cyprus", + "czech_republic", + "denmark", + "estonia", + "euro_area", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "malta", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russian_federation", + "slovak_republic", + "slovakia", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states", + ] ], - units: Annotated[ - Literal["growth_previous", "growth_same", "index_2015"], - OpenBBCustomParameter(description="The data units."), - ] = "growth_same", - frequency: Annotated[ - Literal["monthly", "quarterly", "annual"], - OpenBBCustomParameter(description="The data time frequency."), - ] = "monthly", - harmonized: typing.Annotated[ - bool, - OpenBBCustomParameter( - description="Whether you wish to obtain harmonized data." - ), - ] = False, - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + units: Literal["growth_previous", "growth_same", "index_2015"] = "growth_same", + frequency: Literal["monthly", "quarterly", "annual"] = "monthly", + harmonized: bool = False, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, provider: Optional[Literal["fred"]] = None, **kwargs @@ -220,6 +248,66 @@ class CLASS_economy(Container): """CPI. + openbb + ====== + + Parameters + ---------- + provider: Literal[fred] + The provider to use for the query. + countries : List[Literal['australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'croatia', 'cyprus', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'malta', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'romania', 'russian_federation', 'slovak_republic', 'slovakia', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states']] + The country or countries to get data. + units : Literal['growth_previous', 'growth_same', 'index_2015'] + The data units. + frequency : Literal['monthly', 'quarterly', 'annual'] + The data time frequency. + harmonized : bool + Whether you wish to obtain harmonized data. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + CPI + --- + date : date + The date of the data. + realtime_start : date + The date the data was updated. + realtime_end : date + The date the data was updated. + value : float + The value of the data. + + fred + ==== + + Parameters + ---------- + All fields are standardized. + + + CPI + --- + All fields are standardized. + + + openbb ====== @@ -326,26 +414,14 @@ class CLASS_economy(Container): @validate_arguments def index( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + symbol: str, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: - """Get OHLCV data for an index. + r"""Get OHLCV data for an index. openbb @@ -353,7 +429,7 @@ class CLASS_economy(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -390,6 +466,34 @@ class CLASS_economy(Container): volume : PositiveFloat The volume of the symbol. + fmp + === + + Parameters + ---------- + timeseries : Optional[NonNegativeInt] + Number of days to look back. + + + MajorIndicesEOD + --------------- + date : datetime + The date of the data. + adjClose : float + Adjusted Close Price of the symbol. + unadjustedVolume : float + Unadjusted volume of the symbol. + change : float + Change in the price of the symbol from the previous day. + changePercent : float + Change \% in the price of the symbol. + vwap : float + Volume Weighted Average Price of the symbol. + label : str + Human readable format of the date. + changeOverTime : float + Change \% in the price of the symbol over a period of time. + polygon ======= @@ -416,6 +520,50 @@ class CLASS_economy(Container): vw : PositiveFloat The volume weighted average price of the symbol. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + MajorIndicesEOD + --------------- + open : PositiveFloat + The open price of the symbol. + high : PositiveFloat + The high price of the symbol. + low : PositiveFloat + The low price of the symbol. + close : PositiveFloat + The close price of the symbol. + volume : PositiveFloat + The volume of the symbol. + fmp === @@ -436,13 +584,39 @@ class CLASS_economy(Container): change : float Change in the price of the symbol from the previous day. changePercent : float - Change \\% in the price of the symbol. + Change \% in the price of the symbol. vwap : float Volume Weighted Average Price of the symbol. label : str Human readable format of the date. changeOverTime : float - Change \\% in the price of the symbol over a period of time.""" + Change \% in the price of the symbol over a period of time. + + polygon + ======= + + Parameters + ---------- + timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'] + The timespan of the data. + sort : Literal['asc', 'desc'] + Sort order of the data. + limit : PositiveInt + The number of data entries to return. + adjusted : bool + Whether the data is adjusted. + multiplier : PositiveInt + The multiplier of the timespan. + + + MajorIndicesEOD + --------------- + t : datetime + The timestamp of the data. + n : PositiveInt + The number of transactions for the symbol in the time period. + vw : PositiveFloat + The volume weighted average price of the symbol.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -471,6 +645,57 @@ class CLASS_economy(Container): """AVAILABLE_INDICES. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + All fields are standardized. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + AvailableIndices + ---------------- + symbol : ConstrainedStrValue + Symbol to get data for. + name : Optional[str] + The name of the index. + currency : Optional[str] + The currency the index is traded in. + stock_exchange : str + The stock exchange where the index is listed. + exchange_short_name : str + The short name of the stock exchange where the index is listed. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + AvailableIndices + ---------------- + All fields are standardized. + + + openbb ====== @@ -543,6 +768,55 @@ class CLASS_economy(Container): """Market Risk Premium. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + All fields are standardized. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + RiskPremium + ----------- + country : str + Market country. + continent : Optional[str] + Continent of the country. + total_equity_risk_premium : PositiveFloat + The total equity risk premium for the country. + country_risk_premium : NonNegativeFloat + The country-specific risk premium. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + RiskPremium + ----------- + All fields are standardized. + + + openbb ====== diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py index 3763cb95872..6ce0c7dbc95 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/fixedincome.py @@ -2,14 +2,13 @@ import datetime import typing -from typing import Annotated, Literal, Optional, Union +from typing import Literal, Optional, Union from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -19,18 +18,8 @@ class CLASS_fixedincome(Container): @validate_arguments def treasury( self, - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -38,6 +27,76 @@ class CLASS_fixedincome(Container): """Get treasury rates. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + TreasuryRates + ------------- + date : date + The date of the data. + month_1 : float + The 1 month treasury rate. + month_2 : float + The 2 month treasury rate. + month_3 : float + The 3 month treasury rate. + month_6 : float + The 6 month treasury rate. + year_1 : float + The 1 year treasury rate. + year_2 : float + The 2 year treasury rate. + year_3 : float + The 3 year treasury rate. + year_5 : float + The 5 year treasury rate. + year_7 : float + The 7 year treasury rate. + year_10 : float + The 10 year treasury rate. + year_20 : float + The 20 year treasury rate. + year_30 : float + The 30 year treasury rate. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + TreasuryRates + ------------- + All fields are standardized. + + + openbb ====== diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py index 94532bb1d20..9c4aaa8851b 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/forex.py @@ -2,12 +2,11 @@ import datetime import typing -from typing import Annotated, Literal, Optional, Union +from typing import Literal, Optional, Union from pydantic import validate_arguments from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -18,7 +17,7 @@ class CLASS_forex(Container): def pairs( self, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: """Forex Available Pairs. @@ -29,7 +28,7 @@ class CLASS_forex(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. All fields are standardized. @@ -53,6 +52,25 @@ class CLASS_forex(Container): name : str The name of the currency pair. + fmp + === + + Parameters + ---------- + All fields are standardized. + + + ForexPairs + ---------- + symbol : str + The symbol of the currency pair. + currency : str + The base currency of the currency pair. + stockExchange : Optional[str] + The stock exchange of the currency pair. + exchange_short_name : Optional[str] + The short name of the stock exchange of the currency pair. + polygon ======= @@ -93,6 +111,37 @@ class CLASS_forex(Container): delisted_utc : Optional[datetime] The delisted timestamp in UTC. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + All fields are standardized. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + ForexPairs + ---------- + name : str + The name of the currency pair. + fmp === @@ -110,7 +159,47 @@ class CLASS_forex(Container): stockExchange : Optional[str] The stock exchange of the currency pair. exchange_short_name : Optional[str] - The short name of the stock exchange of the currency pair.""" + The short name of the stock exchange of the currency pair. + + polygon + ======= + + Parameters + ---------- + symbol : Optional[str] + Symbol of the pair to search. + date : Optional[date] + A specific date to get data for. + search : Optional[str] + Search for terms within the ticker and/or company name. + active : Optional[Literal[True, False]] + Specify if the tickers returned should be actively traded on the queried date. + order : Optional[Literal['asc', 'desc']] + Order data by ascending or descending. + sort : Optional[Literal['ticker', 'name', 'market', 'locale', 'currency_symbol', 'currency_name', 'base_currency_symbol', 'base_currency_name', 'last_updated_utc', 'delisted_utc']] + Sort field used for ordering. + limit : Optional[PositiveInt] + The number of data entries to return. + + + ForexPairs + ---------- + market : str + The name of the trading market. Always 'fx'. + locale : str + The locale of the currency pair. + currency_symbol : str + The symbol of the quote currency. + currency_name : str + The name of the quote currency. + base_currency_symbol : str + The symbol of the base currency. + base_currency_name : str + The name of the base currency. + last_updated_utc : datetime + The last updated timestamp in UTC. + delisted_utc : Optional[datetime] + The delisted timestamp in UTC.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -131,26 +220,14 @@ class CLASS_forex(Container): @validate_arguments def load( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + symbol: str, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: - """Forex Intraday Price. + r"""Forex Intraday Price. openbb @@ -158,7 +235,7 @@ class CLASS_forex(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -199,6 +276,29 @@ class CLASS_forex(Container): vwap : Optional[PositiveFloat] Volume Weighted Average Price of the symbol. + fmp + === + + Parameters + ---------- + All fields are standardized. + + + ForexEOD + -------- + adjClose : float + Adjusted Close Price of the symbol. + unadjustedVolume : float + Unadjusted volume of the symbol. + change : float + Change in the price of the symbol from the previous day. + changePercent : float + Change \% in the price of the symbol. + label : str + Human readable format of the date. + changeOverTime : float + Change \% in the price of the symbol over a period of time. + polygon ======= @@ -221,6 +321,54 @@ class CLASS_forex(Container): n : PositiveInt The number of transactions for the symbol in the time period. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + ForexEOD + -------- + date : datetime + The date of the data. + open : PositiveFloat + The open price of the symbol. + high : PositiveFloat + The high price of the symbol. + low : PositiveFloat + The low price of the symbol. + close : PositiveFloat + The close price of the symbol. + volume : NonNegativeFloat + The volume of the symbol. + vwap : Optional[PositiveFloat] + Volume Weighted Average Price of the symbol. + fmp === @@ -238,11 +386,33 @@ class CLASS_forex(Container): change : float Change in the price of the symbol from the previous day. changePercent : float - Change \\% in the price of the symbol. + Change \% in the price of the symbol. label : str Human readable format of the date. changeOverTime : float - Change \\% in the price of the symbol over a period of time.""" + Change \% in the price of the symbol over a period of time. + + polygon + ======= + + Parameters + ---------- + timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'] + The timespan of the data. + sort : Literal['asc', 'desc'] + Sort order of the data. + limit : PositiveInt + The number of data entries to return. + adjusted : bool + Whether the data is adjusted. + multiplier : PositiveInt + The multiplier of the timespan. + + + ForexEOD + -------- + n : PositiveInt + The number of transactions for the symbol in the time period.""" inputs = filter_inputs( provider_choices={ "provider": provider, diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json b/openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json index f0b46d3741c..83224aab956 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/module_map.json @@ -1,14 +1,7 @@ { - "news_globalnews": "/news/globalnews", + "crypto_load": "/crypto/load", "__extensions__": "", - "news": "/news", - "news_sectornews": "/news/sectornews", - "fixedincome_treasury": "/fixedincome/treasury", - "fixedincome": "/fixedincome", - "fixedincome_ycrv": "/fixedincome/ycrv", - "forex_pairs": "/forex/pairs", - "forex": "/forex", - "forex_load": "/forex/load", + "crypto": "/crypto", "economy_corecpi": "/economy/corecpi", "economy": "/economy", "economy_const": "/economy/const", @@ -44,8 +37,41 @@ "economy_trust": "/economy/trust", "economy_usbonds": "/economy/usbonds", "economy_valuation": "/economy/valuation", - "crypto_load": "/crypto/load", - "crypto": "/crypto", + "fixedincome_treasury": "/fixedincome/treasury", + "fixedincome": "/fixedincome", + "fixedincome_ycrv": "/fixedincome/ycrv", + "forex_pairs": "/forex/pairs", + "forex": "/forex", + "forex_load": "/forex/load", + "news_globalnews": "/news/globalnews", + "news": "/news", + "news_sectornews": "/news/sectornews", + "qa_normality": "/qa/normality", + "qa": "/qa", + "qa_capm": "/qa/capm", + "qa_qqplot": "/qa/qqplot", + "qa_om": "/qa/om", + "qa_kurtosis": "/qa/kurtosis", + "qa_pick": "/qa/pick", + "qa_spread": "/qa/spread", + "qa_rolling": "/qa/rolling", + "qa_var": "/qa/var", + "qa_line": "/qa/line", + "qa_hist": "/qa/hist", + "qa_unitroot": "/qa/unitroot", + "qa_beta": "/qa/beta", + "qa_sh": "/qa/sh", + "qa_so": "/qa/so", + "qa_cusum": "/qa/cusum", + "qa_raw": "/qa/raw", + "qa_cdf": "/qa/cdf", + "qa_decompose": "/qa/decompose", + "qa_skew": "/qa/skew", + "qa_quantile": "/qa/quantile", + "qa_bw": "/qa/bw", + "qa_es": "/qa/es", + "qa_acf": "/qa/acf", + "qa_summary": "/qa/summary", "stocks_fa_analysis": "/stocks/fa/analysis", "stocks": "/stocks", "stocks_fa": "/stocks/fa", @@ -193,32 +219,6 @@ "stocks_tob": "/stocks/tob", "stocks_quote": "/stocks/quote", "stocks_search": "/stocks/search", - "qa_normality": "/qa/normality", - "qa": "/qa", - "qa_capm": "/qa/capm", - "qa_qqplot": "/qa/qqplot", - "qa_om": "/qa/om", - "qa_kurtosis": "/qa/kurtosis", - "qa_pick": "/qa/pick", - "qa_spread": "/qa/spread", - "qa_rolling": "/qa/rolling", - "qa_var": "/qa/var", - "qa_line": "/qa/line", - "qa_hist": "/qa/hist", - "qa_unitroot": "/qa/unitroot", - "qa_beta": "/qa/beta", - "qa_sh": "/qa/sh", - "qa_so": "/qa/so", - "qa_cusum": "/qa/cusum", - "qa_raw": "/qa/raw", - "qa_cdf": "/qa/cdf", - "qa_decompose": "/qa/decompose", - "qa_skew": "/qa/skew", - "qa_quantile": "/qa/quantile", - "qa_bw": "/qa/bw", - "qa_es": "/qa/es", - "qa_acf": "/qa/acf", - "qa_summary": "/qa/summary", "ta_atr": "/ta/atr", "ta": "/ta", "ta_fib": "/ta/fib", diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/news.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/news.py index 703fd2fd0ac..260c4f0dbe6 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/news.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/news.py @@ -9,7 +9,6 @@ from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -19,10 +18,7 @@ class CLASS_news(Container): @validate_arguments def globalnews( self, - page: typing.Annotated[ - pydantic.types.NonNegativeInt, - OpenBBCustomParameter(description="The page of the global news."), - ] = 0, + page: pydantic.types.NonNegativeInt = 0, chart: bool = False, provider: Optional[Literal["benzinga", "fmp"]] = None, **kwargs @@ -30,6 +26,100 @@ class CLASS_news(Container): """Global News. + openbb + ====== + + Parameters + ---------- + provider: Literal[benzinga, fmp] + The provider to use for the query. + page : NonNegativeInt + The page of the global news. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + GlobalNews + ---------- + date : datetime + The published date of the news. + title : str + The title of the news. + image : Optional[str] + The image URL of the news. + text : str + The text/body of the news. + url : str + The URL of the news. + + benzinga + ======== + + Parameters + ---------- + pageSize : int + The number of results to return per page. + displayOutput : Literal['headline', 'summary', 'full', 'all'] + The type of data to return. + date : Optional[datetime] + The date of the news to retrieve. + dateFrom : Optional[datetime] + The start date of the news to retrieve. + dateTo : Optional[datetime] + The end date of the news to retrieve. + updatedSince : Optional[int] + The number of seconds since the news was updated. + publishedSince : Optional[int] + The number of seconds since the news was published. + sort : Optional[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type']] + The order in which to sort the news. Options are: published_at, updated_at, title, author, channel, ticker, topic, content_type. + isin : Optional[str] + The ISIN of the news to retrieve. + cusip : Optional[str] + The CUSIP of the news to retrieve. + tickers : Optional[str] + The tickers of the news to retrieve. + channels : Optional[str] + The channels of the news to retrieve. + topics : Optional[str] + The topics of the news to retrieve. + authors : Optional[str] + The authors of the news to retrieve. + content_types : Optional[str] + The content types of the news to retrieve. + + + GlobalNews + ---------- + All fields are standardized. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + GlobalNews + ---------- + site : str + The site of the news. + + + openbb ====== diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py index b4c1e005c58..14fd74c8164 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks.py @@ -2,7 +2,7 @@ import datetime import typing -from typing import Annotated, Literal, Optional, Union +from typing import Literal, Optional, Union import pydantic from pydantic import validate_arguments @@ -10,7 +10,6 @@ from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -84,26 +83,14 @@ class CLASS_stocks(Container): @validate_arguments def load( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + symbol: str, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: - """Load stock data for a specific ticker. + r"""Load stock data for a specific ticker. openbb @@ -111,7 +98,7 @@ class CLASS_stocks(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -147,11 +134,35 @@ class CLASS_stocks(Container): The low price of the symbol. close : PositiveFloat The close price of the symbol. - volume : PositiveFloat + volume : NonNegativeFloat The volume of the symbol. - vwap : PositiveFloat + vwap : Optional[PositiveFloat] Volume Weighted Average Price of the symbol. + fmp + === + + Parameters + ---------- + timeseries : Optional[NonNegativeInt] + Number of days to look back. + + + StockEOD + -------- + adjClose : float + Adjusted Close Price of the symbol. + unadjustedVolume : float + Unadjusted volume of the symbol. + change : float + Change in the price of the symbol from the previous day. + changePercent : float + Change \% in the price of the symbol. + label : str + Human readable format of the date. + changeOverTime : float + Change \% in the price of the symbol over a period of time. + polygon ======= @@ -174,6 +185,54 @@ class CLASS_stocks(Container): n : PositiveInt The number of transactions for the symbol in the time period. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockEOD + -------- + date : datetime + The date of the data. + open : PositiveFloat + The open price of the symbol. + high : PositiveFloat + The high price of the symbol. + low : PositiveFloat + The low price of the symbol. + close : PositiveFloat + The close price of the symbol. + volume : NonNegativeFloat + The volume of the symbol. + vwap : Optional[PositiveFloat] + Volume Weighted Average Price of the symbol. + fmp === @@ -192,11 +251,33 @@ class CLASS_stocks(Container): change : float Change in the price of the symbol from the previous day. changePercent : float - Change \\% in the price of the symbol. + Change \% in the price of the symbol. label : str Human readable format of the date. changeOverTime : float - Change \\% in the price of the symbol over a period of time.""" + Change \% in the price of the symbol over a period of time. + + polygon + ======= + + Parameters + ---------- + timespan : Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year'] + The timespan of the data. + sort : Literal['asc', 'desc'] + Sort order of the data. + limit : PositiveInt + The number of data entries to return. + adjusted : bool + Whether the data is adjusted. + multiplier : PositiveInt + The multiplier of the timespan. + + + StockEOD + -------- + n : PositiveInt + The number of transactions for the symbol in the time period.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -221,23 +302,11 @@ class CLASS_stocks(Container): @validate_arguments def news( self, - symbols: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - page: typing.Annotated[ - int, - OpenBBCustomParameter( - description="The page of the stock news to be retrieved." - ), - ] = 0, - limit: Annotated[ - Optional[pydantic.types.NonNegativeInt], - OpenBBCustomParameter( - description="The number of results to return per page." - ), - ] = 15, + symbols: str, + page: int = 0, + limit: Optional[pydantic.types.NonNegativeInt] = 15, chart: bool = False, - provider: Optional[Literal["benzinga", "polygon", "fmp"]] = None, + provider: Optional[Literal["benzinga", "fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: """Get news for one or more stock tickers. @@ -248,7 +317,7 @@ class CLASS_stocks(Container): Parameters ---------- - provider: Literal[benzinga, polygon, fmp] + provider: Literal[benzinga, fmp, polygon] The provider to use for the query. symbols : ConstrainedStrValue Symbol to get data for. @@ -321,6 +390,23 @@ class CLASS_stocks(Container): image : List[BenzingaImage] The images associated with the news. + fmp + === + + Parameters + ---------- + All fields are standardized. + + + StockNews + --------- + symbol : str + Ticker of the fetched news. + image : Optional[str] + URL to the image of the news source. + site : str + Name of the news source. + polygon ======= @@ -367,6 +453,86 @@ class CLASS_stocks(Container): tickers : List[str] Tickers covered in the article. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[benzinga, fmp, polygon] + The provider to use for the query. + symbols : ConstrainedStrValue + Symbol to get data for. + page : int + The page of the stock news to be retrieved. + limit : Optional[NonNegativeInt] + The number of results to return per page. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockNews + --------- + date : date + The published date of the news. + title : str + The title of the news. + text : Optional[str] + The text/body of the news. + url : str + The URL of the news. + + benzinga + ======== + + Parameters + ---------- + displayOutput : Literal['headline', 'summary', 'full', 'all'] + The type of data to return. + date : Optional[datetime] + The date of the news to retrieve. + dateFrom : Optional[datetime] + The start date of the news to retrieve. + dateTo : Optional[datetime] + The end date of the news to retrieve. + updatedSince : Optional[int] + The number of seconds since the news was updated. + publishedSince : Optional[int] + The number of seconds since the news was published. + sort : Optional[Literal['published_at', 'updated_at', 'title', 'author', 'channel', 'ticker', 'topic', 'content_type']] + The order in which to sort the news. Options are: published_at, updated_at, title, author, channel, ticker, topic, content_type. + isin : Optional[str] + The ISIN of the news to retrieve. + cusip : Optional[str] + The CUSIP of the news to retrieve. + channels : Optional[str] + The channels of the news to retrieve. + topics : Optional[str] + The topics of the news to retrieve. + authors : Optional[str] + The authors of the news to retrieve. + content_types : Optional[str] + The content types of the news to retrieve. + + + StockNews + --------- + image : List[BenzingaImage] + The images associated with the news. + fmp === @@ -382,7 +548,53 @@ class CLASS_stocks(Container): image : Optional[str] URL to the image of the news source. site : str - Name of the news source.""" + Name of the news source. + + polygon + ======= + + Parameters + ---------- + ticker_lt : Optional[str] + Less than, by default None + ticker_lte : Optional[str] + Less than or equal, by default None + ticker_gt : Optional[str] + Greater than, by default None + ticker_gte : Optional[str] + Greater than or equal, by default None + published_utc : Optional[str] + The published date of the query, by default None + published_utc_lt : Optional[str] + Less than, by default None + published_utc_lte : Optional[str] + Less than or equal, by default None + published_utc_gt : Optional[str] + Greater than, by default None + published_utc_gte : Optional[str] + Greater than or equal, by default None + order : Optional[Literal['asc', 'desc']] + The sort order of the query, by default None + sort : Optional[str] + The sort of the query, by default None + + + StockNews + --------- + amp_url : Optional[str] + AMP URL. + author : Optional[str] + Author of the article. + id : str + Article ID. + image_url : Optional[str] + Image URL. + keywords : Optional[List[str]] + Keywords in the article + publisher : PolygonPublisher + Publisher of the article. + tickers : List[str] + Tickers covered in the article.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -407,13 +619,8 @@ class CLASS_stocks(Container): @validate_arguments def multiples( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - limit: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 100, + symbol: str, + limit: Optional[int] = 100, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -573,6 +780,164 @@ class CLASS_stocks(Container): All fields are standardized. + StockMultiples + -------------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + limit : Optional[int] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockMultiples + -------------- + revenue_per_share_ttm : Optional[float] + Revenue per share calculated as trailing twelve months. + net_income_per_share_ttm : Optional[float] + Net income per share calculated as trailing twelve months. + operating_cash_flow_per_share_ttm : Optional[float] + Operating cash flow per share calculated as trailing twelve months. + free_cash_flow_per_share_ttm : Optional[float] + Free cash flow per share calculated as trailing twelve months. + cash_per_share_ttm : Optional[float] + Cash per share calculated as trailing twelve months. + book_value_per_share_ttm : Optional[float] + Book value per share calculated as trailing twelve months. + tangible_book_value_per_share_ttm : Optional[float] + Tangible book value per share calculated as trailing twelve months. + shareholders_equity_per_share_ttm : Optional[float] + Shareholders equity per share calculated as trailing twelve months. + interest_debt_per_share_ttm : Optional[float] + Interest debt per share calculated as trailing twelve months. + market_cap_ttm : Optional[float] + Market capitalization calculated as trailing twelve months. + enterprise_value_ttm : Optional[float] + Enterprise value calculated as trailing twelve months. + pe_ratio_ttm : Optional[float] + Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months. + price_to_sales_ratio_ttm : Optional[float] + Price-to-sales ratio calculated as trailing twelve months. + pocf_ratio_ttm : Optional[float] + Price-to-operating cash flow ratio calculated as trailing twelve months. + pfcf_ratio_ttm : Optional[float] + Price-to-free cash flow ratio calculated as trailing twelve months. + pb_ratio_ttm : Optional[float] + Price-to-book ratio calculated as trailing twelve months. + ptb_ratio_ttm : Optional[float] + Price-to-tangible book ratio calculated as trailing twelve months. + ev_to_sales_ttm : Optional[float] + Enterprise value-to-sales ratio calculated as trailing twelve months. + enterprise_value_over_ebitda_ttm : Optional[float] + Enterprise value-to-EBITDA ratio calculated as trailing twelve months. + ev_to_operating_cash_flow_ttm : Optional[float] + Enterprise value-to-operating cash flow ratio calculated as trailing twelve months. + ev_to_free_cash_flow_ttm : Optional[float] + Enterprise value-to-free cash flow ratio calculated as trailing twelve months. + earnings_yield_ttm : Optional[float] + Earnings yield calculated as trailing twelve months. + free_cash_flow_yield_ttm : Optional[float] + Free cash flow yield calculated as trailing twelve months. + debt_to_equity_ttm : Optional[float] + Debt-to-equity ratio calculated as trailing twelve months. + debt_to_assets_ttm : Optional[float] + Debt-to-assets ratio calculated as trailing twelve months. + net_debt_to_ebitda_ttm : Optional[float] + Net debt-to-EBITDA ratio calculated as trailing twelve months. + current_ratio_ttm : Optional[float] + Current ratio calculated as trailing twelve months. + interest_coverage_ttm : Optional[float] + Interest coverage calculated as trailing twelve months. + income_quality_ttm : Optional[float] + Income quality calculated as trailing twelve months. + dividend_yield_ttm : Optional[float] + Dividend yield calculated as trailing twelve months. + payout_ratio_ttm : Optional[float] + Payout ratio calculated as trailing twelve months. + sales_general_and_administrative_to_revenue_ttm : Optional[float] + Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months. + research_and_development_to_revenue_ttm : Optional[float] + Research and development expenses-to-revenue ratio calculated as trailing twelve months. + intangibles_to_total_assets_ttm : Optional[float] + Intangibles-to-total assets ratio calculated as trailing twelve months. + capex_to_operating_cash_flow_ttm : Optional[float] + Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months. + capex_to_revenue_ttm : Optional[float] + Capital expenditures-to-revenue ratio calculated as trailing twelve months. + capex_to_depreciation_ttm : Optional[float] + Capital expenditures-to-depreciation ratio calculated as trailing twelve months. + stock_based_compensation_to_revenue_ttm : Optional[float] + Stock-based compensation-to-revenue ratio calculated as trailing twelve months. + graham_number_ttm : Optional[float] + Graham number calculated as trailing twelve months. + roic_ttm : Optional[float] + Return on invested capital calculated as trailing twelve months. + return_on_tangible_assets_ttm : Optional[float] + Return on tangible assets calculated as trailing twelve months. + graham_net_net_ttm : Optional[float] + Graham net-net working capital calculated as trailing twelve months. + working_capital_ttm : Optional[float] + Working capital calculated as trailing twelve months. + tangible_asset_value_ttm : Optional[float] + Tangible asset value calculated as trailing twelve months. + net_current_asset_value_ttm : Optional[float] + Net current asset value calculated as trailing twelve months. + invested_capital_ttm : Optional[float] + Invested capital calculated as trailing twelve months. + average_receivables_ttm : Optional[float] + Average receivables calculated as trailing twelve months. + average_payables_ttm : Optional[float] + Average payables calculated as trailing twelve months. + average_inventory_ttm : Optional[float] + Average inventory calculated as trailing twelve months. + days_sales_outstanding_ttm : Optional[float] + Days sales outstanding calculated as trailing twelve months. + days_payables_outstanding_ttm : Optional[float] + Days payables outstanding calculated as trailing twelve months. + days_of_inventory_on_hand_ttm : Optional[float] + Days of inventory on hand calculated as trailing twelve months. + receivables_turnover_ttm : Optional[float] + Receivables turnover calculated as trailing twelve months. + payables_turnover_ttm : Optional[float] + Payables turnover calculated as trailing twelve months. + inventory_turnover_ttm : Optional[float] + Inventory turnover calculated as trailing twelve months. + roe_ttm : Optional[float] + Return on equity calculated as trailing twelve months. + capex_per_share_ttm : Optional[float] + Capital expenditures per share calculated as trailing twelve months. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + StockMultiples -------------- All fields are standardized.""" diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py index 1dbdff8769e..8474943f413 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_ca.py @@ -8,7 +8,6 @@ from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -18,9 +17,7 @@ class CLASS_stocks_ca(Container): @validate_arguments def peers( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -28,6 +25,52 @@ class CLASS_stocks_ca(Container): """Company peers. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockPeers + ---------- + symbol : str + Symbol representing the entity requested in the data. + peers_list : Optional[List[str]] + A list of stock peers based on sector, exchange and market cap. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + StockPeers + ---------- + All fields are standardized. + + + openbb ====== diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py index 792bc303908..937b90e02bf 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_dd.py @@ -1,12 +1,11 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import typing -from typing import Annotated, Literal, Optional +from typing import Literal, Optional from pydantic import validate_arguments from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -16,122 +15,111 @@ class CLASS_stocks_dd(Container): @validate_arguments def sec( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - type: Annotated[ - Literal[ - "1", - "1-A", - "1-E", - "1-K", - "1-N", - "1-SA", - "1-U", - "1-Z", - "10", - "10-D", - "10-K", - "10-M", - "10-Q", - "11-K", - "12b-25", - "13F", - "13H", - "144", - "15", - "15F", - "17-H", - "18", - "18-K", - "19b-4", - "19b-4(e)", - "19b-7", - "2-E", - "20-F", - "24F-2", - "25", - "3", - "4", - "40-F", - "5", - "6-K", - "7-M", - "8-A", - "8-K", - "8-M", - "9-M", - "ABS-15G", - "ABS-EE", - "ABS DD-15E", - "ADV", - "ADV-E", - "ADV-H", - "ADV-NR", - "ADV-W", - "ATS", - "ATS-N", - "ATS-R", - "BD", - "BD-N", - "BDW", - "C", - "CA-1", - "CB", - "CFPORTAL", - "CRS", - "CUSTODY", - "D", - "F-1", - "F-10", - "F-3", - "F-4", - "F-6", - "F-7", - "F-8", - "F-80", - "F-N", - "F-X", - "ID", - "MA", - "MA-I", - "MA-NR", - "MA-W", - "MSD", - "MSDW", - "N-14", - "N-17D-1", - "N-17f-1", - "N-17f-2", - "N-18f-1", - "N-1A", - "N-2", - "N-23c-3", - "N-27D-1", - "N-3", - "N-4", - "N-5", - "N-54A", - "N-54C", - "N-6", - "N-6EI-1", - "N-6F", - "N-8A", - "N-8B-2", - "N-8B-4", - "N-8F", - "N-CEN", - ], - OpenBBCustomParameter(description="The type of the SEC filing form."), + symbol: str, + type: Literal[ + "1", + "1-A", + "1-E", + "1-K", + "1-N", + "1-SA", + "1-U", + "1-Z", + "10", + "10-D", + "10-K", + "10-M", + "10-Q", + "11-K", + "12b-25", + "13F", + "13H", + "144", + "15", + "15F", + "17-H", + "18", + "18-K", + "19b-4", + "19b-4(e)", + "19b-7", + "2-E", + "20-F", + "24F-2", + "25", + "3", + "4", + "40-F", + "5", + "6-K", + "7-M", + "8-A", + "8-K", + "8-M", + "9-M", + "ABS-15G", + "ABS-EE", + "ABS DD-15E", + "ADV", + "ADV-E", + "ADV-H", + "ADV-NR", + "ADV-W", + "ATS", + "ATS-N", + "ATS-R", + "BD", + "BD-N", + "BDW", + "C", + "CA-1", + "CB", + "CFPORTAL", + "CRS", + "CUSTODY", + "D", + "F-1", + "F-10", + "F-3", + "F-4", + "F-6", + "F-7", + "F-8", + "F-80", + "F-N", + "F-X", + "ID", + "MA", + "MA-I", + "MA-NR", + "MA-W", + "MSD", + "MSDW", + "N-14", + "N-17D-1", + "N-17f-1", + "N-17f-2", + "N-18f-1", + "N-1A", + "N-2", + "N-23c-3", + "N-27D-1", + "N-3", + "N-4", + "N-5", + "N-54A", + "N-54C", + "N-6", + "N-6EI-1", + "N-6F", + "N-8A", + "N-8B-2", + "N-8B-4", + "N-8F", + "N-CEN", ] = "10-K", - page: Annotated[ - Optional[int], - OpenBBCustomParameter(description="Page number of the results."), - ] = 0, - limit: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 100, + page: Optional[int] = 0, + limit: Optional[int] = 100, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -139,6 +127,68 @@ class CLASS_stocks_dd(Container): """SEC Filings. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + type : Literal['1', '1-A', '1-E', '1-K', '1-N', '1-SA', '1-U', '1-Z', '10', '10-D', '10-K', '10-M', '10-Q', '11-K', '12b-25', '13F', '13H', '144', '15', '15F', '17-H', '18', '18-K', '19b-4', '19b-4(e)', '19b-7', '2-E', '20-F', '24F-2', '25', '3', '4', '40-F', '5', '6-K', '7-M', '8-A', '8-K', '8-M', '9-M', 'ABS-15G', 'ABS-EE', 'ABS DD-15E', 'ADV', 'ADV-E', 'ADV-H', 'ADV-NR', 'ADV-W', 'ATS', 'ATS-N', 'ATS-R', 'BD', 'BD-N', 'BDW', 'C', 'CA-1', 'CB', 'CFPORTAL', 'CRS', 'CUSTODY', 'D', 'F-1', 'F-10', 'F-3', 'F-4', 'F-6', 'F-7', 'F-8', 'F-80', 'F-N', 'F-X', 'ID', 'MA', 'MA-I', 'MA-NR', 'MA-W', 'MSD', 'MSDW', 'N-14', 'N-17D-1', 'N-17f-1', 'N-17f-2', 'N-18f-1', 'N-1A', 'N-2', 'N-23c-3', 'N-27D-1', 'N-3', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6EI-1', 'N-6F', 'N-8A', 'N-8B-2', 'N-8B-4', 'N-8F', 'N-CEN'] + The type of the SEC filing form. + page : Optional[int] + Page number of the results. + limit : Optional[int] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + SECFilings + ---------- + symbol : ConstrainedStrValue + Symbol to get data for. + filling_date : datetime + The filling date of the SEC filing. + accepted_date : datetime + The accepted date of the SEC filing. + cik : str + The CIK of the SEC filing. + type : str + The type of the SEC filing. + link : str + The link of the SEC filing. + final_link : str + The final link of the SEC filing. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + SECFilings + ---------- + All fields are standardized. + + + openbb ====== diff --git a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py index 9cf10adfd43..04cf40aae17 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py +++ b/openbb_sdk/sdk/core/openbb_core/app/static/package/stocks_fa.py @@ -2,7 +2,7 @@ import datetime import typing -from typing import Annotated, List, Literal, Optional, Union +from typing import List, Literal, Optional, Union import pydantic from pydantic import validate_arguments @@ -10,7 +10,6 @@ from pydantic import validate_arguments import openbb_core.app.model.command_context import openbb_core.app.model.results.empty from openbb_core.app.model.command_output import CommandOutput -from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.static.container import Container from openbb_core.app.static.filters import filter_call, filter_inputs, filter_output @@ -37,21 +36,11 @@ class CLASS_stocks_fa(Container): @validate_arguments def balance( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["annually", "quarterly"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - limit: Annotated[ - Optional[pydantic.types.NonNegativeInt], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 12, + symbol: str, + period: Literal["annually", "quarterly"] = "annually", + limit: Optional[pydantic.types.NonNegativeInt] = 12, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: """Balance Sheet. @@ -62,7 +51,7 @@ class CLASS_stocks_fa(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -175,6 +164,42 @@ class CLASS_stocks_fa(Container): total_liabilities_and_total_equity : Optional[int] None + fmp + === + + Parameters + ---------- + cik : Optional[str] + None + + + BalanceSheet + ------------ + calendarYear : Optional[int] + None + link : Optional[str] + None + finalLink : Optional[str] + None + cashAndShortTermInvestments : Optional[int] + None + goodwillAndIntangibleAssets : Optional[int] + None + deferredRevenueNonCurrent : Optional[int] + None + totalInvestments : Optional[int] + None + capitalLeaseObligations : Optional[int] + None + deferredTaxLiabilitiesNonCurrent : Optional[int] + None + totalNonCurrentLiabilities : Optional[int] + None + totalDebt : Optional[int] + None + netDebt : Optional[int] + None + polygon ======= @@ -218,6 +243,126 @@ class CLASS_stocks_fa(Container): ------------ All fields are standardized. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['annually', 'quarterly'] + Period of the data to return (quarterly or annually). + limit : Optional[NonNegativeInt] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + BalanceSheet + ------------ + date : date + Date of the fetched statement. + symbol : Optional[str] + Symbol of the company. + cik : Optional[int] + Central Index Key. + currency : Optional[str] + Reporting currency. + filing_date : Optional[date] + Filling date. + accepted_date : Optional[datetime] + Accepted date. + period : Optional[str] + Reporting period of the statement. + cash_and_cash_equivalents : Optional[int] + Cash and cash equivalents + short_term_investments : Optional[int] + Short-term investments + inventory : Optional[int] + Inventory + net_receivables : Optional[int] + Receivables, net + other_current_assets : Optional[int] + Other current assets + current_assets : Optional[int] + Total current assets + long_term_investments : Optional[int] + Long-term investments + property_plant_equipment_net : Optional[int] + Property, plant and equipment, net + goodwill : Optional[int] + Goodwill + intangible_assets : Optional[int] + Intangible assets + other_non_current_assets : Optional[int] + Other non-current assets + tax_assets : Optional[int] + Accrued income taxes + other_assets : Optional[int] + Other assets + noncurrent_assets : Optional[int] + None + assets : Optional[int] + None + account_payables : Optional[int] + None + other_current_liabilities : Optional[int] + None + tax_payables : Optional[int] + Accrued income taxes + deferred_revenue : Optional[int] + Accrued income taxes, other deferred revenue + short_term_debt : Optional[int] + Short-term borrowings, Long-term debt due within one year, Operating lease obligations due within one year, Finance lease obligations due within one year + current_liabilities : Optional[int] + None + long_term_debt : Optional[int] + Long-term debt, Operating lease obligations, Long-term finance lease obligations + other_non_current_liabilities : Optional[int] + Deferred income taxes and other + other_liabilities : Optional[int] + None + noncurrent_liabilities : Optional[int] + None + liabilities : Optional[int] + None + common_stock : Optional[int] + None + other_stockholder_equity : Optional[int] + Capital in excess of par value + accumulated_other_comprehensive_income_loss : Optional[int] + Accumulated other comprehensive income (loss) + preferred_stock : Optional[int] + Preferred stock + retained_earnings : Optional[int] + Retained earnings + minority_interest : Optional[int] + Minority interest + total_stockholders_equity : Optional[int] + None + total_equity : Optional[int] + None + total_liabilities_and_stockholders_equity : Optional[int] + None + total_liabilities_and_total_equity : Optional[int] + None + fmp === @@ -252,7 +397,50 @@ class CLASS_stocks_fa(Container): totalDebt : Optional[int] None netDebt : Optional[int] - None""" + None + + polygon + ======= + + Parameters + ---------- + company_name : Optional[str] + The name of the company. + company_name_search : Optional[str] + The name of the company to search. + sic : Optional[str] + The Standard Industrial Classification (SIC) of the company. + filing_date : Optional[date] + The filing date of the financial statement. + filing_date_lt : Optional[date] + The filing date less than the given date. + filing_date_lte : Optional[date] + The filing date less than or equal to the given date. + filing_date_gt : Optional[date] + The filing date greater than the given date. + filing_date_gte : Optional[date] + The filing date greater than or equal to the given date. + period_of_report_date : Optional[date] + The period of report date of the financial statement. + period_of_report_date_lt : Optional[date] + The period of report date less than the given date. + period_of_report_date_lte : Optional[date] + The period of report date less than or equal to the given date. + period_of_report_date_gt : Optional[date] + The period of report date greater than the given date. + period_of_report_date_gte : Optional[date] + The period of report date greater than or equal to the given date. + include_sources : Optional[bool] + Whether to include the sources of the financial statement. + order : Optional[Literal['asc', 'desc']] + The order of the financial statement. + sort : Optional[Literal['filing_date', 'period_of_report_date']] + The sort of the financial statement. + + + BalanceSheet + ------------ + All fields are standardized.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -277,13 +465,8 @@ class CLASS_stocks_fa(Container): @validate_arguments def balance_growth( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - limit: typing.Annotated[ - int, - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 10, + symbol: str, + limit: int = 10, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -413,6 +596,134 @@ class CLASS_stocks_fa(Container): All fields are standardized. + BalanceSheetGrowth + ------------------ + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + limit : int + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + BalanceSheetGrowth + ------------------ + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + period : str + The period the statement is returned for. + growth_cash_and_cash_equivalents : float + Growth rate of cash and cash equivalents. + growth_short_term_investments : float + Growth rate of short-term investments. + growth_cash_and_short_term_investments : float + Growth rate of cash and short-term investments. + growth_net_receivables : float + Growth rate of net receivables. + growth_inventory : float + Growth rate of inventory. + growth_other_current_assets : float + Growth rate of other current assets. + growth_total_current_assets : float + Growth rate of total current assets. + growth_property_plant_equipment_net : float + Growth rate of net property, plant, and equipment. + growth_goodwill : float + Growth rate of goodwill. + growth_intangible_assets : float + Growth rate of intangible assets. + growth_goodwill_and_intangible_assets : float + Growth rate of goodwill and intangible assets. + growth_long_term_investments : float + Growth rate of long-term investments. + growth_tax_assets : float + Growth rate of tax assets. + growth_other_non_current_assets : float + Growth rate of other non-current assets. + growth_total_non_current_assets : float + Growth rate of total non-current assets. + growth_other_assets : float + Growth rate of other assets. + growth_total_assets : float + Growth rate of total assets. + growth_account_payables : float + Growth rate of accounts payable. + growth_short_term_debt : float + Growth rate of short-term debt. + growth_tax_payables : float + Growth rate of tax payables. + growth_deferred_revenue : float + Growth rate of deferred revenue. + growth_other_current_liabilities : float + Growth rate of other current liabilities. + growth_total_current_liabilities : float + Growth rate of total current liabilities. + growth_long_term_debt : float + Growth rate of long-term debt. + growth_deferred_revenue_non_current : float + Growth rate of non-current deferred revenue. + growth_deferrred_tax_liabilities_non_current : float + Growth rate of non-current deferred tax liabilities. + growth_other_non_current_liabilities : float + Growth rate of other non-current liabilities. + growth_total_non_current_liabilities : float + Growth rate of total non-current liabilities. + growth_other_liabilities : float + Growth rate of other liabilities. + growth_total_liabilities : float + Growth rate of total liabilities. + growth_common_stock : float + Growth rate of common stock. + growth_retained_earnings : float + Growth rate of retained earnings. + growth_accumulated_other_comprehensive_income_loss : float + Growth rate of accumulated other comprehensive income/loss. + growth_othertotal_stockholders_equity : float + Growth rate of other total stockholders' equity. + growth_total_stockholders_equity : float + Growth rate of total stockholders' equity. + growth_total_liabilities_and_stockholders_equity : float + Growth rate of total liabilities and stockholders' equity. + growth_total_investments : float + Growth rate of total investments. + growth_total_debt : float + Growth rate of total debt. + growth_net_debt : float + Growth rate of net debt. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + BalanceSheetGrowth ------------------ All fields are standardized.""" @@ -439,18 +750,8 @@ class CLASS_stocks_fa(Container): @validate_arguments def cal( self, - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -458,6 +759,66 @@ class CLASS_stocks_fa(Container): """Show Dividend Calendar for a given start and end dates. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + DividendCalendar + ---------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + label : str + The date in human readable form in the calendar. + adj_dividend : Optional[NonNegativeFloat] + The adjusted dividend on a date in the calendar. + dividend : Optional[NonNegativeFloat] + The dividend amount in the calendar. + record_date : Optional[date] + The record date of the dividend in the calendar. + payment_date : Optional[date] + The payment date of the dividend in the calendar. + declaration_date : Optional[date] + The declaration date of the dividend in the calendar. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + DividendCalendar + ---------------- + All fields are standardized. + + + openbb ====== @@ -538,21 +899,11 @@ class CLASS_stocks_fa(Container): @validate_arguments def cash( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["annually", "quarterly"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - limit: Annotated[ - Optional[pydantic.types.NonNegativeInt], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 12, + symbol: str, + period: Literal["annually", "quarterly"] = "annually", + limit: Optional[pydantic.types.NonNegativeInt] = 12, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: """Cash Flow Statement. @@ -563,7 +914,7 @@ class CLASS_stocks_fa(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -656,6 +1007,24 @@ class CLASS_stocks_fa(Container): cash_at_end_of_period : Optional[int] None + fmp + === + + Parameters + ---------- + cik : Optional[str] + Central Index Key (CIK) of the company. + + + CashFlowStatement + ----------------- + calendarYear : Optional[int] + None + link : Optional[str] + None + finalLink : Optional[str] + None + polygon ======= @@ -699,6 +1068,106 @@ class CLASS_stocks_fa(Container): ----------------- All fields are standardized. + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['annually', 'quarterly'] + Period of the data to return (quarterly or annually). + limit : Optional[NonNegativeInt] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + CashFlowStatement + ----------------- + date : date + Date of the fetched statement. + symbol : Optional[str] + Symbol of the company. + cik : Optional[int] + Central Index Key. + currency : Optional[str] + Reporting currency. + filing_date : Optional[date] + Filling date. + accepted_date : Optional[datetime] + Accepted date. + period : Optional[str] + Reporting period of the statement. + cash_at_beginning_of_period : Optional[int] + None + net_income : Optional[int] + None + depreciation_and_amortization : Optional[int] + None + stock_based_compensation : Optional[int] + None + other_non_cash_items : Optional[int] + Other non-cash items. + deferred_income_tax : Optional[int] + Deferred income tax. + inventory : Optional[int] + None + accounts_receivables : Optional[int] + None + accounts_payables : Optional[int] + None + other_working_capital : Optional[int] + Accrued expenses and other, Unearned revenue. + net_cash_flow_from_operating_activities : Optional[int] + None + capital_expenditure : Optional[int] + Purchases of property and equipment. + other_investing_activities : Optional[int] + Proceeds from property and equipment sales and incentives. + acquisitions_net : Optional[int] + Acquisitions, net of cash acquired, and other + sales_maturities_of_investments : Optional[int] + None + purchases_of_investments : Optional[int] + None + net_cash_flow_from_investing_activities : Optional[int] + None + investments_in_property_plant_and_equipment : Optional[int] + None + dividends_paid : Optional[int] + None + common_stock_repurchased : Optional[int] + None + debt_repayment : Optional[int] + None + other_financing_activities : Optional[int] + None + net_cash_flow_from_financing_activities : Optional[int] + None + effect_of_forex_changes_on_cash : Optional[int] + Foreign currency effect on cash, cash equivalents, and restricted cash + net_change_in_cash : Optional[int] + Net increase (decrease) in cash, cash equivalents, and restricted cash + cash_at_end_of_period : Optional[int] + None + fmp === @@ -715,7 +1184,50 @@ class CLASS_stocks_fa(Container): link : Optional[str] None finalLink : Optional[str] - None""" + None + + polygon + ======= + + Parameters + ---------- + company_name : Optional[str] + The name of the company. + company_name_search : Optional[str] + The name of the company to search. + sic : Optional[str] + The Standard Industrial Classification (SIC) of the company. + filing_date : Optional[date] + The filing date of the financial statement. + filing_date_lt : Optional[date] + The filing date less than the given date. + filing_date_lte : Optional[date] + The filing date less than or equal to the given date. + filing_date_gt : Optional[date] + The filing date greater than the given date. + filing_date_gte : Optional[date] + The filing date greater than or equal to the given date. + period_of_report_date : Optional[date] + The period of report date of the financial statement. + period_of_report_date_lt : Optional[date] + The period of report date less than the given date. + period_of_report_date_lte : Optional[date] + The period of report date less than or equal to the given date. + period_of_report_date_gt : Optional[date] + The period of report date greater than the given date. + period_of_report_date_gte : Optional[date] + The period of report date greater than or equal to the given date. + include_sources : Optional[bool] + Whether to include the sources of the financial statement. + order : Optional[Literal['asc', 'desc']] + The order of the financial statement. + sort : Optional[Literal['filing_date', 'period_of_report_date']] + The sort of the financial statement. + + + CashFlowStatement + ----------------- + All fields are standardized.""" inputs = filter_inputs( provider_choices={ "provider": provider, @@ -740,13 +1252,8 @@ class CLASS_stocks_fa(Container): @validate_arguments def cash_growth( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - limit: typing.Annotated[ - int, - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 10, + symbol: str, + limit: int = 10, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -858,6 +1365,116 @@ class CLASS_stocks_fa(Container): All fields are standardized. + CashFlowStatementGrowth + ----------------------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + limit : int + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + CashFlowStatementGrowth + ----------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + period : str + The period the statement is returned for. + growth_net_income : float + Growth rate of net income. + growth_depreciation_and_amortization : float + Growth rate of depreciation and amortization. + growth_deferred_income_tax : float + Growth rate of deferred income tax. + growth_stock_based_compensation : float + Growth rate of stock-based compensation. + growth_change_in_working_capital : float + Growth rate of change in working capital. + growth_accounts_receivables : float + Growth rate of accounts receivables. + growth_inventory : float + Growth rate of inventory. + growth_accounts_payables : float + Growth rate of accounts payables. + growth_other_working_capital : float + Growth rate of other working capital. + growth_other_non_cash_items : float + Growth rate of other non-cash items. + growth_net_cash_provided_by_operating_activities : float + Growth rate of net cash provided by operating activities. + growth_investments_in_property_plant_and_equipment : float + Growth rate of investments in property, plant, and equipment. + growth_acquisitions_net : float + Growth rate of net acquisitions. + growth_purchases_of_investments : float + Growth rate of purchases of investments. + growth_sales_maturities_of_investments : float + Growth rate of sales maturities of investments. + growth_other_investing_activities : float + Growth rate of other investing activities. + growth_net_cash_used_for_investing_activities : float + Growth rate of net cash used for investing activities. + growth_debt_repayment : float + Growth rate of debt repayment. + growth_common_stock_issued : float + Growth rate of common stock issued. + growth_common_stock_repurchased : float + Growth rate of common stock repurchased. + growth_dividends_paid : float + Growth rate of dividends paid. + growth_other_financing_activities : float + Growth rate of other financing activities. + growth_net_cash_used_provided_by_financing_activities : float + Growth rate of net cash used/provided by financing activities. + growth_effect_of_forex_changes_on_cash : float + Growth rate of the effect of foreign exchange changes on cash. + growth_net_change_in_cash : float + Growth rate of net change in cash. + growth_cash_at_end_of_period : float + Growth rate of cash at the end of the period. + growth_cash_at_beginning_of_period : float + Growth rate of cash at the beginning of the period. + growth_operating_cash_flow : float + Growth rate of operating cash flow. + growth_capital_expenditure : float + Growth rate of capital expenditure. + growth_free_cash_flow : float + Growth rate of free cash flow. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + CashFlowStatementGrowth ----------------------- All fields are standardized.""" @@ -884,9 +1501,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def comp( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -894,6 +1509,74 @@ class CLASS_stocks_fa(Container): """Executive Compensation. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + ExecutiveCompensation + --------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + cik : Optional[str] + The Central Index Key (CIK) of the company. + filing_date : date + The date of the filing. + accepted_date : datetime + The date the filing was accepted. + name_and_position : str + The name and position of the executive. + year : int + The year of the compensation. + salary : PositiveFloat + The salary of the executive. + bonus : NonNegativeFloat + The bonus of the executive. + stock_award : NonNegativeFloat + The stock award of the executive. + incentive_plan_compensation : NonNegativeFloat + The incentive plan compensation of the executive. + all_other_compensation : NonNegativeFloat + The all other compensation of the executive. + total : PositiveFloat + The total compensation of the executive. + url : str + The URL of the filing data. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + ExecutiveCompensation + --------------------- + All fields are standardized. + + + openbb ====== @@ -981,18 +1664,8 @@ class CLASS_stocks_fa(Container): @validate_arguments def comsplit( self, - start_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="Start date of the data, in YYYY-MM-DD format." - ), - ] = None, - end_date: Annotated[ - Union[datetime.date, None, str], - OpenBBCustomParameter( - description="End date of the data, in YYYY-MM-DD format." - ), - ] = None, + start_date: Union[datetime.date, None, str] = None, + end_date: Union[datetime.date, None, str] = None, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1000,6 +1673,60 @@ class CLASS_stocks_fa(Container): """Stock Split Calendar. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. + end_date : Optional[date] + End date of the data, in YYYY-MM-DD format. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockSplitCalendar + ------------------ + date : date + The date of the stock splits. + label : str + The label of the stock splits. + symbol : str + The symbol of the company. + numerator : float + The numerator of the stock splits. + denominator : float + The denominator of the stock splits. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + StockSplitCalendar + ------------------ + All fields are standardized. + + + openbb ====== @@ -1108,9 +1835,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def divs( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1118,6 +1843,62 @@ class CLASS_stocks_fa(Container): """Historical Dividends. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + HistoricalDividends + ------------------- + date : date + The date of the historical dividends. + label : str + The label of the historical dividends. + adj_dividend : float + The adjusted dividend of the historical dividends. + dividend : float + The dividend of the historical dividends. + record_date : Optional[date] + The record date of the historical dividends. + payment_date : Optional[date] + The payment date of the historical dividends. + declaration_date : Optional[date] + The declaration date of the historical dividends. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + HistoricalDividends + ------------------- + All fields are standardized. + + + openbb ====== @@ -1210,13 +1991,8 @@ class CLASS_stocks_fa(Container): @validate_arguments def earning( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - limit: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 50, + symbol: str, + limit: Optional[int] = 50, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1224,6 +2000,68 @@ class CLASS_stocks_fa(Container): """Earnings Calendar. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + limit : Optional[int] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + EarningsCalendar + ---------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + eps : Optional[NonNegativeFloat] + The EPS of the earnings calendar. + eps_estimated : Optional[NonNegativeFloat] + The estimated EPS of the earnings calendar. + time : str + The time of the earnings calendar. + revenue : Optional[int] + The revenue of the earnings calendar. + revenue_estimated : Optional[int] + The estimated revenue of the earnings calendar. + updated_from_date : Optional[date] + The updated from date of the earnings calendar. + fiscal_date_ending : date + The fiscal date ending of the earnings calendar. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + EarningsCalendar + ---------------- + All fields are standardized. + + + openbb ====== @@ -1306,9 +2144,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def emp( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1316,6 +2152,66 @@ class CLASS_stocks_fa(Container): """Number of Employees. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + HistoricalEmployees + ------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + cik : int + The CIK of the company to retrieve the historical employees of. + acceptance_time : datetime + The time of acceptance of the company employee. + period_of_report : date + The date of reporting of the company employee. + company_name : str + The registered name of the company to retrieve the historical employees of. + form_type : str + The form type of the company employee. + filing_date : date + The filing date of the company employee + employee_count : int + The count of employees of the company. + source : str + The source URL which retrieves this data for the company. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + HistoricalEmployees + ------------------- + All fields are standardized. + + + openbb ====== @@ -1429,19 +2325,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def est( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["quarterly", "annually"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - limit: typing.Annotated[ - int, - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 30, + symbol: str, + period: Literal["quarterly", "annually"] = "annually", + limit: int = 30, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1449,6 +2335,96 @@ class CLASS_stocks_fa(Container): """Analyst Estimates. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['quarterly', 'annually'] + Period of the data to return (quarterly or annually). + limit : int + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + AnalystEstimates + ---------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + A specific date to get data for. + estimated_revenue_low : int + The estimated revenue low. + estimated_revenue_high : int + The estimated revenue high. + estimated_revenue_avg : int + The estimated revenue average. + estimated_ebitda_low : int + The estimated EBITDA low. + estimated_ebitda_high : int + The estimated EBITDA high. + estimated_ebitda_avg : int + The estimated EBITDA average. + estimated_ebit_low : int + The estimated EBIT low. + estimated_ebit_high : int + The estimated EBIT high. + estimated_ebit_avg : int + The estimated EBIT average. + estimated_net_income_low : int + The estimated net income low. + estimated_net_income_high : int + The estimated net income high. + estimated_net_income_avg : int + The estimated net income average. + estimated_sga_expense_low : int + The estimated SGA expense low. + estimated_sga_expense_high : int + The estimated SGA expense high. + estimated_sga_expense_avg : int + The estimated SGA expense average. + estimated_eps_avg : float + The estimated EPS average. + estimated_eps_high : float + The estimated EPS high. + estimated_eps_low : float + The estimated EPS low. + number_analyst_estimated_revenue : int + The number of analysts who estimated revenue. + number_analysts_estimated_eps : int + The number of analysts who estimated EPS. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + AnalystEstimates + ---------------- + All fields are standardized. + + + openbb ====== @@ -1644,21 +2620,11 @@ class CLASS_stocks_fa(Container): @validate_arguments def income( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["annually", "quarterly"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - limit: Annotated[ - Optional[pydantic.types.NonNegativeInt], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 12, + symbol: str, + period: Literal["annually", "quarterly"] = "annually", + limit: Optional[pydantic.types.NonNegativeInt] = 12, chart: bool = False, - provider: Optional[Literal["polygon", "fmp"]] = None, + provider: Optional[Literal["fmp", "polygon"]] = None, **kwargs ) -> CommandOutput[typing.List]: """Income Statement. @@ -1669,7 +2635,7 @@ class CLASS_stocks_fa(Container): Parameters ---------- - provider: Literal[polygon, fmp] + provider: Literal[fmp, polygon] The provider to use for the query. symbol : ConstrainedStrValue Symbol to get data for. @@ -1754,6 +2720,34 @@ class CLASS_stocks_fa(Container): weighted_average_shares_outstanding_dil : Optional[int] Weighted average shares outstanding diluted. + fmp + === + + Parameters + ---------- + cik : Optional[str] + The CIK of the company if no symbol is provided. + + + IncomeStatement + --------------- + calendarYear : Optional[int] + None + grossProfitRatio : Optional[float] + None + ebitdaratio : Optional[float] + None + operatingIncomeRatio : Optional[float] + None + incomeBeforeTaxRatio : Optional[float] + None + netIncomeRatio : Optional[float] + None + link : Optional[str] + None + finalLink : Optional[str] + None + polygon ======= @@ -1810,6 +2804,98 @@ class CLASS_stocks_fa(Container): preferred_stock_dividends_and_other_adjustments : Optional[float] None + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp, polygon] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['annually', 'quarterly'] + Period of the data to return (quarterly or annually). + limit : Optional[NonNegativeInt] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + IncomeStatement + --------------- + date : date + Date of the income statement. + symbol : str + Symbol of the company. + cik : Optional[int] + Central Index Key. + currency : Optional[str] + Reporting currency. + filing_date : Optional[date] + Filling date. + accepted_date : Optional[datetime] + Accepted date. + period : Optional[str] + Period of the income statement. + revenue : Optional[int] + Revenue. + cost_of_revenue : Optional[int] + Cost of revenue. + gross_profit : Optional[int] + Gross profit. + research_and_development_expenses : Optional[int] + Research and development expenses. + general_and_administrative_expenses : Optional[int] + General and administrative expenses. + selling_and_marketing_expenses : Optional[float] + Selling and marketing expenses. + selling_general_and_administrative_expenses : Optional[int] + Selling, general and administrative expenses. + other_expenses : Optional[int] + Other expenses. + operating_expenses : Optional[int] + Operating expenses. + depreciation_and_amortization : Optional[int] + Depreciation and amortization. + ebitda : Optional[int] + Earnings before interest, taxes, depreciation and amortization. + operating_income : Optional[int] + Operating income. + interest_income : Optional[int] + Interest income. + interest_expense : Optional[int] + Interest expense. + total_other_income_expenses_net : Optional[int] + Total other income expenses net. + income_before_tax : Optional[int] + Income before tax. + income_tax_expense : Optional[int] + Income tax expense. + net_income : Optional[int] + Net income. + eps : Optional[float] + Earnings per share. + eps_diluted : Optional[float] + Earnings per share diluted. + weighted_average_shares_outstanding : Optional[int] + Weighted average shares outstanding. + weighted_average_shares_outstanding_dil : Optional[int] + Weighted average shares outstanding diluted. + fmp === @@ -1836,6 +2922,62 @@ class CLASS_stocks_fa(Container): link : Optional[str] None finalLink : Optional[str] + None + + polygon + ======= + + Parameters + ---------- + company_name : Optional[str] + The name of the company. + company_name_search : Optional[str] + The name of the company to search. + sic : Optional[str] + The Standard Industrial Classification (SIC) of the company. + filing_date : Optional[date] + The filing date of the financial statement. + filing_date_lt : Optional[date] + The filing date less than the given date. + filing_date_lte : Optional[date] + The filing date less than or equal to the given date. + filing_date_gt : Optional[date] + The filing date greater than the given date. + filing_date_gte : Optional[date] + The filing date greater than or equal to the given date. + period_of_report_date : Optional[date] + The period of report date of the financial statement. + period_of_report_date_lt : Optional[date] + The period of report date less than the given date. + period_of_report_date_lte : Optional[date] + The period of report date less than or equal to the given date. + period_of_report_date_gt : Optional[date] + The period of report date greater than the given date. + period_of_report_date_gte : Optional[date] + The period of report date greater than or equal to the given date. + include_sources : Optional[bool] + Whether to include the sources of the financial statement. + order : Optional[Literal['asc', 'desc']] + The order of the financial statement. + sort : Optional[Literal['filing_date', 'period_of_report_date']] + The sort of the financial statement. + + + IncomeStatement + --------------- + income_loss_from_continuing_operations_after_tax : Optional[float] + None + benefits_costs_expenses : Optional[float] + None + net_income_loss_attributable_to_noncontrolling_interest : Optional[int] + None + net_income_loss_attributable_to_parent : Optional[float] + None + net_income_loss_available_to_common_stockholders_basic : Optional[float] + None + participating_securities_distributed_and_undistributed_earnings_loss_basic : Optional[float] + None + preferred_stock_dividends_and_other_adjustments : Optional[float] None""" inputs = filter_inputs( provider_choices={ @@ -1861,19 +3003,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def income_growth( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - limit: typing.Annotated[ - int, - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 10, - period: Annotated[ - Literal["annually", "quarterly"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", + symbol: str, + limit: int = 10, + period: Literal["annually", "quarterly"] = "annually", chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -1881,6 +3013,110 @@ class CLASS_stocks_fa(Container): """Income Statement Growth. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + limit : int + The number of data entries to return. + period : Literal['annually', 'quarterly'] + Period of the data to return (quarterly or annually). + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + IncomeStatementGrowth + --------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + period : str + The period the statement is returned for. + growth_revenue : float + Growth rate of total revenue. + growth_cost_of_revenue : float + Growth rate of cost of goods sold. + growth_gross_profit : float + Growth rate of gross profit. + growth_gross_profit_ratio : float + Growth rate of gross profit as a percentage of revenue. + growth_research_and_development_expenses : float + Growth rate of expenses on research and development. + growth_general_and_administrative_expenses : float + Growth rate of general and administrative expenses. + growth_selling_and_marketing_expenses : float + Growth rate of expenses on selling and marketing activities. + growth_other_expenses : float + Growth rate of other operating expenses. + growth_operating_expenses : float + Growth rate of total operating expenses. + growth_cost_and_expenses : float + Growth rate of total costs and expenses. + growth_interest_expense : float + Growth rate of interest expenses. + growth_depreciation_and_amortization : float + Growth rate of depreciation and amortization expenses. + growth_ebitda : float + Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. + growth_ebitda_ratio : float + Growth rate of EBITDA as a percentage of revenue. + growth_operating_income : float + Growth rate of operating income. + growth_operating_income_ratio : float + Growth rate of operating income as a percentage of revenue. + growth_total_other_income_expenses_net : float + Growth rate of net total other income and expenses. + growth_income_before_tax : float + Growth rate of income before taxes. + growth_income_before_tax_ratio : float + Growth rate of income before taxes as a percentage of revenue. + growth_income_tax_expense : float + Growth rate of income tax expenses. + growth_net_income : float + Growth rate of net income. + growth_net_income_ratio : float + Growth rate of net income as a percentage of revenue. + growth_eps : float + Growth rate of Earnings Per Share (EPS). + growth_eps_diluted : float + Growth rate of diluted Earnings Per Share (EPS). + growth_weighted_average_shs_out : float + Growth rate of weighted average shares outstanding. + growth_weighted_average_shs_out_dil : float + Growth rate of diluted weighted average shares outstanding. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + IncomeStatementGrowth + --------------------- + All fields are standardized. + + + openbb ====== @@ -2006,48 +3242,34 @@ class CLASS_stocks_fa(Container): @validate_arguments def ins( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - transactionType: Annotated[ - Optional[ - List[ - Literal[ - "A-Award", - "C-Conversion", - "D-Return", - "E-ExpireShort", - "F-InKind", - "G-Gift", - "H-ExpireLong", - "I-Discretionary", - "J-Other", - "L-Small", - "M-Exempt", - "O-OutOfTheMoney", - "P-Purchase", - "S-Sale", - "U-Tender", - "W-Will", - "X-InTheMoney", - "Z-Trust", - ] + symbol: str, + transactionType: Optional[ + List[ + Literal[ + "A-Award", + "C-Conversion", + "D-Return", + "E-ExpireShort", + "F-InKind", + "G-Gift", + "H-ExpireLong", + "I-Discretionary", + "J-Other", + "L-Small", + "M-Exempt", + "O-OutOfTheMoney", + "P-Purchase", + "S-Sale", + "U-Tender", + "W-Will", + "X-InTheMoney", + "Z-Trust", ] - ], - OpenBBCustomParameter(description="The type of the transaction."), + ] ] = ["P-Purchase"], - reportingCik: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The CIK of the reporting owner."), - ] = None, - companyCik: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The CIK of the company owner."), - ] = None, - page: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The page number of the data to fetch."), - ] = 0, + reportingCik: Optional[int] = None, + companyCik: Optional[int] = None, + page: Optional[int] = 0, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2055,6 +3277,86 @@ class CLASS_stocks_fa(Container): """Stock Insider Trading. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + transactionType : Optional[List[Literal['A-Award', 'C-Conversion', 'D-Return', 'E-ExpireShort', 'F-InKind', 'G-Gift', 'H-ExpireLong', 'I-Discretionary', 'J-Other', 'L-Small', 'M-Exempt', 'O-OutOfTheMoney', 'P-Purchase', 'S-Sale', 'U-Tender', 'W-Will', 'X-InTheMoney', 'Z-Trust']]] + The type of the transaction. + reportingCik : Optional[int] + The CIK of the reporting owner. + companyCik : Optional[int] + The CIK of the company owner. + page : Optional[int] + The page number of the data to fetch. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockInsiderTrading + ------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + filing_date : datetime + The filing date of the stock insider trading. + transaction_date : date + The transaction date of the stock insider trading. + reporting_cik : int + The reporting CIK of the stock insider trading. + transaction_type : str + The transaction type of the stock insider trading. + securities_owned : int + The securities owned of the stock insider trading. + company_cik : int + The company CIK of the stock insider trading. + reporting_name : str + The reporting name of the stock insider trading. + type_of_owner : str + The type of owner of the stock insider trading. + acquistion_or_disposition : str + The acquistion or disposition of the stock insider trading. + form_type : str + The form type of the stock insider trading. + securities_transacted : float + The securities transacted of the stock insider trading. + price : float + The price of the stock insider trading. + security_name : str + The security name of the stock insider trading. + link : str + The link of the stock insider trading. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + StockInsiderTrading + ------------------- + All fields are standardized. + + + openbb ====== @@ -2158,16 +3460,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def ins_own( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - include_current_quarter: typing.Annotated[ - bool, OpenBBCustomParameter(description="Include current quarter data.") - ] = False, - date: Annotated[ - Optional[datetime.date], - OpenBBCustomParameter(description="A specific date to get data for."), - ] = None, + symbol: str, + include_current_quarter: bool = False, + date: Optional[datetime.date] = None, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2287,6 +3582,124 @@ class CLASS_stocks_fa(Container): All fields are standardized. + InstitutionalOwnership + ---------------------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + include_current_quarter : bool + Include current quarter data. + date : Optional[date] + A specific date to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + InstitutionalOwnership + ---------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + cik : Optional[str] + The CIK of the company. + date : date + The date of the data. + investors_holding : int + The number of investors holding the stock. + last_investors_holding : int + The number of investors holding the stock in the last quarter. + investors_holding_change : int + The change in the number of investors holding the stock. + number_of_13f_shares : Optional[int] + The number of 13F shares. + last_number_of_13f_shares : Optional[int] + The number of 13F shares in the last quarter. + number_of_13f_shares_change : Optional[int] + The change in the number of 13F shares. + total_invested : float + The total amount invested. + last_total_invested : float + The total amount invested in the last quarter. + total_invested_change : float + The change in the total amount invested. + ownership_percent : float + The ownership percent. + last_ownership_percent : float + The ownership percent in the last quarter. + ownership_percent_change : float + The change in the ownership percent. + new_positions : int + The number of new positions. + last_new_positions : int + The number of new positions in the last quarter. + new_positions_change : int + he change in the number of new positions. + increased_positions : int + The number of increased positions. + last_increased_positions : int + The number of increased positions in the last quarter. + increased_positions_change : int + The change in the number of increased positions. + closed_positions : int + The number of closed positions. + last_closed_positions : int + The number of closed positions in the last quarter. + closed_positions_change : int + The change in the number of closed positions. + reduced_positions : int + The number of reduced positions. + last_reduced_positions : int + The number of reduced positions in the last quarter. + reduced_positions_change : int + The change in the number of reduced positions. + total_calls : int + Total number of call options contracts traded for Apple Inc. on the specified date. + last_total_calls : int + Total number of call options contracts traded for Apple Inc. on the previous reporting date. + total_calls_change : int + Change in the total number of call options contracts traded between the current and previous reporting dates. + total_puts : int + Total number of put options contracts traded for Apple Inc. on the specified date. + last_total_puts : int + Total number of put options contracts traded for Apple Inc. on the previous reporting date. + total_puts_change : int + Change in the total number of put options contracts traded between the current and previous reporting dates. + put_call_ratio : float + The put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. + last_put_call_ratio : float + The put-call ratio on the previous reporting date. + put_call_ratio_change : float + Change in the put-call ratio between the current and previous reporting dates. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + InstitutionalOwnership ---------------------- All fields are standardized.""" @@ -2330,19 +3743,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def metrics( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["annually", "quarterly"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - limit: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The number of data entries to return."), - ] = 100, + symbol: str, + period: Literal["annually", "quarterly"] = "annually", + limit: Optional[int] = 100, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2510,6 +3913,172 @@ class CLASS_stocks_fa(Container): All fields are standardized. + KeyMetrics + ---------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['annually', 'quarterly'] + Period of the data to return (quarterly or annually). + limit : Optional[int] + The number of data entries to return. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + KeyMetrics + ---------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + The date of the data. + period : str + The period of the data. + revenue_per_share : Optional[float] + Revenue per share + net_income_per_share : Optional[float] + Net income per share + operating_cash_flow_per_share : Optional[float] + Operating cash flow per share + free_cash_flow_per_share : Optional[float] + Free cash flow per share + cash_per_share : Optional[float] + Cash per share + book_value_per_share : Optional[float] + Book value per share + tangible_book_value_per_share : Optional[float] + Tangible book value per share + shareholders_equity_per_share : Optional[float] + Shareholders equity per share + interest_debt_per_share : Optional[float] + Interest debt per share + market_cap : Optional[float] + Market capitalization + enterprise_value : Optional[float] + Enterprise value + pe_ratio : Optional[float] + Price-to-earnings ratio (P/E ratio) + price_to_sales_ratio : Optional[float] + Price-to-sales ratio + pocf_ratio : Optional[float] + Price-to-operating cash flow ratio + pfcf_ratio : Optional[float] + Price-to-free cash flow ratio + pb_ratio : Optional[float] + Price-to-book ratio + ptb_ratio : Optional[float] + Price-to-tangible book ratio + ev_to_sales : Optional[float] + Enterprise value-to-sales ratio + enterprise_value_over_ebitda : Optional[float] + Enterprise value-to-EBITDA ratio + ev_to_operating_cash_flow : Optional[float] + Enterprise value-to-operating cash flow ratio + ev_to_free_cash_flow : Optional[float] + Enterprise value-to-free cash flow ratio + earnings_yield : Optional[float] + Earnings yield + free_cash_flow_yield : Optional[float] + Free cash flow yield + debt_to_equity : Optional[float] + Debt-to-equity ratio + debt_to_assets : Optional[float] + Debt-to-assets ratio + net_debt_to_ebitda : Optional[float] + Net debt-to-EBITDA ratio + current_ratio : Optional[float] + Current ratio + interest_coverage : Optional[float] + Interest coverage + income_quality : Optional[float] + Income quality + dividend_yield : Optional[float] + Dividend yield + payout_ratio : Optional[float] + Payout ratio + sales_general_and_administrative_to_revenue : Optional[float] + Sales general and administrative expenses-to-revenue ratio + research_and_development_to_revenue : Optional[float] + Research and development expenses-to-revenue ratio + intangibles_to_total_assets : Optional[float] + Intangibles-to-total assets ratio + capex_to_operating_cash_flow : Optional[float] + Capital expenditures-to-operating cash flow ratio + capex_to_revenue : Optional[float] + Capital expenditures-to-revenue ratio + capex_to_depreciation : Optional[float] + Capital expenditures-to-depreciation ratio + stock_based_compensation_to_revenue : Optional[float] + Stock-based compensation-to-revenue ratio + graham_number : Optional[float] + Graham number + roic : Optional[float] + Return on invested capital + return_on_tangible_assets : Optional[float] + Return on tangible assets + graham_net_net : Optional[float] + Graham net-net working capital + working_capital : Optional[float] + Working capital + tangible_asset_value : Optional[float] + Tangible asset value + net_current_asset_value : Optional[float] + Net current asset value + invested_capital : Optional[float] + Invested capital + average_receivables : Optional[float] + Average receivables + average_payables : Optional[float] + Average payables + average_inventory : Optional[float] + Average inventory + days_sales_outstanding : Optional[float] + Days sales outstanding + days_payables_outstanding : Optional[float] + Days payables outstanding + days_of_inventory_on_hand : Optional[float] + Days of inventory on hand + receivables_turnover : Optional[float] + Receivables turnover + payables_turnover : Optional[float] + Payables turnover + inventory_turnover : Optional[float] + Inventory turnover + roe : Optional[float] + Return on equity + capex_per_share : Optional[float] + Capital expenditures per share + + fmp + === + + Parameters + ---------- + All fields are standardized. + + KeyMetrics ---------- All fields are standardized.""" @@ -2537,9 +4106,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def mgmt( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2547,6 +4114,62 @@ class CLASS_stocks_fa(Container): """Key Executives. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + KeyExecutives + ------------- + title : str + Designation of the key executive. + name : str + Name of the key executive. + pay : Optional[int] + Pay of the key executive. + currency_pay : str + The currency of the pay. + gender : Optional[str] + Gender of the key executive. + year_born : Optional[str] + Birth year of the key executive. + title_since : Optional[int] + Date the tile was held since. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + KeyExecutives + ------------- + All fields are standardized. + + + openbb ====== @@ -2655,9 +4278,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def overview( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2773,6 +4394,120 @@ class CLASS_stocks_fa(Container): All fields are standardized. + CompanyOverview + --------------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + CompanyOverview + --------------- + symbol : ConstrainedStrValue + Symbol to get data for. + price : float + The price of the company. + beta : float + The beta of the company. + vol_avg : int + The volume average of the company. + mkt_cap : int + The market capitalization of the company. + last_div : float + The last dividend of the company. + range : str + The range of the company. + changes : float + The changes of the company. + company_name : str + The company name of the company. + currency : str + The currency of the company. + cik : Optional[str] + The CIK of the company. + isin : Optional[str] + The ISIN of the company. + cusip : Optional[str] + The CUSIP of the company. + exchange : str + The exchange of the company. + exchange_short_name : str + The exchange short name of the company. + industry : str + The industry of the company. + website : str + The website of the company. + description : str + The description of the company. + ceo : str + The CEO of the company. + sector : str + The sector of the company. + country : str + The country of the company. + full_time_employees : str + The full time employees of the company. + phone : str + The phone of the company. + address : str + The address of the company. + city : str + The city of the company. + state : str + The state of the company. + zip : str + The zip of the company. + dcf_diff : float + The discounted cash flow difference of the company. + dcf : float + The discounted cash flow of the company. + image : str + The image of the company. + ipo_date : date + The IPO date of the company. + default_image : bool + If the image is the default image. + is_etf : bool + If the company is an ETF. + is_actively_trading : bool + If the company is actively trading. + is_adr : bool + If the company is an ADR. + is_fund : bool + If the company is a fund. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + CompanyOverview --------------- All fields are standardized.""" @@ -2798,17 +4533,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def own( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - date: typing.Annotated[ - datetime.date, - OpenBBCustomParameter(description="A specific date to get data for."), - ], - page: Annotated[ - Optional[int], - OpenBBCustomParameter(description="The page number of the data to fetch."), - ] = 0, + symbol: str, + date: datetime.date, + page: Optional[int] = 0, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2934,6 +4661,130 @@ class CLASS_stocks_fa(Container): All fields are standardized. + StockOwnership + -------------- + All fields are standardized. + + + + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + A specific date to get data for. + page : Optional[int] + The page number of the data to fetch. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + StockOwnership + -------------- + date : date + The date of the data. + cik : int + The cik of the stock ownership. + filing_date : date + The filing date of the stock ownership. + investor_name : str + The investor name of the stock ownership. + symbol : str + The symbol of the stock ownership. + security_name : str + The security name of the stock ownership. + type_of_security : str + The type of security of the stock ownership. + security_cusip : str + The security cusip of the stock ownership. + shares_type : str + The shares type of the stock ownership. + put_call_share : str + The put call share of the stock ownership. + investment_discretion : str + The investment discretion of the stock ownership. + industry_title : str + The industry title of the stock ownership. + weight : float + The weight of the stock ownership. + last_weight : float + The last weight of the stock ownership. + change_in_weight : float + The change in weight of the stock ownership. + change_in_weight_percentage : float + The change in weight percentage of the stock ownership. + market_value : int + The market value of the stock ownership. + last_market_value : int + The last market value of the stock ownership. + change_in_market_value : int + The change in market value of the stock ownership. + change_in_market_value_percentage : float + The change in market value percentage of the stock ownership. + shares_number : int + The shares number of the stock ownership. + last_shares_number : int + The last shares number of the stock ownership. + change_in_shares_number : float + The change in shares number of the stock ownership. + change_in_shares_number_percentage : float + The change in shares number percentage of the stock ownership. + quarter_end_price : float + The quarter end price of the stock ownership. + avg_price_paid : float + The average price paid of the stock ownership. + is_new : bool + Is the stock ownership new. + is_sold_out : bool + Is the stock ownership sold out. + ownership : float + How much is the ownership. + last_ownership : float + The last ownership amount. + change_in_ownership : float + The change in ownership amount. + change_in_ownership_percentage : float + The change in ownership percentage. + holding_period : int + The holding period of the stock ownership. + first_added : date + The first added date of the stock ownership. + performance : float + The performance of the stock ownership. + performance_percentage : float + The performance percentage of the stock ownership. + last_performance : float + The last performance of the stock ownership. + change_in_performance : float + The change in performance of the stock ownership. + is_counted_for_performance : bool + Is the stock ownership counted for performance. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + StockOwnership -------------- All fields are standardized.""" @@ -2961,9 +4812,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def pt( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -2971,6 +4820,58 @@ class CLASS_stocks_fa(Container): """Price Target Consensus. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + PriceTargetConsensus + -------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + target_high : float + The high target of the price target consensus. + target_low : float + The low target of the price target consensus. + target_consensus : float + The consensus target of the price target consensus. + target_median : float + The median target of the price target consensus. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + PriceTargetConsensus + -------------------- + All fields are standardized. + + + openbb ====== @@ -3042,9 +4943,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def pta( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3052,6 +4951,70 @@ class CLASS_stocks_fa(Container): """Price Target. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + PriceTarget + ----------- + symbol : ConstrainedStrValue + Symbol to get data for. + published_date : datetime + The published date of the price target. + news_url : str + The news URL of the price target. + news_title : Optional[str] + The news title of the price target. + analyst_name : Optional[str] + The analyst name of the price target. + price_target : float + The price target of the price target. + adj_price_target : float + The adjusted price target of the price target. + price_when_posted : float + The price when posted of the price target. + news_publisher : str + The news publisher of the price target. + news_base_url : str + The news base URL of the price target. + analyst_company : str + The analyst company of the price target. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + PriceTarget + ----------- + All fields are standardized. + + + openbb ====== @@ -3186,19 +5149,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def revgeo( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["quarterly", "annually"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - structure: Annotated[ - Literal["hierarchical", "flat"], - OpenBBCustomParameter(description="The structure of the returned data."), - ] = "flat", + symbol: str, + period: Literal["quarterly", "annually"] = "annually", + structure: Literal["hierarchical", "flat"] = "flat", chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3206,6 +5159,64 @@ class CLASS_stocks_fa(Container): """Revenue Geographic. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['quarterly', 'annually'] + Period of the data to return (quarterly or annually). + structure : Literal['hierarchical', 'flat'] + The structure of the returned data. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + RevenueGeographic + ----------------- + date : date + The date of the data. + americas : Optional[int] + The revenue from the the American segment. + europe : Optional[int] + The revenue from the the European segment. + greater_china : Optional[int] + The revenue from the the Greater China segment. + japan : Optional[int] + The revenue from the the Japan segment. + rest_of_asia_pacific : Optional[int] + The revenue from the the Rest of Asia Pacific segment. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + RevenueGeographic + ----------------- + All fields are standardized. + + + openbb ====== @@ -3285,19 +5296,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def revseg( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - period: Annotated[ - Literal["quarterly", "annually"], - OpenBBCustomParameter( - description="Period of the data to return (quarterly or annually)." - ), - ] = "annually", - structure: Annotated[ - Literal["hierarchical", "flat"], - OpenBBCustomParameter(description="The structure of the returned data."), - ] = "flat", + symbol: str, + period: Literal["quarterly", "annually"] = "annually", + structure: Literal["hierarchical", "flat"] = "flat", chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3305,6 +5306,56 @@ class CLASS_stocks_fa(Container): """Revenue Business Line. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + period : Literal['quarterly', 'annually'] + Period of the data to return (quarterly or annually). + structure : Literal['hierarchical', 'flat'] + The structure of the returned data. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + RevenueBusinessLine + ------------------- + date : date + The date of the data. + business_line : Mapping[str, int] + Day level data containing the revenue of the business line. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + RevenueBusinessLine + ------------------- + All fields are standardized. + + + openbb ====== @@ -3442,9 +5493,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def shrs( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3452,6 +5501,60 @@ class CLASS_stocks_fa(Container): """Share Statistics. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + ShareStatistics + --------------- + symbol : ConstrainedStrValue + Symbol to get data for. + date : date + A specific date to get data for. + free_float : float + The percentage of unrestricted shares of a publicly-traded company. + float_shares : float + The number of shares available for trading by the general public. + outstanding_shares : float + The total number of shares of a publicly-traded company. + source : str + Source of the received data. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + ShareStatistics + --------------- + All fields are standardized. + + + openbb ====== @@ -3525,9 +5628,7 @@ class CLASS_stocks_fa(Container): @validate_arguments def split( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], + symbol: str, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3535,6 +5636,56 @@ class CLASS_stocks_fa(Container): """Historical Stock Splits. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + HistoricalStockSplits + --------------------- + date : date + The date of the data. + label : str + The label of the historical stock splits. + numerator : float + The numerator of the historical stock splits. + denominator : float + The denominator of the historical stock splits. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + HistoricalStockSplits + --------------------- + All fields are standardized. + + + openbb ====== @@ -3621,21 +5772,9 @@ class CLASS_stocks_fa(Container): @validate_arguments def transcript( self, - symbol: typing.Annotated[ - str, OpenBBCustomParameter(description="Symbol to get data for.") - ], - year: typing.Annotated[ - int, - OpenBBCustomParameter( - description="The year of the earnings call transcript." - ), - ], - quarter: Annotated[ - Literal[1, 2, 3, 4], - OpenBBCustomParameter( - description="The quarter of the earnings call transcript." - ), - ] = 1, + symbol: str, + year: int, + quarter: Literal[1, 2, 3, 4] = 1, chart: bool = False, provider: Optional[Literal["fmp"]] = None, **kwargs @@ -3643,6 +5782,62 @@ class CLASS_stocks_fa(Container): """Earnings Call Transcript. + openbb + ====== + + Parameters + ---------- + provider: Literal[fmp] + The provider to use for the query. + symbol : ConstrainedStrValue + Symbol to get data for. + year : int + The year of the earnings call transcript. + quarter : Literal[1, 2, 3, 4] + The quarter of the earnings call transcript. + + Returns + ------- + CommandOutput + results: List[Data] + Serializable results. + provider: Optional[PROVIDERS] + Provider name. + warnings: Optional[List[Warning_]] + List of warnings. + error: Optional[Error] + Caught exceptions. + chart: Optional[Chart] + Chart object. + + + EarningsCallTranscript + ---------------------- + symbol : ConstrainedStrValue + Symbol to get data for. + quarter : int + The quarter of the earnings call transcript. + year : int + The year of the earnings call transcript. + date : datetime + The date of the data. + content : str + The content of the earnings call transcript. + + fmp + === + + Parameters + ---------- + All fields are standardized. + + + EarningsCallTranscript + ---------------------- + All fields are standardized. + + + openbb ====== diff --git a/openbb_sdk/sdk/provider/openbb_provider/standard_models/stock_eod.py b/openbb_sdk/sdk/provider/openbb_provider/standard_models/stock_eod.py index ead78900695..680b93730e1 100644 --- a/openbb_sdk/sdk/provider/openbb_provider/standard_models/stock_eod.py +++ b/openbb_sdk/sdk/provider/openbb_provider/standard_models/stock_eod.py @@ -4,12 +4,11 @@ from datetime import date, datetime from typing import Optional -from pydantic import Field, PositiveFloat - from openbb_provider.abstract.data import Data from openbb_provider.abstract.query_params import QueryParams from openbb_provider.standard_models.base import BaseSymbol from openbb_provider.utils.descriptions import DATA_DESCRIPTIONS, QUERY_DESCRIPTIONS +from pydantic import Field, NonNegativeFloat, PositiveFloat class StockEODQueryParams(QueryParams, BaseSymbol): @@ -33,5 +32,5 @@ class StockEODData(Data): high: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("high", "")) low: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("low", "")) close: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("close", "")) - volume: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("volume", "")) - vwap: PositiveFloat = Field(description=DATA_DESCRIPTIONS.get("vwap", "")) + volume: NonNegativeFloat = Field(description=DATA_DESCRIPTIONS.get("volume", "")) + vwap: Optional[PositiveFloat] = Field(description=DATA_DESCRIPTIONS.get("vwap", ""))