diff --git a/cli/openbb_cli/argparse_translator/argparse_translator.py b/cli/openbb_cli/argparse_translator/argparse_translator.py index 724c2bea3060..7931b22304f7 100644 --- a/cli/openbb_cli/argparse_translator/argparse_translator.py +++ b/cli/openbb_cli/argparse_translator/argparse_translator.py @@ -42,7 +42,7 @@ class CustomArgument(BaseModel): action: Literal["store_true", "store"] help: str nargs: Optional[Literal["+"]] - choices: Optional[Any] + choices: Optional[Tuple] @model_validator(mode="after") # type: ignore @classmethod @@ -117,7 +117,7 @@ def _get_nargs(self, type_: type) -> Optional[Union[int, str]]: return "+" return None - def _get_choices(self, type_: str) -> Tuple: + def _get_choices(self, type_: str, custom_choices: Any) -> Tuple: """Get the choices for the given type.""" type_ = self._make_type_parsable(type_) # type: ignore type_origin = get_origin(type_) @@ -126,14 +126,12 @@ def _get_choices(self, type_: str) -> Tuple: if type_origin is Literal: choices = get_args(type_) - # param_type = type(choices[0]) if type_origin is list: type_ = get_args(type_)[0] if get_origin(type_) is Literal: choices = get_args(type_) - # param_type = type(choices[0]) if type_origin is Union and type(None) in get_args(type_): # remove NoneType from the args @@ -145,7 +143,9 @@ def _get_choices(self, type_: str) -> Tuple: if get_origin(type_) is Literal: choices = get_args(type_) - # param_type = type(choices[0]) + + if custom_choices: + return tuple(custom_choices) return choices @@ -174,7 +174,9 @@ def build_custom_groups(self): action="store" if type_ != bool else "store_true", help=arg["description"], nargs=self._get_nargs(type_), # type: ignore - choices=self._get_choices(arg["type"]), + choices=self._get_choices( + arg["type"], custom_choices=arg["choices"] + ), ) ) diff --git a/openbb_platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/core/openbb_core/app/static/package_builder.py index 11fcc5766b0a..feb3803f6ed9 100644 --- a/openbb_platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/core/openbb_core/app/static/package_builder.py @@ -1483,8 +1483,10 @@ def _get_provider_field_params( .strip().replace("\n", " ").replace(" ", " ").replace('"', "'") ) # fmt: skip + extra = field_info.json_schema_extra or {} + # Add information for the providers supporting multiple symbols - if params_type == "QueryParams" and (extra := field_info.json_schema_extra): + if params_type == "QueryParams" and extra: providers = [] for p, v in extra.items(): # type: ignore[union-attr] @@ -1512,6 +1514,7 @@ def _get_provider_field_params( "description": cleaned_description, "default": default_value, "optional": not is_required, + "choices": extra.get("choices"), } ) diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 91095c1bd2ab..f184e92a4c47 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -50,21 +50,24 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -80,7 +83,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -89,21 +93,24 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -112,14 +119,16 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "exchanges", "type": "List[str]", "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -128,7 +137,8 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ] }, @@ -168,49 +178,56 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "vwap", "type": "Annotated[float, Gt(gt=0)]", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -219,21 +236,24 @@ "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -242,7 +262,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -251,14 +272,16 @@ "type": "int", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_notional", "type": "float", "description": "The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -279,7 +302,8 @@ "type": "str", "description": "Search query.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -327,14 +351,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data. (Crypto)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the crypto.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -343,21 +369,24 @@ "type": "str", "description": "The currency the crypto trades for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the crypto trades on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_name", "type": "str", "description": "The short name of the exchange the crypto trades on.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -377,21 +406,24 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -407,7 +439,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -416,21 +449,24 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -439,7 +475,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -448,7 +485,8 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ] }, @@ -488,49 +526,56 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "vwap", "type": "Annotated[float, Gt(gt=0)]", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -539,21 +584,24 @@ "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -562,7 +610,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [], @@ -584,7 +633,8 @@ "type": "str", "description": "Query to search for currency pairs.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -634,14 +684,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the currency pair.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -650,28 +702,32 @@ "type": "str", "description": "Symbol of the currency pair.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "currency", "type": "str", "description": "Base currency of the currency pair.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "stock_exchange", "type": "str", "description": "Stock exchange of the currency pair.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_short_name", "type": "str", "description": "Short name of the stock exchange of the currency pair.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -680,14 +736,16 @@ "type": "str", "description": "ISO 4217 currency code of the base currency.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "quote_currency", "type": "str", "description": "ISO 4217 currency code of the quote currency.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "polygon": [ @@ -696,49 +754,56 @@ "type": "str", "description": "The symbol of the quote currency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "base_currency_symbol", "type": "str", "description": "The symbol of the base currency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "base_currency_name", "type": "str", "description": "Name of the base currency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market", "type": "str", "description": "Name of the trading market. Always 'fx'.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "locale", "type": "str", "description": "Locale of the currency pair.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_updated", "type": "date", "description": "The date the reference data was last updated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "delisted", "type": "date", "description": "The date the item was delisted.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -758,21 +823,24 @@ "type": "Union[str, List[str]]", "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", "default": "usd", - "optional": true + "optional": true, + "choices": null }, { "name": "quote_type", "type": "Literal['direct', 'indirect']", "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", "default": "indirect", - "optional": true + "optional": true, + "choices": null }, { "name": "counter_currencies", "type": "Union[List[str], str]", "description": "An optional list of counter currency symbols to filter for. None returns all.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -821,63 +889,72 @@ "type": "str", "description": "The base, or domestic, currency.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "counter_currency", "type": "str", "description": "The counter, or foreign, currency.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_rate", "type": "float", "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -886,49 +963,56 @@ "type": "float", "description": "The change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "The change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma50", "type": "float", "description": "The 50-day moving average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma200", "type": "float", "description": "The 200-day moving average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_rate_timestamp", "type": "datetime", "description": "The timestamp of the last rate.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -937,140 +1021,160 @@ "type": "float", "description": "The volume-weighted average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "The change in price from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "The percentage change in price from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_open", "type": "float", "description": "The previous day's opening price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_high", "type": "float", "description": "The previous day's high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_low", "type": "float", "description": "The previous day's low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_volume", "type": "float", "description": "The previous day's volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_vwap", "type": "float", "description": "The previous day's VWAP.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_open", "type": "float", "description": "The open price from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_high", "type": "float", "description": "The high price from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_low", "type": "float", "description": "The low price from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_close", "type": "float", "description": "The close price from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_volume", "type": "float", "description": "The volume from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_vwap", "type": "float", "description": "The VWAP from the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_transactions", "type": "float", "description": "The number of transactions in the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quote_timestamp", "type": "datetime", "description": "The timestamp of the last quote.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minute_timestamp", "type": "datetime", "description": "The timestamp for the start of the most recent minute bar.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The last time the data was updated.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -1090,7 +1194,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -1106,7 +1211,8 @@ "type": "Union[date, str]", "description": "The end-of-day date for options chains data.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -1146,301 +1252,344 @@ "type": "str", "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "contract_symbol", "type": "str", "description": "Contract symbol for the option.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "eod_date", "type": "date", "description": "Date for which the options chains are returned.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "expiration", "type": "date", "description": "Expiration date of the contract.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "strike", "type": "float", "description": "Strike price of the contract.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "option_type", "type": "str", "description": "Call or Put.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open_interest", "type": "int", "description": "Open interest on the contract.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "theoretical_price", "type": "float", "description": "Theoretical value of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_price", "type": "float", "description": "Last trade price of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tick", "type": "str", "description": "Whether the last tick was up or down in price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid", "type": "float", "description": "Current bid price for the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_size", "type": "int", "description": "Bid size for the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask", "type": "float", "description": "Current ask price for the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_size", "type": "int", "description": "Ask size for the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mark", "type": "float", "description": "The mid-price between the latest bid and ask.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open_bid", "type": "float", "description": "The opening bid price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open_ask", "type": "float", "description": "The opening ask price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_high", "type": "float", "description": "The highest bid price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_high", "type": "float", "description": "The highest ask price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_low", "type": "float", "description": "The lowest bid price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_low", "type": "float", "description": "The lowest ask price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_size", "type": "int", "description": "The closing trade size for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_time", "type": "datetime", "description": "The time of the closing price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_bid", "type": "float", "description": "The closing bid price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_bid_size", "type": "int", "description": "The closing bid size for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_bid_time", "type": "datetime", "description": "The time of the bid closing price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_ask", "type": "float", "description": "The closing ask price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_ask_size", "type": "int", "description": "The closing ask size for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_ask_time", "type": "datetime", "description": "The time of the ask closing price for the option that day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "The change in the price of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change, in normalizezd percentage points, of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "implied_volatility", "type": "float", "description": "Implied volatility of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "delta", "type": "float", "description": "Delta of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gamma", "type": "float", "description": "Gamma of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "theta", "type": "float", "description": "Theta of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "vega", "type": "float", "description": "Vega of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rho", "type": "float", "description": "Rho of the option.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -1449,7 +1598,8 @@ "type": "str", "description": "The exercise style of the option, American or European.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -1469,7 +1619,8 @@ "type": "str", "description": "Symbol to get data for. (the underlying symbol)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -1485,56 +1636,64 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trade_type", "type": "Literal['block', 'sweep', 'large']", "description": "The type of unusual activity to query for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment", "type": "Literal['bullish', 'bearish', 'neutral']", "description": "The sentiment type to query for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "min_value", "type": "Union[int, float]", "description": "The inclusive minimum total value for the unusual activity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "max_value", "type": "Union[int, float]", "description": "The inclusive maximum total value for the unusual activity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", "default": 100000, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "Literal['delayed', 'realtime']", "description": "The source of the data. Either realtime or delayed.", "default": "delayed", - "optional": true + "optional": true, + "choices": null } ] }, @@ -1574,14 +1733,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data. (the underlying symbol)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "contract_symbol", "type": "str", "description": "Contract symbol for the option.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "intrinio": [ @@ -1590,63 +1751,72 @@ "type": "datetime", "description": "The datetime of order placement.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "trade_type", "type": "Literal['block', 'sweep', 'large']", "description": "The type of unusual trade.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "sentiment", "type": "Literal['bullish', 'bearish', 'neutral']", "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "bid_at_execution", "type": "float", "description": "Bid price at execution.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ask_at_execution", "type": "float", "description": "Ask price at execution.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "average_price", "type": "float", "description": "The average premium paid per option contract.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "underlying_price_at_execution", "type": "float", "description": "Price of the underlying security at execution of trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_size", "type": "int", "description": "The total number of contracts involved in a single transaction.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_value", "type": "Union[int, float]", "description": "The aggregated value of all option contract premiums included in the trade.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -1666,28 +1836,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "expiration", "type": "str", "description": "Future expiry date with format YYYY-MM", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -1703,7 +1877,8 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ] }, @@ -1743,42 +1918,48 @@ "type": "datetime", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [] @@ -1799,14 +1980,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -1854,14 +2037,16 @@ "type": "str", "description": "Futures expiration month.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -1882,28 +2067,32 @@ "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "type", "type": "Literal['nominal', 'real']", "description": "Type of GDP to get forecast of. Either nominal or real.", "default": "real", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -1919,7 +2108,8 @@ "type": "Literal['argentina', 'asia', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_17', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'non-oecd', 'norway', 'oecd_total', 'peru', 'poland', 'portugal', 'romania', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'world']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null } ] }, @@ -1959,14 +2149,16 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Nominal GDP value on the date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -1987,21 +2179,24 @@ "type": "Literal['usd', 'usd_cap']", "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", "default": "usd", - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2017,7 +2212,8 @@ "type": "Literal['australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area', 'european_union', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null } ] }, @@ -2057,14 +2253,16 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Nominal GDP value on the date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -2085,21 +2283,24 @@ "type": "Literal['idx', 'qoq', 'yoy']", "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", "default": "yoy", - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2115,7 +2316,8 @@ "type": "Literal['G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'europe', 'european_union_27', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd_total', 'poland', 'portugal', 'romania', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null } ] }, @@ -2155,14 +2357,16 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Nominal GDP value on the date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -2183,14 +2387,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2207,28 +2413,248 @@ "type": "Union[str, List[str]]", "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", "default": null, - "optional": true + "optional": true, + "choices": [ + "brazil", + "isle_of_man", + "belgium", + "ukraine", + "liechtenstein", + "malawi", + "tunisia", + "jamaica", + "guinea", + "sri_lanka", + "united_states", + "mauritania", + "pakistan", + "new_zealand", + "mauritius", + "namibia", + "nepal", + "yemen", + "bhutan", + "benin", + "malta", + "georgia", + "east_timor", + "switzerland", + "trinidad_and_tobago", + "south_sudan", + "austria", + "cyprus", + "suriname", + "egypt", + "latvia", + "luxembourg", + "nicaragua", + "ghana", + "panama", + "north_macedonia", + "equatorial_guinea", + "cambodia", + "iraq", + "south_africa", + "serbia", + "zambia", + "republic_of_the_congo", + "sudan", + "guinea_bissau", + "sao_tome_and_principe", + "seychelles", + "singapore", + "greece", + "slovakia", + "maldives", + "australia", + "togo", + "czech_republic", + "guatemala", + "finland", + "mexico", + "iran", + "taiwan", + "north_korea", + "ireland", + "el_salvador", + "brunei", + "bahrain", + "south_korea", + "hong_kong", + "liberia", + "vanuatu", + "slovenia", + "qatar", + "united_arab_emirates", + "antigua_and_barbuda", + "estonia", + "ecuador", + "kenya", + "kiribati", + "israel", + "kosovo", + "eritrea", + "niger", + "sierra_leone", + "thailand", + "lesotho", + "puerto_rico", + "croatia", + "andorra", + "denmark", + "congo", + "aruba", + "tonga", + "germany", + "france", + "norway", + "tajikistan", + "azerbaijan", + "chad", + "spain", + "madagascar", + "palestine", + "algeria", + "ivory_coast", + "somalia", + "bermuda", + "romania", + "belize", + "costa_rica", + "argentina", + "tanzania", + "dominican_republic", + "uruguay", + "belarus", + "botswana", + "peru", + "libya", + "bosnia_and_herzegovina", + "swaziland", + "jordan", + "bolivia", + "kazakhstan", + "macao", + "chile", + "zimbabwe", + "moldova", + "burundi", + "honduras", + "grenada", + "gambia", + "indonesia", + "italy", + "burkina_faso", + "venezuela", + "myanmar", + "senegal", + "guyana", + "turkey", + "fiji", + "new_caledonia", + "netherlands", + "montenegro", + "angola", + "mongolia", + "central_african_republic", + "china", + "gabon", + "djibouti", + "vietnam", + "papua_new_guinea", + "saudi_arabia", + "mali", + "philippines", + "turkmenistan", + "nigeria", + "laos", + "euro_area", + "bangladesh", + "armenia", + "morocco", + "afghanistan", + "monaco", + "lithuania", + "lebanon", + "canada", + "russia", + "cuba", + "samoa", + "rwanda", + "hungary", + "kuwait", + "sweden", + "mozambique", + "albania", + "solomon_islands", + "cameroon", + "malaysia", + "haiti", + "colombia", + "faroe_islands", + "iceland", + "comoros", + "kyrgyzstan", + "poland", + "bahamas", + "ethiopia", + "dominica", + "uganda", + "portugal", + "barbados", + "oman", + "bulgaria", + "india", + "japan", + "cayman_islands", + "paraguay", + "uzbekistan", + "cape_verde", + "united_kingdom", + "syria" + ] }, { "name": "importance", "type": "Literal['low', 'medium', 'high']", "description": "Importance of the event.", "default": null, - "optional": true + "optional": true, + "choices": [ + "low", + "medium", + "high" + ] }, { "name": "group", "type": "Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", "description": "Grouping of events.", "default": null, - "optional": true + "optional": true, + "choices": [ + "interest_rate", + "inflation", + "bonds", + "consumer", + "gdp", + "government", + "housing", + "labour", + "markets", + "money", + "prices", + "trade", + "business" + ] }, { "name": "calendar_id", "type": "Union[Union[int, str], List[Union[int, str]]]", "description": "Get events by TradingEconomics Calendar ID. Multiple items allowed for provider(s): tradingeconomics.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -2268,84 +2694,96 @@ "type": "datetime", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country of event.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "category", "type": "str", "description": "Category of event.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "event", "type": "str", "description": "Event name.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "importance", "type": "str", "description": "The importance level for the event.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "str", "description": "Source of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unit", "type": "str", "description": "Unit of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "consensus", "type": "Union[str, float]", "description": "Average forecast among a representative group of economists.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "previous", "type": "Union[str, float]", "description": "Value for the previous period after the revision (if revision is applicable).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revised", "type": "Union[str, float]", "description": "Revised previous value, if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "actual", "type": "Union[str, float]", "description": "Latest released value.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -2354,28 +2792,32 @@ "type": "float", "description": "Value change since previous.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Percentage change since previous.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last updated timestamp.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "created_at", "type": "datetime", "description": "Created at timestamp.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tradingeconomics": [ @@ -2384,70 +2826,80 @@ "type": "Union[str, float]", "description": "TradingEconomics projections.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reference", "type": "str", "description": "Abbreviated period for which released data refers to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reference_date", "type": "date", "description": "Date for the reference period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_id", "type": "int", "description": "TradingEconomics Calendar ID.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date_span", "type": "int", "description": "Date span of the event.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "TradingEconomics Symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ticker", "type": "str", "description": "TradingEconomics Ticker symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "te_url", "type": "str", "description": "TradingEconomics URL path.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "source_url", "type": "str", "description": "Source URL.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last update of the data.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -2467,42 +2919,98 @@ "type": "Union[str, List[str]]", "description": "The country to get data. Multiple items allowed for provider(s): fred.", "default": "", - "optional": false + "optional": false, + "choices": [ + "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" + ] }, { "name": "units", "type": "Literal['growth_previous', 'growth_same', 'index_2015']", "description": "The unit of measurement for the data. Options: - `growth_previous`: Percent growth from the previous period. If monthly data, this is month-over-month, etc - `growth_same`: Percent growth from the same period in the previous year. If looking at monthly data, this would be year-over-year, etc. - `index_2015`: Rescaled index value, such that the value in 2015 is 100.", "default": "growth_same", - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "The frequency of the data. Options: `monthly`, `quarter`, and `annual`.", "default": "monthly", - "optional": true + "optional": true, + "choices": null }, { "name": "harmonized", "type": "bool", "description": "Whether you wish to obtain harmonized data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2550,7 +3058,8 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -2612,28 +3121,32 @@ "type": "str", "description": "Market country.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "continent", "type": "str", "description": "Continent of the country.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_equity_risk_premium", "type": "Annotated[float, Gt(gt=0)]", "description": "Total equity risk premium for the country.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country_risk_premium", "type": "Annotated[float, Ge(ge=0)]", "description": "Country-specific risk premium.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -2654,7 +3167,8 @@ "type": "str", "description": "The search word(s).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2670,63 +3184,72 @@ "type": "bool", "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "release_id", "type": "Union[int, str]", "description": "A specific release ID to target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. (1-1000)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "offset", "type": "Annotated[int, Ge(ge=0)]", "description": "Offset the results in conjunction with limit.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "filter_variable", "type": "Literal['frequency', 'units', 'seasonal_adjustment']", "description": "Filter by an attribute.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filter_value", "type": "str", "description": "String value to filter the variable by. Used in conjunction with filter_variable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tag_names", "type": "str", "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports'", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exclude_tag_names", "type": "str", "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "series_id", "type": "str", "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -2766,112 +3289,128 @@ "type": "Union[int, str]", "description": "The release ID for queries.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "series_id", "type": "str", "description": "The series ID for the item in the release.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "The name of the release.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "title", "type": "str", "description": "The title of the series.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "observation_start", "type": "date", "description": "The date of the first observation in the series.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "observation_end", "type": "date", "description": "The date of the last observation in the series.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "str", "description": "The frequency of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency_short", "type": "str", "description": "Short form of the data frequency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "units", "type": "str", "description": "The units of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "units_short", "type": "str", "description": "Short form of the data units.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "seasonal_adjustment", "type": "str", "description": "The seasonal adjustment of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "seasonal_adjustment_short", "type": "str", "description": "Short form of the data seasonal adjustment.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The datetime of the last update to the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "notes", "type": "str", "description": "Description of the release.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "press_release", "type": "bool", "description": "If the release is a press release.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url", "type": "str", "description": "URL to the release.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fred": [ @@ -2880,28 +3419,32 @@ "type": "int", "description": "Popularity of the series", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "group_popularity", "type": "int", "description": "Group popularity of the release", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "region_type", "type": "str", "description": "The region type of the series.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "series_group", "type": "Union[int, str]", "description": "The series group ID of the series. This value is used to query for regional data.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -2921,28 +3464,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100000, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -2958,28 +3505,32 @@ "type": "int", "description": "The number of data entries to return.", "default": 100000, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency. None = No change a = Annual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. avg = Average sum = Sum eop = End of Period", "default": "eop", - "optional": true + "optional": true, + "choices": null }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type None = No transformation chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -2988,14 +3539,16 @@ "type": "bool", "description": "Returns all pages of data from the API call at once.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "sleep", "type": "float", "description": "Time to sleep between requests to avoid rate limiting.", "default": 1.0, - "optional": true + "optional": true, + "choices": null } ] }, @@ -3035,7 +3588,8 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [], @@ -3045,7 +3599,8 @@ "type": "float", "description": "Value of the index.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -3065,21 +3620,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adjusted", "type": "bool", "description": "Whether to return seasonally adjusted data.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3127,56 +3685,64 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "M1", "type": "float", "description": "Value of the M1 money supply in billions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "M2", "type": "float", "description": "Value of the M2 money supply in billions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "currency", "type": "float", "description": "Value of currency in circulation in billions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "demand_deposits", "type": "float", "description": "Value of demand deposits in billions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "retail_money_market_funds", "type": "float", "description": "Value of retail money market funds in billions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_liquid_deposits", "type": "float", "description": "Value of other liquid deposits in billions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "small_denomination_time_deposits", "type": "float", "description": "Value of small denomination time deposits in billions.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "federal_reserve": [] @@ -3197,14 +3763,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3220,35 +3788,40 @@ "type": "Literal['colombia', 'new_zealand', 'united_kingdom', 'italy', 'luxembourg', 'euro_area19', 'sweden', 'oecd', 'south_africa', 'denmark', 'canada', 'switzerland', 'slovakia', 'hungary', 'portugal', 'spain', 'france', 'czech_republic', 'costa_rica', 'japan', 'slovenia', 'russia', 'austria', 'latvia', 'netherlands', 'israel', 'iceland', 'united_states', 'ireland', 'mexico', 'germany', 'greece', 'turkey', 'australia', 'poland', 'south_korea', 'chile', 'finland', 'european_union27_2020', 'norway', 'lithuania', 'euro_area20', 'estonia', 'belgium', 'brazil', 'indonesia', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null }, { "name": "sex", "type": "Literal['total', 'male', 'female']", "description": "Sex to get unemployment for.", "default": "total", - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarterly', 'annual']", "description": "Frequency to get unemployment for.", "default": "monthly", - "optional": true + "optional": true, + "choices": null }, { "name": "age", "type": "Literal['total', '15-24', '15-64', '25-54', '55-64']", "description": "Age group to get unemployment for. Total indicates 15 years or over", "default": "total", - "optional": true + "optional": true, + "choices": null }, { "name": "seasonal_adjustment", "type": "bool", "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -3288,21 +3861,24 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Unemployment rate (given as a whole number, i.e 10=10%)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country for which unemployment rate is given", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -3323,14 +3899,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3346,7 +3924,8 @@ "type": "Literal['united_states', 'united_kingdom', 'japan', 'mexico', 'indonesia', 'australia', 'brazil', 'canada', 'italy', 'germany', 'turkey', 'france', 'south_africa', 'south_korea', 'spain', 'india', 'china', 'g7', 'g20', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null } ] }, @@ -3386,21 +3965,24 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "CLI value", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country for which CLI is given", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -3421,14 +4003,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3444,14 +4028,16 @@ "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarterly', 'annual']", "description": "Frequency to get interest rate for for.", "default": "monthly", - "optional": true + "optional": true, + "choices": null } ] }, @@ -3491,21 +4077,24 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country for which interest rate is given", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -3526,14 +4115,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3549,14 +4140,16 @@ "type": "Literal['belgium', 'ireland', 'mexico', 'indonesia', 'new_zealand', 'japan', 'united_kingdom', 'france', 'chile', 'canada', 'netherlands', 'united_states', 'south_korea', 'norway', 'austria', 'south_africa', 'denmark', 'switzerland', 'hungary', 'luxembourg', 'australia', 'germany', 'sweden', 'iceland', 'turkey', 'greece', 'israel', 'czech_republic', 'latvia', 'slovenia', 'poland', 'estonia', 'lithuania', 'portugal', 'costa_rica', 'slovakia', 'finland', 'spain', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all']", "description": "Country to get GDP for.", "default": "united_states", - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarterly', 'annual']", "description": "Frequency to get interest rate for for.", "default": "monthly", - "optional": true + "optional": true, + "choices": null } ] }, @@ -3596,21 +4189,24 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country for which interest rate is given", "default": null, - "optional": true + "optional": true, + "choices": null } ], "oecd": [] @@ -3631,28 +4227,32 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100000, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -3668,56 +4268,64 @@ "type": "str", "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_series_group", "type": "bool", "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "region_type", "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "season", "type": "Literal['SA', 'NSA', 'SSA']", "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", "default": "NSA", - "optional": true + "optional": true, + "choices": null }, { "name": "units", "type": "str", "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when `is_series_group` is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when `is_series_group` is True. avg = Average sum = Sum eop = End of Period", "default": "avg", - "optional": true + "optional": true, + "choices": null }, { "name": "transform", "type": "Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type. Only valid when `is_series_group` is True. lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log", "default": "lin", - "optional": true + "optional": true, + "choices": null } ] }, @@ -3757,7 +4365,8 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [ @@ -3766,28 +4375,32 @@ "type": "str", "description": "The name of the region.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "code", "type": "Union[str, int]", "description": "The code of the region.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "The obersvation value. The units are defined in the search results by series ID.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "series_id", "type": "str", "description": "The individual series ID for the region.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -3807,7 +4420,8 @@ "type": "Union[str, List[str]]", "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -3823,14 +4437,16 @@ "type": "bool", "description": "If True, return only the latest data. If False, return all available data for each indicator.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -3870,98 +4486,112 @@ "type": "str", "description": "", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "population", "type": "int", "description": "Population.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gdp_usd", "type": "float", "description": "Gross Domestic Product, in billions of USD.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gdp_qoq", "type": "float", "description": "GDP growth quarter-over-quarter change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gdp_yoy", "type": "float", "description": "GDP growth year-over-year change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cpi_yoy", "type": "float", "description": "Consumer Price Index year-over-year change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "core_yoy", "type": "float", "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "retail_sales_yoy", "type": "float", "description": "Retail Sales year-over-year change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industrial_production_yoy", "type": "float", "description": "Industrial Production year-over-year change, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "policy_rate", "type": "float", "description": "Short term policy rate, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "yield_10y", "type": "float", "description": "10-year government bond yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "govt_debt_gdp", "type": "float", "description": "Government debt as a percent (normalized) of GDP.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_account_gdp", "type": "float", "description": "Current account balance as a percent (normalized) of GDP.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "jobless_rate", "type": "float", "description": "Unemployment rate, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "econdb": [] @@ -3991,7 +4621,8 @@ "type": "bool", "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4031,42 +4662,48 @@ "type": "str", "description": "The root symbol representing the indicator.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The name of the country, region, or entity represented by the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "iso", "type": "str", "description": "The ISO code of the country, region, or entity represented by the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "description", "type": "str", "description": "The description of the indicator.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "str", "description": "The frequency of the indicator data.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "econdb": [ @@ -4075,56 +4712,64 @@ "type": "str", "description": "The currency, or unit, the data is based in.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "scale", "type": "str", "description": "The scale of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "multiplier", "type": "int", "description": "The multiplier of the data to arrive at whole units.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "transformation", "type": "str", "description": "Transformation type.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "source", "type": "str", "description": "The original source of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "first_date", "type": "date", "description": "The first date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_date", "type": "date", "description": "The last date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_insert_timestamp", "type": "datetime", "description": "The time of the last update. Data is typically reported with a lag.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4144,28 +4789,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple items allowed for provider(s): econdb.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "country", "type": "Union[str, List[str]]", "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -4181,21 +4830,24 @@ "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", "description": "The transformation to apply to the data, default is None. tpop: Change from previous period toya: Change from one year ago tusd: Values as US dollars tpgp: Values as a percent of GDP Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results. This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities. `tusd` should only be used where values are currencies.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['annual', 'quarter', 'month']", "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", "default": "quarter", - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4235,35 +4887,40 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol_root", "type": "str", "description": "The root symbol for the indicator (e.g. GDP).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The country represented by the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "", "default": null, - "optional": true + "optional": true, + "choices": null } ], "econdb": [] @@ -4284,28 +4941,32 @@ "type": "str", "description": "Symbol to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -4321,21 +4982,24 @@ "type": "Literal['upcoming', 'priced', 'withdrawn']", "description": "Status of the IPO. [upcoming, priced, or withdrawn]", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "min_value", "type": "int", "description": "Return IPOs with an offer dollar amount greater than the given amount.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "max_value", "type": "int", "description": "Return IPOs with an offer dollar amount less than the given amount.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4375,14 +5039,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ipo_date", "type": "date", "description": "The date of the IPO, when the stock first trades on a major exchange.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -4391,140 +5057,160 @@ "type": "Literal['upcoming', 'priced', 'withdrawn']", "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "offer_amount", "type": "float", "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_price", "type": "float", "description": "The price per share at which the IPO was offered.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_price_lowest", "type": "float", "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_price_highest", "type": "float", "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_count", "type": "int", "description": "The number of shares offered in the IPO.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_count_lowest", "type": "int", "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_count_highest", "type": "int", "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "announcement_url", "type": "str", "description": "The URL to the company's announcement of the IPO", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sec_report_url", "type": "str", "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open_price", "type": "float", "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_price", "type": "float", "description": "The closing price at the end of the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The volume at the end of the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "day_change", "type": "float", "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "week_change", "type": "float", "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_change", "type": "float", "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "The Intrinio ID of the IPO.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company", "type": "IntrinioCompany", "description": "The company that is going public via the IPO.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The primary Security for the Company that is going public via the IPO", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4544,14 +5230,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -4599,49 +5287,56 @@ "type": "date", "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "amount", "type": "float", "description": "The dividend amount per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "record_date", "type": "date", "description": "The record date of ownership for eligibility.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payment_date", "type": "date", "description": "The payment date of the dividend.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "declaration_date", "type": "date", "description": "Declaration date of the dividend.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -4650,14 +5345,16 @@ "type": "float", "description": "The adjusted-dividend amount.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "label", "type": "str", "description": "Ex-dividend date formatted for display.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4677,14 +5374,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -4732,35 +5431,40 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "label", "type": "str", "description": "Label of the stock splits.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "numerator", "type": "float", "description": "Numerator of the stock splits.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "denominator", "type": "float", "description": "Denominator of the stock splits.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -4781,14 +5485,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -4836,35 +5542,40 @@ "type": "date", "description": "The date of the earnings report.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_previous", "type": "float", "description": "The earnings-per-share from the same previously reported period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_consensus", "type": "float", "description": "The analyst conesus earnings-per-share estimate.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -4873,42 +5584,48 @@ "type": "float", "description": "The actual earnings per share announced.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_actual", "type": "float", "description": "The actual reported revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_consensus", "type": "float", "description": "The revenue forecast consensus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_ending", "type": "date", "description": "The fiscal period end date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reporting_time", "type": "str", "description": "The reporting time - e.g. after market close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated_date", "type": "date", "description": "The date the data was updated last.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -4928,7 +5645,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -4976,7 +5694,8 @@ "type": "List[str]", "description": "A list of equity peers based on sector, exchange and market cap.", "default": "", - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -4997,14 +5716,16 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 200, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -5020,70 +5741,80 @@ "type": "int", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "Date for calendar data, shorthand for date_from and date_to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "Union[date, int]", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "importance", "type": "int", "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "action", "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", "description": "Filter by a specific action_company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "analyst_ids", "type": "Union[List[str], str]", "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firm_ids", "type": "Union[List[str], str]", "description": "Comma-separated list of firm IDs.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fields", "type": "Union[List[str], str]", "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -5092,7 +5823,8 @@ "type": "bool", "description": "Include upgrades and downgrades in the response.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -5132,112 +5864,128 @@ "type": "Union[date, datetime]", "description": "Published date of the price target.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "published_time", "type": "datetime.time", "description": "Time of the original rating, UTC.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the company is traded.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_name", "type": "str", "description": "Name of company that is the subject of rating.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "analyst_name", "type": "str", "description": "Analyst name.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "analyst_firm", "type": "str", "description": "Name of the analyst firm that published the price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency the data is denominated in.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_target", "type": "float", "description": "The current price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_price_target", "type": "float", "description": "Adjusted price target for splits and stock dividends.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_target_previous", "type": "float", "description": "Previous price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "previous_adj_price_target", "type": "float", "description": "Previous adjusted price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_when_posted", "type": "float", "description": "Price when posted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rating_current", "type": "str", "description": "The analyst's rating for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rating_previous", "type": "str", "description": "Previous analyst rating for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "action", "type": "str", "description": "Description of the change in rating from firm's last rating.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "benzinga": [ @@ -5246,63 +5994,72 @@ "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "action_change", "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", "description": "Description of the change in price target from firm's last price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "importance", "type": "Literal[0, 1, 2, 3, 4, 5]", "description": "Subjective Basis of How Important Event is to Market. 5 = High", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "notes", "type": "str", "description": "Notes of the price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "analyst_id", "type": "str", "description": "Id of the analyst.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url_news", "type": "str", "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url_analyst", "type": "str", "description": "URL for analyst ratings page for this ticker on Benzinga.com.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "Unique ID of this entry.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last updated timestamp, UTC.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -5311,28 +6068,32 @@ "type": "str", "description": "News URL of the price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "news_title", "type": "str", "description": "News title of the price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "news_publisher", "type": "str", "description": "News publisher of the price target.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "news_base_url", "type": "str", "description": "News base URL of the price target.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -5352,7 +6113,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -5368,14 +6130,16 @@ "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -5415,154 +6179,176 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "estimated_revenue_low", "type": "int", "description": "Estimated revenue low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_revenue_high", "type": "int", "description": "Estimated revenue high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_revenue_avg", "type": "int", "description": "Estimated revenue average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_sga_expense_low", "type": "int", "description": "Estimated SGA expense low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_sga_expense_high", "type": "int", "description": "Estimated SGA expense high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_sga_expense_avg", "type": "int", "description": "Estimated SGA expense average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebitda_low", "type": "int", "description": "Estimated EBITDA low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebitda_high", "type": "int", "description": "Estimated EBITDA high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebitda_avg", "type": "int", "description": "Estimated EBITDA average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebit_low", "type": "int", "description": "Estimated EBIT low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebit_high", "type": "int", "description": "Estimated EBIT high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_ebit_avg", "type": "int", "description": "Estimated EBIT average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_net_income_low", "type": "int", "description": "Estimated net income low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_net_income_high", "type": "int", "description": "Estimated net income high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_net_income_avg", "type": "int", "description": "Estimated net income average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_eps_avg", "type": "float", "description": "Estimated EPS average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_eps_high", "type": "float", "description": "Estimated EPS high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "estimated_eps_low", "type": "float", "description": "Estimated EPS low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_analyst_estimated_revenue", "type": "int", "description": "Number of analysts who estimated revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_analysts_estimated_eps", "type": "int", "description": "Number of analysts who estimated EPS.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -5583,7 +6369,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -5600,7 +6387,8 @@ "type": "int", "description": "The Zacks industry group number.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -5641,42 +6429,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "The company name", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "target_high", "type": "float", "description": "High target of the price target consensus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "target_low", "type": "float", "description": "Low target of the price target consensus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "target_consensus", "type": "float", "description": "Consensus target of the price target consensus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "target_median", "type": "float", "description": "Median target of the price target consensus.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [], @@ -5686,42 +6480,48 @@ "type": "float", "description": "The standard deviation of target price estimates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_anaylsts", "type": "int", "description": "The total number of target price estimates in consensus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "raised", "type": "int", "description": "The number of analysts that have raised their target price estimates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "lowered", "type": "int", "description": "The number of analysts that have lowered their target price estimates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "most_recent_date", "type": "date", "description": "The date of the most recent estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry_group_number", "type": "int", "description": "The Zacks industry group number.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -5730,35 +6530,40 @@ "type": "str", "description": "Recommendation - buy, sell, etc.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "recommendation_mean", "type": "float", "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing opinions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_price", "type": "float", "description": "Current price of the stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency the stock is priced in.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -5778,14 +6583,16 @@ "type": "Union[str, List[str]]", "description": "Analyst names to return. Omitting will return all available analysts. Multiple items allowed for provider(s): benzinga.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firm_name", "type": "Union[str, List[str]]", "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -5801,35 +6608,40 @@ "type": "Union[str, List[str]]", "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firm_ids", "type": "Union[str, List[str]]", "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "Number of results returned. Limit 1000.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "page", "type": "int", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "fields", "type": "Union[str, List[str]]", "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -5869,35 +6681,40 @@ "type": "datetime", "description": "Date of the last update.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firm_name", "type": "str", "description": "Firm name of the analyst.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name_first", "type": "str", "description": "Analyst first name.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name_last", "type": "str", "description": "Analyst last name.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name_full", "type": "str", "description": "Analyst full name.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "benzinga": [ @@ -5906,357 +6723,408 @@ "type": "str", "description": "ID of the analyst.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firm_id", "type": "str", "description": "ID of the analyst firm.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score", "type": "float", "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_success_rate", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_avg_return_percentile", "type": "float", "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_ratings_percentile", "type": "float", "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_ratings", "type": "int", "description": "Number of recommendations made by this analyst.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_gain_count", "type": "int", "description": "The number of ratings that have gained value since the date of recommendation", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_loss_count", "type": "int", "description": "The number of ratings that have lost value since the date of recommendation", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_average_return", "type": "float", "description": "The average percent (normalized) price difference per rating since the date of recommendation", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_std_dev", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_1m", "type": "int", "description": "The number of ratings that have gained value over the last month", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_1m", "type": "int", "description": "The number of ratings that have lost value over the last month", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_1m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last month", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_1m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_1m", "type": "float", "description": "A weighted average smart score over the last month.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_1m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_3m", "type": "int", "description": "The number of ratings that have gained value over the last 3 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_3m", "type": "int", "description": "The number of ratings that have lost value over the last 3 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_3m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 3 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_3m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_3m", "type": "float", "description": "A weighted average smart score over the last 3 months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_3m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_6m", "type": "int", "description": "The number of ratings that have gained value over the last 6 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_6m", "type": "int", "description": "The number of ratings that have lost value over the last 6 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_6m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 6 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_6m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_9m", "type": "int", "description": "The number of ratings that have gained value over the last 9 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_9m", "type": "int", "description": "The number of ratings that have lost value over the last 9 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_9m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 9 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_9m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_9m", "type": "float", "description": "A weighted average smart score over the last 9 months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_9m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_1y", "type": "int", "description": "The number of ratings that have gained value over the last 1 year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_1y", "type": "int", "description": "The number of ratings that have lost value over the last 1 year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_1y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 1 year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_1y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_1y", "type": "float", "description": "A weighted average smart score over the last 1 year.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_1y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_2y", "type": "int", "description": "The number of ratings that have gained value over the last 2 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_2y", "type": "int", "description": "The number of ratings that have lost value over the last 2 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_2y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 2 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_2y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_2y", "type": "float", "description": "A weighted average smart score over the last 3 years.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_2y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gain_count_3y", "type": "int", "description": "The number of ratings that have gained value over the last 3 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loss_count_3y", "type": "int", "description": "The number of ratings that have lost value over the last 3 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_return_3y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 3 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "std_dev_3y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "smart_score_3y", "type": "float", "description": "A weighted average smart score over the last 3 years.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "success_rate_3y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6276,7 +7144,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -6292,28 +7161,32 @@ "type": "int", "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_period", "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", "description": "The future fiscal period to retrieve estimates for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_year", "type": "int", "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_period", "type": "Literal['q1', 'q2', 'q3', 'q4']", "description": "The future calendar period to retrieve estimates for.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6353,91 +7226,104 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Fiscal quarter for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_period", "type": "str", "description": "Calendar quarter for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low_estimate", "type": "int", "description": "The sales estimate low for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high_estimate", "type": "int", "description": "The sales estimate high for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean", "type": "int", "description": "The sales estimate mean for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "median", "type": "int", "description": "The sales estimate median for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "standard_deviation", "type": "int", "description": "The sales estimate standard deviation for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing estimates for the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -6446,63 +7332,72 @@ "type": "int", "description": "Number of revisions up in the last week.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_1w_down", "type": "int", "description": "Number of revisions down in the last week.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_1w_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 1 week.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_1m_up", "type": "int", "description": "Number of revisions up in the last month.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_1m_down", "type": "int", "description": "Number of revisions down in the last month.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_1m_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 1 month.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_3m_up", "type": "int", "description": "Number of revisions up in the last 3 months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_3m_down", "type": "int", "description": "Number of revisions down in the last 3 months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revisions_3m_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 3 months.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6522,7 +7417,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -6538,21 +7434,24 @@ "type": "Literal['annual', 'quarter']", "description": "The future fiscal period to retrieve estimates for.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "include_historical", "type": "bool", "description": "If True, the data will include all past data and the limit will be ignored.", "default": false, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -6561,28 +7460,32 @@ "type": "int", "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_period", "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", "description": "The future fiscal period to retrieve estimates for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_year", "type": "int", "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_period", "type": "Literal['q1', 'q2', 'q3', 'q4']", "description": "The future calendar period to retrieve estimates for.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6622,91 +7525,104 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Fiscal quarter for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "calendar_period", "type": "str", "description": "Calendar quarter for the estimate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low_estimate", "type": "float", "description": "Estimated EPS low for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high_estimate", "type": "float", "description": "Estimated EPS high for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean", "type": "float", "description": "Estimated EPS mean for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "median", "type": "float", "description": "Estimated EPS median for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "standard_deviation", "type": "float", "description": "Estimated EPS standard deviation for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing estimates for the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [], @@ -6716,35 +7632,40 @@ "type": "float", "description": "The earnings per share (EPS) percent change in estimate for the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean_1w", "type": "float", "description": "The mean estimate for the period one week ago.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean_1m", "type": "float", "description": "The mean estimate for the period one month ago.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean_2m", "type": "float", "description": "The mean estimate for the period two months ago.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mean_3m", "type": "float", "description": "The mean estimate for the period three months ago.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6764,7 +7685,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -6812,49 +7734,56 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year1", "type": "float", "description": "Estimated PE ratio for the next fiscal year.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year2", "type": "float", "description": "Estimated PE ratio two fiscal years from now.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year3", "type": "float", "description": "Estimated PE ratio three fiscal years from now.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year4", "type": "float", "description": "Estimated PE ratio four fiscal years from now.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year5", "type": "float", "description": "Estimated PE ratio five fiscal years from now.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -6863,21 +7792,24 @@ "type": "float", "description": "Estimated Forward PEG ratio for the next fiscal year.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_ttm", "type": "float", "description": "The latest trailing twelve months earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_udpated", "type": "date", "description": "The date the data was last updated.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -6897,7 +7829,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -6945,42 +7878,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -6989,21 +7928,24 @@ "type": "float", "description": "Market Cap.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7023,7 +7965,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7071,42 +8014,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7115,21 +8064,24 @@ "type": "float", "description": "Market Cap.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7149,7 +8101,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7197,42 +8150,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7241,21 +8200,24 @@ "type": "float", "description": "Market Cap displayed in billions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7275,7 +8237,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7323,42 +8286,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7367,21 +8336,24 @@ "type": "float", "description": "Market Cap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7401,7 +8373,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7449,42 +8422,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7493,21 +8472,24 @@ "type": "float", "description": "Market Cap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7527,7 +8509,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7575,42 +8558,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7619,21 +8608,24 @@ "type": "float", "description": "Market Cap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7653,7 +8645,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7701,42 +8694,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price value.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -7745,21 +8744,24 @@ "type": "float", "description": "Market Cap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume_3_months", "type": "float", "description": "Average volume over the last 3 months in millions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "PE Ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7779,28 +8781,32 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "form_type", "type": "str", "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -7816,7 +8822,8 @@ "type": "bool", "description": "Flag for whether or not the filing is done.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -7856,42 +8863,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "title", "type": "str", "description": "Title of the filing.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "datetime", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "form_type", "type": "str", "description": "The form type of the filing", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "link", "type": "str", "description": "URL to the filing page on the SEC site.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -7912,7 +8925,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -7960,427 +8974,488 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "revenue_per_share_ttm", "type": "float", "description": "Revenue per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_per_share_ttm", "type": "float", "description": "Net income per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cash_flow_per_share_ttm", "type": "float", "description": "Operating cash flow per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_per_share_ttm", "type": "float", "description": "Free cash flow per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_per_share_ttm", "type": "float", "description": "Cash per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "book_value_per_share_ttm", "type": "float", "description": "Book value per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tangible_book_value_per_share_ttm", "type": "float", "description": "Tangible book value per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shareholders_equity_per_share_ttm", "type": "float", "description": "Shareholders equity per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_debt_per_share_ttm", "type": "float", "description": "Interest debt per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap_ttm", "type": "float", "description": "Market capitalization calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value_ttm", "type": "float", "description": "Enterprise value calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_sales_ratio_ttm", "type": "float", "description": "Price-to-sales ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pocf_ratio_ttm", "type": "float", "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pfcf_ratio_ttm", "type": "float", "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pb_ratio_ttm", "type": "float", "description": "Price-to-book ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ptb_ratio_ttm", "type": "float", "description": "Price-to-tangible book ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_sales_ttm", "type": "float", "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value_over_ebitda_ttm", "type": "float", "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_operating_cash_flow_ttm", "type": "float", "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_free_cash_flow_ttm", "type": "float", "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_yield_ttm", "type": "float", "description": "Earnings yield calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_yield_ttm", "type": "float", "description": "Free cash flow yield calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_to_equity_ttm", "type": "float", "description": "Debt-to-equity ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_to_assets_ttm", "type": "float", "description": "Debt-to-assets ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_debt_to_ebitda_ttm", "type": "float", "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_ratio_ttm", "type": "float", "description": "Current ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_coverage_ttm", "type": "float", "description": "Interest coverage calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_quality_ttm", "type": "float", "description": "Income quality calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield_ttm", "type": "float", "description": "Dividend yield calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield_percentage_ttm", "type": "float", "description": "Dividend yield percentage calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_to_market_cap_ttm", "type": "float", "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_per_share_ttm", "type": "float", "description": "Dividend per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payout_ratio_ttm", "type": "float", "description": "Payout ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sales_general_and_administrative_to_revenue_ttm", "type": "float", "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "research_and_development_to_revenue_ttm", "type": "float", "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intangibles_to_total_assets_ttm", "type": "float", "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_operating_cash_flow_ttm", "type": "float", "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_revenue_ttm", "type": "float", "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_depreciation_ttm", "type": "float", "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stock_based_compensation_to_revenue_ttm", "type": "float", "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "graham_number_ttm", "type": "float", "description": "Graham number calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "roic_ttm", "type": "float", "description": "Return on invested capital calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_tangible_assets_ttm", "type": "float", "description": "Return on tangible assets calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "graham_net_net_ttm", "type": "float", "description": "Graham net-net working capital calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "working_capital_ttm", "type": "float", "description": "Working capital calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tangible_asset_value_ttm", "type": "float", "description": "Tangible asset value calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_current_asset_value_ttm", "type": "float", "description": "Net current asset value calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "invested_capital_ttm", "type": "float", "description": "Invested capital calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_receivables_ttm", "type": "float", "description": "Average receivables calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_payables_ttm", "type": "float", "description": "Average payables calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_inventory_ttm", "type": "float", "description": "Average inventory calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_sales_outstanding_ttm", "type": "float", "description": "Days sales outstanding calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_payables_outstanding_ttm", "type": "float", "description": "Days payables outstanding calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_of_inventory_on_hand_ttm", "type": "float", "description": "Days of inventory on hand calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "receivables_turnover_ttm", "type": "float", "description": "Receivables turnover calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payables_turnover_ttm", "type": "float", "description": "Payables turnover calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventory_turnover_ttm", "type": "float", "description": "Inventory turnover calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "roe_ttm", "type": "float", "description": "Return on equity calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_per_share_ttm", "type": "float", "description": "Capital expenditures per share calculated as trailing twelve months.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -8401,21 +9476,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -8431,7 +9509,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -8440,14 +9519,16 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -8456,98 +9537,112 @@ "type": "Literal['annual', 'quarter', 'ttm']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -8556,7 +9651,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ] }, @@ -8596,21 +9692,24 @@ "type": "date", "description": "The end date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -8619,350 +9718,400 @@ "type": "date", "description": "The date when the filing was made.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date and time when the filing was accepted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet was reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_and_cash_equivalents", "type": "float", "description": "Cash and cash equivalents.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_investments", "type": "float", "description": "Short term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_and_short_term_investments", "type": "float", "description": "Cash and short term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_receivables", "type": "float", "description": "Net receivables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventory", "type": "float", "description": "Inventory.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_assets", "type": "float", "description": "Other current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_assets", "type": "float", "description": "Total current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "plant_property_equipment_net", "type": "float", "description": "Plant property equipment net.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "goodwill", "type": "float", "description": "Goodwill.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intangible_assets", "type": "float", "description": "Intangible assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "goodwill_and_intangible_assets", "type": "float", "description": "Goodwill and intangible assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_investments", "type": "float", "description": "Long term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tax_assets", "type": "float", "description": "Tax assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_assets", "type": "float", "description": "Other non current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_assets", "type": "float", "description": "Total non current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_assets", "type": "float", "description": "Other assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_assets", "type": "float", "description": "Total assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accounts_payable", "type": "float", "description": "Accounts payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_debt", "type": "float", "description": "Short term debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tax_payables", "type": "float", "description": "Tax payables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_deferred_revenue", "type": "float", "description": "Current deferred revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_liabilities", "type": "float", "description": "Other current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_liabilities", "type": "float", "description": "Total current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt", "type": "float", "description": "Long term debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deferred_revenue_non_current", "type": "float", "description": "Non current deferred revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deferred_tax_liabilities_non_current", "type": "float", "description": "Deferred tax liabilities non current.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_liabilities", "type": "float", "description": "Other non current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_current_liabilities", "type": "float", "description": "Total non current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_liabilities", "type": "float", "description": "Other liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capital_lease_obligations", "type": "float", "description": "Capital lease obligations.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities", "type": "float", "description": "Total liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "preferred_stock", "type": "float", "description": "Preferred stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "common_stock", "type": "float", "description": "Common stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "retained_earnings", "type": "float", "description": "Retained earnings.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accumulated_other_comprehensive_income", "type": "float", "description": "Accumulated other comprehensive income (loss).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_shareholders_equity", "type": "float", "description": "Other shareholders equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_total_shareholders_equity", "type": "float", "description": "Other total shareholders equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_common_equity", "type": "float", "description": "Total common equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_equity_non_controlling_interests", "type": "float", "description": "Total equity non controlling interests.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities_and_shareholders_equity", "type": "float", "description": "Total liabilities and shareholders equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minority_interest", "type": "float", "description": "Minority interest.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities_and_total_equity", "type": "float", "description": "Total liabilities and total equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_investments", "type": "float", "description": "Total investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_debt", "type": "float", "description": "Total debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_debt", "type": "float", "description": "Net debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -8971,630 +10120,720 @@ "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_and_cash_equivalents", "type": "float", "description": "Cash and cash equivalents.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_and_due_from_banks", "type": "float", "description": "Cash and due from banks.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "restricted_cash", "type": "float", "description": "Restricted cash.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_investments", "type": "float", "description": "Short term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "federal_funds_sold", "type": "float", "description": "Federal funds sold.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accounts_receivable", "type": "float", "description": "Accounts receivable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "note_and_lease_receivable", "type": "float", "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventories", "type": "float", "description": "Net Inventories.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "customer_and_other_receivables", "type": "float", "description": "Customer and other receivables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_bearing_deposits_at_other_banks", "type": "float", "description": "Interest bearing deposits at other banks.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "time_deposits_placed_and_other_short_term_investments", "type": "float", "description": "Time deposits placed and other short term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trading_account_securities", "type": "float", "description": "Trading account securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loans_and_leases", "type": "float", "description": "Loans and leases.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "allowance_for_loan_and_lease_losses", "type": "float", "description": "Allowance for loan and lease losses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_deferred_refundable_income_taxes", "type": "float", "description": "Current deferred refundable income taxes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_assets", "type": "float", "description": "Other current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loans_and_leases_net_of_allowance", "type": "float", "description": "Loans and leases net of allowance.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accrued_investment_income", "type": "float", "description": "Accrued investment income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_non_operating_assets", "type": "float", "description": "Other current non-operating assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loans_held_for_sale", "type": "float", "description": "Loans held for sale.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prepaid_expenses", "type": "float", "description": "Prepaid expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_assets", "type": "float", "description": "Total current assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "plant_property_equipment_gross", "type": "float", "description": "Plant property equipment gross.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accumulated_depreciation", "type": "float", "description": "Accumulated depreciation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "premises_and_equipment_net", "type": "float", "description": "Net premises and equipment.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "plant_property_equipment_net", "type": "float", "description": "Net plant property equipment.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_investments", "type": "float", "description": "Long term investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mortgage_servicing_rights", "type": "float", "description": "Mortgage servicing rights.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unearned_premiums_asset", "type": "float", "description": "Unearned premiums asset.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_note_lease_receivables", "type": "float", "description": "Non-current note lease receivables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deferred_acquisition_cost", "type": "float", "description": "Deferred acquisition cost.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "goodwill", "type": "float", "description": "Goodwill.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "separate_account_business_assets", "type": "float", "description": "Separate account business assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_deferred_refundable_income_taxes", "type": "float", "description": "Noncurrent deferred refundable income taxes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intangible_assets", "type": "float", "description": "Intangible assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "employee_benefit_assets", "type": "float", "description": "Employee benefit assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_assets", "type": "float", "description": "Other assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_operating_assets", "type": "float", "description": "Other noncurrent operating assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_non_operating_assets", "type": "float", "description": "Other noncurrent non-operating assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_bearing_deposits", "type": "float", "description": "Interest bearing deposits.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_current_assets", "type": "float", "description": "Total noncurrent assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_assets", "type": "float", "description": "Total assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_interest_bearing_deposits", "type": "float", "description": "Non interest bearing deposits.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "federal_funds_purchased_and_securities_sold", "type": "float", "description": "Federal funds purchased and securities sold.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bankers_acceptance_outstanding", "type": "float", "description": "Bankers acceptance outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_debt", "type": "float", "description": "Short term debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accounts_payable", "type": "float", "description": "Accounts payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_deferred_revenue", "type": "float", "description": "Current deferred revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_deferred_payable_income_tax_liabilities", "type": "float", "description": "Current deferred payable income tax liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accrued_interest_payable", "type": "float", "description": "Accrued interest payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accrued_expenses", "type": "float", "description": "Accrued expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_short_term_payables", "type": "float", "description": "Other short term payables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "customer_deposits", "type": "float", "description": "Customer deposits.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividends_payable", "type": "float", "description": "Dividends payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "claims_and_claim_expense", "type": "float", "description": "Claims and claim expense.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "future_policy_benefits", "type": "float", "description": "Future policy benefits.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_employee_benefit_liabilities", "type": "float", "description": "Current employee benefit liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unearned_premiums_liability", "type": "float", "description": "Unearned premiums liability.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_taxes_payable", "type": "float", "description": "Other taxes payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "policy_holder_funds", "type": "float", "description": "Policy holder funds.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_liabilities", "type": "float", "description": "Other current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_non_operating_liabilities", "type": "float", "description": "Other current non-operating liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "separate_account_business_liabilities", "type": "float", "description": "Separate account business liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_liabilities", "type": "float", "description": "Total current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt", "type": "float", "description": "Long term debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_long_term_liabilities", "type": "float", "description": "Other long term liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_deferred_revenue", "type": "float", "description": "Non-current deferred revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_deferred_payable_income_tax_liabilities", "type": "float", "description": "Non-current deferred payable income tax liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_current_employee_benefit_liabilities", "type": "float", "description": "Non-current employee benefit liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_operating_liabilities", "type": "float", "description": "Other non-current operating liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_non_operating_liabilities", "type": "float", "description": "Other non-current, non-operating liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_current_liabilities", "type": "float", "description": "Total non-current liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capital_lease_obligations", "type": "float", "description": "Capital lease obligations.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_retirement_reserve_litigation_obligation", "type": "float", "description": "Asset retirement reserve litigation obligation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities", "type": "float", "description": "Total liabilities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "commitments_contingencies", "type": "float", "description": "Commitments contingencies.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "redeemable_non_controlling_interest", "type": "float", "description": "Redeemable non-controlling interest.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "preferred_stock", "type": "float", "description": "Preferred stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "common_stock", "type": "float", "description": "Common stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "retained_earnings", "type": "float", "description": "Retained earnings.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "treasury_stock", "type": "float", "description": "Treasury stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accumulated_other_comprehensive_income", "type": "float", "description": "Accumulated other comprehensive income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "participating_policy_holder_equity", "type": "float", "description": "Participating policy holder equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_equity_adjustments", "type": "float", "description": "Other equity adjustments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_common_equity", "type": "float", "description": "Total common equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_preferred_common_equity", "type": "float", "description": "Total preferred common equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_controlling_interest", "type": "float", "description": "Non-controlling interest.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_equity_non_controlling_interests", "type": "float", "description": "Total equity non-controlling interests.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities_shareholders_equity", "type": "float", "description": "Total liabilities and shareholders equity.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -9603,203 +10842,232 @@ "type": "int", "description": "Accounts receivable", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "marketable_securities", "type": "int", "description": "Marketable securities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prepaid_expenses", "type": "int", "description": "Prepaid expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_assets", "type": "int", "description": "Other current assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_assets", "type": "int", "description": "Total current assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "property_plant_equipment_net", "type": "int", "description": "Property plant and equipment net", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventory", "type": "int", "description": "Inventory", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_assets", "type": "int", "description": "Other non-current assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_current_assets", "type": "int", "description": "Total non-current assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intangible_assets", "type": "int", "description": "Intangible assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_assets", "type": "int", "description": "Total assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accounts_payable", "type": "int", "description": "Accounts payable", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "employee_wages", "type": "int", "description": "Employee wages", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_current_liabilities", "type": "int", "description": "Other current liabilities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_current_liabilities", "type": "int", "description": "Total current liabilities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_current_liabilities", "type": "int", "description": "Other non-current liabilities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_current_liabilities", "type": "int", "description": "Total non-current liabilities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt", "type": "int", "description": "Long term debt", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities", "type": "int", "description": "Total liabilities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "minority_interest", "type": "int", "description": "Minority interest", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "temporary_equity_attributable_to_parent", "type": "int", "description": "Temporary equity attributable to parent", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "equity_attributable_to_parent", "type": "int", "description": "Equity attributable to parent", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "temporary_equity", "type": "int", "description": "Temporary equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "preferred_stock", "type": "int", "description": "Preferred stock", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "redeemable_non_controlling_interest", "type": "int", "description": "Redeemable non-controlling interest", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "redeemable_non_controlling_interest_other", "type": "int", "description": "Redeemable non-controlling interest other", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_stock_holders_equity", "type": "int", "description": "Total stock holders equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_liabilities_and_stock_holders_equity", "type": "int", "description": "Total liabilities and stockholders equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_equity", "type": "int", "description": "Total equity", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -9820,14 +11088,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -9875,294 +11145,336 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cash_and_cash_equivalents", "type": "float", "description": "Growth rate of cash and cash equivalents.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_short_term_investments", "type": "float", "description": "Growth rate of short-term investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cash_and_short_term_investments", "type": "float", "description": "Growth rate of cash and short-term investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_receivables", "type": "float", "description": "Growth rate of net receivables.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_inventory", "type": "float", "description": "Growth rate of inventory.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_current_assets", "type": "float", "description": "Growth rate of other current assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_current_assets", "type": "float", "description": "Growth rate of total current assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_property_plant_equipment_net", "type": "float", "description": "Growth rate of net property, plant, and equipment.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_goodwill", "type": "float", "description": "Growth rate of goodwill.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_intangible_assets", "type": "float", "description": "Growth rate of intangible assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_goodwill_and_intangible_assets", "type": "float", "description": "Growth rate of goodwill and intangible assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_long_term_investments", "type": "float", "description": "Growth rate of long-term investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_tax_assets", "type": "float", "description": "Growth rate of tax assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_non_current_assets", "type": "float", "description": "Growth rate of other non-current assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_non_current_assets", "type": "float", "description": "Growth rate of total non-current assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_assets", "type": "float", "description": "Growth rate of other assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_assets", "type": "float", "description": "Growth rate of total assets.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_account_payables", "type": "float", "description": "Growth rate of accounts payable.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_short_term_debt", "type": "float", "description": "Growth rate of short-term debt.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_tax_payables", "type": "float", "description": "Growth rate of tax payables.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_deferred_revenue", "type": "float", "description": "Growth rate of deferred revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_current_liabilities", "type": "float", "description": "Growth rate of other current liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_current_liabilities", "type": "float", "description": "Growth rate of total current liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_long_term_debt", "type": "float", "description": "Growth rate of long-term debt.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_deferred_revenue_non_current", "type": "float", "description": "Growth rate of non-current deferred revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_deferrred_tax_liabilities_non_current", "type": "float", "description": "Growth rate of non-current deferred tax liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_non_current_liabilities", "type": "float", "description": "Growth rate of other non-current liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_non_current_liabilities", "type": "float", "description": "Growth rate of total non-current liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_liabilities", "type": "float", "description": "Growth rate of other liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_liabilities", "type": "float", "description": "Growth rate of total liabilities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_common_stock", "type": "float", "description": "Growth rate of common stock.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_retained_earnings", "type": "float", "description": "Growth rate of retained earnings.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_accumulated_other_comprehensive_income_loss", "type": "float", "description": "Growth rate of accumulated other comprehensive income/loss.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_othertotal_stockholders_equity", "type": "float", "description": "Growth rate of other total stockholders' equity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_stockholders_equity", "type": "float", "description": "Growth rate of total stockholders' equity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_liabilities_and_stockholders_equity", "type": "float", "description": "Growth rate of total liabilities and stockholders' equity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_investments", "type": "float", "description": "Growth rate of total investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_debt", "type": "float", "description": "Growth rate of total debt.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_debt", "type": "float", "description": "Growth rate of net debt.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -10183,21 +11495,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -10213,7 +11528,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -10222,14 +11538,16 @@ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -10238,98 +11556,112 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -10338,7 +11670,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ] }, @@ -10378,21 +11711,24 @@ "type": "date", "description": "The end date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -10401,252 +11737,288 @@ "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "The date of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date the filing was accepted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the cash flow statement was reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income", "type": "float", "description": "Net income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and amortization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deferred_income_tax", "type": "float", "description": "Deferred income tax.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stock_based_compensation", "type": "float", "description": "Stock-based compensation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_working_capital", "type": "float", "description": "Change in working capital.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_account_receivables", "type": "float", "description": "Change in account receivables.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_inventory", "type": "float", "description": "Change in inventory.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_account_payable", "type": "float", "description": "Change in account payable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_other_working_capital", "type": "float", "description": "Change in other working capital.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_in_other_non_cash_items", "type": "float", "description": "Change in other non-cash items.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_operating_activities", "type": "float", "description": "Net cash from operating activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "purchase_of_property_plant_and_equipment", "type": "float", "description": "Purchase of property, plant and equipment.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "acquisitions", "type": "float", "description": "Acquisitions.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "purchase_of_investment_securities", "type": "float", "description": "Purchase of investment securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sale_and_maturity_of_investments", "type": "float", "description": "Sale and maturity of investments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_investing_activities", "type": "float", "description": "Other investing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_investing_activities", "type": "float", "description": "Net cash from investing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repayment_of_debt", "type": "float", "description": "Repayment of debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuance_of_common_equity", "type": "float", "description": "Issuance of common equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repurchase_of_common_equity", "type": "float", "description": "Repurchase of common equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payment_of_dividends", "type": "float", "description": "Payment of dividends.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_financing_activities", "type": "float", "description": "Other financing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_financing_activities", "type": "float", "description": "Net cash from financing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", "description": "Effect of exchange rate changes on cash.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_change_in_cash_and_equivalents", "type": "float", "description": "Net change in cash and equivalents.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_at_beginning_of_period", "type": "float", "description": "Cash at beginning of period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_at_end_of_period", "type": "float", "description": "Cash at end of period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cash_flow", "type": "float", "description": "Operating cash flow.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capital_expenditure", "type": "float", "description": "Capital expenditure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow", "type": "float", "description": "None", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -10655,315 +12027,360 @@ "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_continuing_operations", "type": "float", "description": "Net Income (Continuing Operations)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_discontinued_operations", "type": "float", "description": "Net Income (Discontinued Operations)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income", "type": "float", "description": "Consolidated Net Income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provision_for_loan_losses", "type": "float", "description": "Provision for Loan Losses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provision_for_credit_losses", "type": "float", "description": "Provision for credit losses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depreciation_expense", "type": "float", "description": "Depreciation Expense.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "amortization_expense", "type": "float", "description": "Amortization Expense.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_based_compensation", "type": "float", "description": "Share-based compensation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_cash_adjustments_to_reconcile_net_income", "type": "float", "description": "Non-Cash Adjustments to Reconcile Net Income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "changes_in_operating_assets_and_liabilities", "type": "float", "description": "Changes in Operating Assets and Liabilities (Net)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_continuing_operating_activities", "type": "float", "description": "Net Cash from Continuing Operating Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_discontinued_operating_activities", "type": "float", "description": "Net Cash from Discontinued Operating Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_operating_activities", "type": "float", "description": "Net Cash from Operating Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "divestitures", "type": "float", "description": "Divestitures", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sale_of_property_plant_and_equipment", "type": "float", "description": "Sale of Property, Plant, and Equipment", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "acquisitions", "type": "float", "description": "Acquisitions", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "purchase_of_investments", "type": "float", "description": "Purchase of Investments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "purchase_of_investment_securities", "type": "float", "description": "Purchase of Investment Securities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sale_and_maturity_of_investments", "type": "float", "description": "Sale and Maturity of Investments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loans_held_for_sale", "type": "float", "description": "Loans Held for Sale (Net)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "purchase_of_property_plant_and_equipment", "type": "float", "description": "Purchase of Property, Plant, and Equipment", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_investing_activities", "type": "float", "description": "Other Investing Activities (Net)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_continuing_investing_activities", "type": "float", "description": "Net Cash from Continuing Investing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_discontinued_investing_activities", "type": "float", "description": "Net Cash from Discontinued Investing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_investing_activities", "type": "float", "description": "Net Cash from Investing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payment_of_dividends", "type": "float", "description": "Payment of Dividends", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repurchase_of_common_equity", "type": "float", "description": "Repurchase of Common Equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repurchase_of_preferred_equity", "type": "float", "description": "Repurchase of Preferred Equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuance_of_common_equity", "type": "float", "description": "Issuance of Common Equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuance_of_preferred_equity", "type": "float", "description": "Issuance of Preferred Equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuance_of_debt", "type": "float", "description": "Issuance of Debt", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repayment_of_debt", "type": "float", "description": "Repayment of Debt", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_financing_activities", "type": "float", "description": "Other Financing Activities (Net)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_interest_received", "type": "float", "description": "Cash Interest Received", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_change_in_deposits", "type": "float", "description": "Net Change in Deposits", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_increase_in_fed_funds_sold", "type": "float", "description": "Net Increase in Fed Funds Sold", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_continuing_financing_activities", "type": "float", "description": "Net Cash from Continuing Financing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_discontinued_financing_activities", "type": "float", "description": "Net Cash from Discontinued Financing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_from_financing_activities", "type": "float", "description": "Net Cash from Financing Activities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "effect_of_exchange_rate_changes", "type": "float", "description": "Effect of Exchange Rate Changes", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_net_changes_in_cash", "type": "float", "description": "Other Net Changes in Cash", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_change_in_cash_and_equivalents", "type": "float", "description": "Net Change in Cash and Equivalents", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_income_taxes_paid", "type": "float", "description": "Cash Income Taxes Paid", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_interest_paid", "type": "float", "description": "Cash Interest Paid", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -10972,91 +12389,104 @@ "type": "int", "description": "Net cash flow from operating activities continuing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_operating_activities_discontinued", "type": "int", "description": "Net cash flow from operating activities discontinued.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_operating_activities", "type": "int", "description": "Net cash flow from operating activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_investing_activities_continuing", "type": "int", "description": "Net cash flow from investing activities continuing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_investing_activities_discontinued", "type": "int", "description": "Net cash flow from investing activities discontinued.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_investing_activities", "type": "int", "description": "Net cash flow from investing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_financing_activities_continuing", "type": "int", "description": "Net cash flow from financing activities continuing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_financing_activities_discontinued", "type": "int", "description": "Net cash flow from financing activities discontinued.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_from_financing_activities", "type": "int", "description": "Net cash flow from financing activities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_continuing", "type": "int", "description": "Net cash flow continuing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow_discontinued", "type": "int", "description": "Net cash flow discontinued.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_gains_losses", "type": "int", "description": "Exchange gains losses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_cash_flow", "type": "int", "description": "Net cash flow.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -11077,28 +12507,32 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "statement_type", "type": "str", "description": "The type of financial statement - i.e, balance, income, cash.", "default": "balance", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -11114,21 +12548,24 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "statement_type", "type": "Literal['balance', 'income', 'cash']", "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", "default": "income", - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -11168,21 +12605,24 @@ "type": "date", "description": "The ending date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [] @@ -11203,14 +12643,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -11258,231 +12700,264 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Period the statement is returned for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_income", "type": "float", "description": "Growth rate of net income.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_depreciation_and_amortization", "type": "float", "description": "Growth rate of depreciation and amortization.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_deferred_income_tax", "type": "float", "description": "Growth rate of deferred income tax.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_stock_based_compensation", "type": "float", "description": "Growth rate of stock-based compensation.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_change_in_working_capital", "type": "float", "description": "Growth rate of change in working capital.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_accounts_receivables", "type": "float", "description": "Growth rate of accounts receivables.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_inventory", "type": "float", "description": "Growth rate of inventory.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_accounts_payables", "type": "float", "description": "Growth rate of accounts payables.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_working_capital", "type": "float", "description": "Growth rate of other working capital.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_non_cash_items", "type": "float", "description": "Growth rate of other non-cash items.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_cash_provided_by_operating_activities", "type": "float", "description": "Growth rate of net cash provided by operating activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_investments_in_property_plant_and_equipment", "type": "float", "description": "Growth rate of investments in property, plant, and equipment.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_acquisitions_net", "type": "float", "description": "Growth rate of net acquisitions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_purchases_of_investments", "type": "float", "description": "Growth rate of purchases of investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_sales_maturities_of_investments", "type": "float", "description": "Growth rate of sales maturities of investments.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_investing_activities", "type": "float", "description": "Growth rate of other investing activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_cash_used_for_investing_activities", "type": "float", "description": "Growth rate of net cash used for investing activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_debt_repayment", "type": "float", "description": "Growth rate of debt repayment.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_common_stock_issued", "type": "float", "description": "Growth rate of common stock issued.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_common_stock_repurchased", "type": "float", "description": "Growth rate of common stock repurchased.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_dividends_paid", "type": "float", "description": "Growth rate of dividends paid.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_financing_activities", "type": "float", "description": "Growth rate of other financing activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_cash_used_provided_by_financing_activities", "type": "float", "description": "Growth rate of net cash used/provided by financing activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_effect_of_forex_changes_on_cash", "type": "float", "description": "Growth rate of the effect of foreign exchange changes on cash.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_change_in_cash", "type": "float", "description": "Growth rate of net change in cash.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cash_at_end_of_period", "type": "float", "description": "Growth rate of cash at the end of the period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cash_at_beginning_of_period", "type": "float", "description": "Growth rate of cash at the beginning of the period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_operating_cash_flow", "type": "float", "description": "Growth rate of operating cash flow.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_capital_expenditure", "type": "float", "description": "Growth rate of capital expenditure.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_free_cash_flow", "type": "float", "description": "Growth rate of free cash flow.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -11503,21 +12978,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -11534,7 +13012,8 @@ "type": "int", "description": "The number of data entries to return.", "default": 100, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -11575,14 +13054,16 @@ "type": "date", "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "amount", "type": "float", "description": "The dividend amount per share.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [ @@ -11591,35 +13072,40 @@ "type": "str", "description": "Label of the historical dividends.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "adj_dividend", "type": "float", "description": "Adjusted dividend of the historical dividends.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "record_date", "type": "date", "description": "Record date of the historical dividends.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payment_date", "type": "date", "description": "Payment date of the historical dividends.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "declaration_date", "type": "date", "description": "Declaration date of the historical dividends.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -11628,21 +13114,24 @@ "type": "float", "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the dividend is paid.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "float", "description": "The ratio of the stock split, if a stock split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -11663,7 +13152,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -11679,7 +13169,8 @@ "type": "int", "description": "The number of data entries to return.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -11719,35 +13210,40 @@ "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "announce_time", "type": "str", "description": "Timing of the earnings announcement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_actual", "type": "float", "description": "Actual EPS from the earnings date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_estimated", "type": "float", "description": "Estimated EPS for the earnings date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -11756,35 +13252,40 @@ "type": "float", "description": "Estimated consensus revenue for the reporting period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_actual", "type": "float", "description": "The actual reported revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reporting_time", "type": "str", "description": "The reporting time - e.g. after market close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated_at", "type": "date", "description": "The date when the data was last updated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_ending", "type": "date", "description": "The fiscal period end date.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -11804,7 +13305,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -11852,63 +13354,72 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "acceptance_time", "type": "datetime", "description": "Time of acceptance of the company employee.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period_of_report", "type": "date", "description": "Date of reporting of the company employee.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "company_name", "type": "str", "description": "Registered name of the company to retrieve the historical employees of.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "form_type", "type": "str", "description": "Form type of the company employee.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the company employee", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "employee_count", "type": "int", "description": "Count of employees of the company.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "source", "type": "str", "description": "Source URL which retrieves this data for the company.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -11929,14 +13440,16 @@ "type": "str", "description": "Query to search for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 1000, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -11984,77 +13497,88 @@ "type": "str", "description": "ID of the financial attribute.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the financial attribute.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tag", "type": "str", "description": "Tag of the financial attribute.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "statement_code", "type": "str", "description": "Code of the financial statement.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "statement_type", "type": "str", "description": "Type of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "parent_name", "type": "str", "description": "Parent's name of the financial attribute.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sequence", "type": "int", "description": "Sequence of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "factor", "type": "str", "description": "Unit of the financial attribute.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "transaction", "type": "str", "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "type", "type": "str", "description": "Type of the financial attribute.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unit", "type": "str", "description": "Unit of the financial attribute.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [] @@ -12075,14 +13599,16 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tag", "type": "Union[str, List[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -12130,21 +13656,24 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tag", "type": "str", "description": "Tag name for the fetched data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "Union[str, float]", "description": "The value of the data.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [] @@ -12165,56 +13694,64 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tag", "type": "Union[str, List[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "frequency", "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", "description": "The frequency of the data.", "default": "yearly", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 1000, - "optional": true + "optional": true, + "choices": null }, { "name": "tag_type", "type": "str", "description": "Filter by type, when applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -12262,28 +13799,32 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tag", "type": "str", "description": "Tag name for the fetched data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "The value of the data.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [] @@ -12304,21 +13845,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -12334,7 +13878,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -12343,14 +13888,16 @@ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -12359,98 +13906,112 @@ "type": "Literal['annual', 'quarter', 'ttm']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -12459,7 +14020,8 @@ "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", - "optional": true + "optional": true, + "choices": null } ] }, @@ -12499,21 +14061,24 @@ "type": "date", "description": "The end date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -12522,231 +14087,264 @@ "type": "date", "description": "The date when the filing was made.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date and time when the filing was accepted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet was reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue", "type": "float", "description": "Total revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Cost of revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit", "type": "float", "description": "Gross profit.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross profit margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "general_and_admin_expense", "type": "float", "description": "General and administrative expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "research_and_development_expense", "type": "float", "description": "Research and development expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "selling_and_marketing_expense", "type": "float", "description": "Selling and marketing expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "selling_general_and_admin_expense", "type": "float", "description": "Selling, general and administrative expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_expenses", "type": "float", "description": "Other expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_operating_expenses", "type": "float", "description": "Total operating expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_and_expenses", "type": "float", "description": "Cost and expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_income", "type": "float", "description": "Interest income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Total interest expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and amortization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda", "type": "float", "description": "EBITDA.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "EBITDA margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_operating_income", "type": "float", "description": "Total operating income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_income_margin", "type": "float", "description": "Operating income margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_other_income_expenses", "type": "float", "description": "Total other income and expenses.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Total pre-tax income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pre_tax_income_margin", "type": "float", "description": "Pre-tax income margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income tax expense.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Consolidated net income.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_margin", "type": "float", "description": "Net income margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Basic earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Weighted average basic shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Weighted average diluted shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -12755,553 +14353,632 @@ "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue", "type": "float", "description": "Total revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_revenue", "type": "float", "description": "Total operating revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Total cost of revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cost_of_revenue", "type": "float", "description": "Total operating cost of revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit", "type": "float", "description": "Total gross profit", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross margin ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provision_for_credit_losses", "type": "float", "description": "Provision for credit losses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "research_and_development_expense", "type": "float", "description": "Research and development expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "selling_general_and_admin_expense", "type": "float", "description": "Selling, general, and admin expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "salaries_and_employee_benefits", "type": "float", "description": "Salaries and employee benefits", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "marketing_expense", "type": "float", "description": "Marketing expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_occupancy_and_equipment_expense", "type": "float", "description": "Net occupancy and equipment expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_operating_expenses", "type": "float", "description": "Other operating expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depreciation_expense", "type": "float", "description": "Depreciation expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "amortization_expense", "type": "float", "description": "Amortization expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "amortization_of_deferred_policy_acquisition_costs", "type": "float", "description": "Amortization of deferred policy acquisition costs", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exploration_expense", "type": "float", "description": "Exploration expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depletion_expense", "type": "float", "description": "Depletion expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_operating_expenses", "type": "float", "description": "Total operating expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_operating_income", "type": "float", "description": "Total operating income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deposits_and_money_market_investments_interest_income", "type": "float", "description": "Deposits and money market investments interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "federal_funds_sold_and_securities_borrowed_interest_income", "type": "float", "description": "Federal funds sold and securities borrowed interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "investment_securities_interest_income", "type": "float", "description": "Investment securities interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loans_and_leases_interest_income", "type": "float", "description": "Loans and leases interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trading_account_interest_income", "type": "float", "description": "Trading account interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_interest_income", "type": "float", "description": "Other interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_interest_income", "type": "float", "description": "Total non-interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_and_investment_income", "type": "float", "description": "Interest and investment income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_borrowings_interest_expense", "type": "float", "description": "Short-term borrowings interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt_interest_expense", "type": "float", "description": "Long-term debt interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capitalized_lease_obligations_interest_expense", "type": "float", "description": "Capitalized lease obligations interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deposits_interest_expense", "type": "float", "description": "Deposits interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "federal_funds_purchased_and_securities_sold_interest_expense", "type": "float", "description": "Federal funds purchased and securities sold interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_interest_expense", "type": "float", "description": "Other interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Total interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_interest_income", "type": "float", "description": "Net interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_non_interest_income", "type": "float", "description": "Other non-interest income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "investment_banking_income", "type": "float", "description": "Investment banking income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trust_fees_by_commissions", "type": "float", "description": "Trust fees by commissions", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "premiums_earned", "type": "float", "description": "Premiums earned", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "insurance_policy_acquisition_costs", "type": "float", "description": "Insurance policy acquisition costs", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_and_future_benefits", "type": "float", "description": "Current and future benefits", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "property_and_liability_insurance_claims", "type": "float", "description": "Property and liability insurance claims", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_non_interest_expense", "type": "float", "description": "Total non-interest expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_realized_and_unrealized_capital_gains_on_investments", "type": "float", "description": "Net realized and unrealized capital gains on investments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_gains", "type": "float", "description": "Other gains", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_operating_income", "type": "float", "description": "Non-operating income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_income", "type": "float", "description": "Other income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_revenue", "type": "float", "description": "Other revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "extraordinary_income", "type": "float", "description": "Extraordinary income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_other_income", "type": "float", "description": "Total other income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda", "type": "float", "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Total pre-tax income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebit", "type": "float", "description": "Earnings Before Interest and Taxes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pre_tax_income_margin", "type": "float", "description": "Pre-Tax Income Margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income tax expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "impairment_charge", "type": "float", "description": "Impairment charge", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "restructuring_charge", "type": "float", "description": "Restructuring charge", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "service_charges_on_deposit_accounts", "type": "float", "description": "Service charges on deposit accounts", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_service_charges", "type": "float", "description": "Other service charges", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_special_charges", "type": "float", "description": "Other special charges", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_cost_of_revenue", "type": "float", "description": "Other cost of revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_continuing_operations", "type": "float", "description": "Net income (continuing operations)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_discontinued_operations", "type": "float", "description": "Net income (discontinued operations)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Consolidated net income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_adjustments_to_consolidated_net_income", "type": "float", "description": "Other adjustments to consolidated net income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", "type": "float", "description": "Other adjustment to net income attributable to common shareholders", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_attributable_to_noncontrolling_interest", "type": "float", "description": "Net income attributable to noncontrolling interest", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_attributable_to_common_shareholders", "type": "float", "description": "Net income attributable to common shareholders", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Basic earnings per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted earnings per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "basic_and_diluted_earnings_per_share", "type": "float", "description": "Basic and diluted earnings per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_dividends_to_common_per_share", "type": "float", "description": "Cash dividends to common per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "preferred_stock_dividends_declared", "type": "float", "description": "Preferred stock dividends declared", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Weighted average basic shares outstanding", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Weighted average diluted shares outstanding", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_basic_and_diluted_shares_outstanding", "type": "float", "description": "Weighted average basic and diluted shares outstanding", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -13310,301 +14987,344 @@ "type": "float", "description": "Total Revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_of_revenue_goods", "type": "float", "description": "Cost of Revenue - Goods", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_of_revenue_services", "type": "float", "description": "Cost of Revenue - Services", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Cost of Revenue", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit", "type": "float", "description": "Gross Profit", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provisions_for_loan_lease_and_other_losses", "type": "float", "description": "Provisions for loan lease and other losses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and Amortization", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_tax_expense_benefit_current", "type": "float", "description": "Income tax expense benefit current", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deferred_tax_benefit", "type": "float", "description": "Deferred tax benefit", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "benefits_costs_expenses", "type": "float", "description": "Benefits, costs and expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "selling_general_and_administrative_expense", "type": "float", "description": "Selling, general and administrative expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "research_and_development", "type": "float", "description": "Research and development", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "costs_and_expenses", "type": "float", "description": "Costs and expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_operating_expenses", "type": "float", "description": "Other Operating Expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_expenses", "type": "float", "description": "Operating expenses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_income", "type": "float", "description": "Operating Income/Loss", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_operating_income", "type": "float", "description": "Non Operating Income/Loss", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_and_dividend_income", "type": "float", "description": "Interest and Dividend Income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Interest Expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_and_debt_expense", "type": "float", "description": "Interest and Debt Expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_interest_income", "type": "float", "description": "Interest Income Net", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_income_after_provision_for_losses", "type": "float", "description": "Interest Income After Provision for Losses", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_interest_expense", "type": "float", "description": "Non-Interest Expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "non_interest_income", "type": "float", "description": "Non-Interest Income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_from_discontinued_operations_net_of_tax_on_disposal", "type": "float", "description": "Income From Discontinued Operations Net of Tax on Disposal", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_from_discontinued_operations_net_of_tax", "type": "float", "description": "Income From Discontinued Operations Net of Tax", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_before_equity_method_investments", "type": "float", "description": "Income Before Equity Method Investments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_from_equity_method_investments", "type": "float", "description": "Income From Equity Method Investments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Income Before Tax", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income Tax Expense", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_after_tax", "type": "float", "description": "Income After Tax", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Net Income/Loss", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_attributable_noncontrolling_interest", "type": "float", "description": "Net income (loss) attributable to noncontrolling interest", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_attributable_to_parent", "type": "float", "description": "Net income (loss) attributable to parent", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_attributable_to_common_shareholders", "type": "float", "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "participating_securities_earnings", "type": "float", "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "undistributed_earnings_allocated_to_participating_securities", "type": "float", "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "common_stock_dividends", "type": "float", "description": "Common Stock Dividends", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "preferred_stock_dividends_and_other_adjustments", "type": "float", "description": "Preferred stock dividends and other adjustments", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Earnings Per Share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted Earnings Per Share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Basic Average Shares", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Diluted Average Shares", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -13625,21 +15345,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, - "optional": true + "optional": true, + "choices": null }, { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -13687,203 +15410,232 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Period the statement is returned for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_revenue", "type": "float", "description": "Growth rate of total revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cost_of_revenue", "type": "float", "description": "Growth rate of cost of goods sold.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_gross_profit", "type": "float", "description": "Growth rate of gross profit.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_gross_profit_ratio", "type": "float", "description": "Growth rate of gross profit as a percentage of revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_research_and_development_expenses", "type": "float", "description": "Growth rate of expenses on research and development.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_general_and_administrative_expenses", "type": "float", "description": "Growth rate of general and administrative expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_selling_and_marketing_expenses", "type": "float", "description": "Growth rate of expenses on selling and marketing activities.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_other_expenses", "type": "float", "description": "Growth rate of other operating expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_operating_expenses", "type": "float", "description": "Growth rate of total operating expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_cost_and_expenses", "type": "float", "description": "Growth rate of total costs and expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_interest_expense", "type": "float", "description": "Growth rate of interest expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_depreciation_and_amortization", "type": "float", "description": "Growth rate of depreciation and amortization expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_ebitda", "type": "float", "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_ebitda_ratio", "type": "float", "description": "Growth rate of EBITDA as a percentage of revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_operating_income", "type": "float", "description": "Growth rate of operating income.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_operating_income_ratio", "type": "float", "description": "Growth rate of operating income as a percentage of revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_total_other_income_expenses_net", "type": "float", "description": "Growth rate of net total other income and expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_income_before_tax", "type": "float", "description": "Growth rate of income before taxes.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_income_before_tax_ratio", "type": "float", "description": "Growth rate of income before taxes as a percentage of revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_income_tax_expense", "type": "float", "description": "Growth rate of income tax expenses.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_income", "type": "float", "description": "Growth rate of net income.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_net_income_ratio", "type": "float", "description": "Growth rate of net income as a percentage of revenue.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_eps", "type": "float", "description": "Growth rate of Earnings Per Share (EPS).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_eps_diluted", "type": "float", "description": "Growth rate of diluted Earnings Per Share (EPS).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_weighted_average_shs_out", "type": "float", "description": "Growth rate of weighted average shares outstanding.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "growth_weighted_average_shs_out_dil", "type": "float", "description": "Growth rate of diluted weighted average shares outstanding.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -13904,21 +15656,24 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -13934,7 +15689,8 @@ "type": "bool", "description": "Include trailing twelve months (TTM) data.", "default": false, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [], @@ -13976,21 +15732,24 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "float", "description": "Market capitalization", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe_ratio", "type": "float", "description": "Price-to-earnings ratio (P/E ratio)", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -13999,406 +15758,464 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Period of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_per_share", "type": "float", "description": "Revenue per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_per_share", "type": "float", "description": "Net income per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cash_flow_per_share", "type": "float", "description": "Operating cash flow per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_per_share", "type": "float", "description": "Free cash flow per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "book_value_per_share", "type": "float", "description": "Book value per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tangible_book_value_per_share", "type": "float", "description": "Tangible book value per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shareholders_equity_per_share", "type": "float", "description": "Shareholders equity per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_debt_per_share", "type": "float", "description": "Interest debt per share", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value", "type": "float", "description": "Enterprise value", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_sales_ratio", "type": "float", "description": "Price-to-sales ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pocf_ratio", "type": "float", "description": "Price-to-operating cash flow ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pfcf_ratio", "type": "float", "description": "Price-to-free cash flow ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pb_ratio", "type": "float", "description": "Price-to-book ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ptb_ratio", "type": "float", "description": "Price-to-tangible book ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_sales", "type": "float", "description": "Enterprise value-to-sales ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value_over_ebitda", "type": "float", "description": "Enterprise value-to-EBITDA ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_operating_cash_flow", "type": "float", "description": "Enterprise value-to-operating cash flow ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ev_to_free_cash_flow", "type": "float", "description": "Enterprise value-to-free cash flow ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_yield", "type": "float", "description": "Earnings yield", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_yield", "type": "float", "description": "Free cash flow yield", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_to_equity", "type": "float", "description": "Debt-to-equity ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_to_assets", "type": "float", "description": "Debt-to-assets ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_debt_to_ebitda", "type": "float", "description": "Net debt-to-EBITDA ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_ratio", "type": "float", "description": "Current ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_coverage", "type": "float", "description": "Interest coverage", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_quality", "type": "float", "description": "Income quality", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sales_general_and_administrative_to_revenue", "type": "float", "description": "Sales general and administrative expenses-to-revenue ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "research_and_development_to_revenue", "type": "float", "description": "Research and development expenses-to-revenue ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intangibles_to_total_assets", "type": "float", "description": "Intangibles-to-total assets ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_operating_cash_flow", "type": "float", "description": "Capital expenditures-to-operating cash flow ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_revenue", "type": "float", "description": "Capital expenditures-to-revenue ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_to_depreciation", "type": "float", "description": "Capital expenditures-to-depreciation ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stock_based_compensation_to_revenue", "type": "float", "description": "Stock-based compensation-to-revenue ratio", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "graham_number", "type": "float", "description": "Graham number", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "roic", "type": "float", "description": "Return on invested capital", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_tangible_assets", "type": "float", "description": "Return on tangible assets", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "graham_net_net", "type": "float", "description": "Graham net-net working capital", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "working_capital", "type": "float", "description": "Working capital", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tangible_asset_value", "type": "float", "description": "Tangible asset value", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_current_asset_value", "type": "float", "description": "Net current asset value", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "invested_capital", "type": "float", "description": "Invested capital", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_receivables", "type": "float", "description": "Average receivables", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_payables", "type": "float", "description": "Average payables", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_inventory", "type": "float", "description": "Average inventory", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_sales_outstanding", "type": "float", "description": "Days sales outstanding", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_payables_outstanding", "type": "float", "description": "Days payables outstanding", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_of_inventory_on_hand", "type": "float", "description": "Days of inventory on hand", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "receivables_turnover", "type": "float", "description": "Receivables turnover", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payables_turnover", "type": "float", "description": "Payables turnover", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventory_turnover", "type": "float", "description": "Inventory turnover", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "roe", "type": "float", "description": "Return on equity", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capex_per_share", "type": "float", "description": "Capital expenditures per share", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -14407,252 +16224,288 @@ "type": "float", "description": "Price to book ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_tangible_book", "type": "float", "description": "Price to tangible book ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_revenue", "type": "float", "description": "Price to revenue ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_margin", "type": "float", "description": "Gross margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebit_margin", "type": "float", "description": "EBIT margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "profit_margin", "type": "float", "description": "Profit margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps", "type": "float", "description": "Basic earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_growth", "type": "float", "description": "EPS growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_growth", "type": "float", "description": "Revenue growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda_growth", "type": "float", "description": "EBITDA growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebit_growth", "type": "float", "description": "EBIT growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_growth", "type": "float", "description": "Net income growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_to_firm_growth", "type": "float", "description": "Free cash flow to firm growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "invested_capital_growth", "type": "float", "description": "Invested capital growth, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_invested_capital", "type": "float", "description": "Return on invested capital, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda", "type": "int", "description": "Earnings before interest, taxes, depreciation, and amortization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebit", "type": "int", "description": "Earnings before interest and taxes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt", "type": "int", "description": "Long-term debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_debt", "type": "int", "description": "Total debt.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_capital", "type": "int", "description": "The sum of long-term debt and total shareholder equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value", "type": "int", "description": "Enterprise value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_to_firm", "type": "int", "description": "Free cash flow to firm.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "altman_z_score", "type": "float", "description": "Altman Z-score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "Beta relative to the broad market (rolling three-year).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_yield", "type": "float", "description": "Earnings yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_price", "type": "float", "description": "Last price of the stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "52 week high", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "52 week low", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_interest", "type": "int", "description": "Number of shares reported as sold short.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Weighted average shares outstanding (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_to_cover", "type": "float", "description": "Days to cover short interest, based on average daily volume.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -14661,245 +16514,280 @@ "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "peg_ratio", "type": "float", "description": "PEG ratio (5-year expected).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "peg_ratio_ttm", "type": "float", "description": "PEG ratio (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_to_ebitda", "type": "float", "description": "Enterprise value to EBITDA ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_growth", "type": "float", "description": "Earnings growth (Year Over Year), as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_growth_quarterly", "type": "float", "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_per_share", "type": "float", "description": "Revenue per share (TTM).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "revenue_growth", "type": "float", "description": "Revenue growth (Year Over Year), as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_to_revenue", "type": "float", "description": "Enterprise value to revenue ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "current_ratio", "type": "float", "description": "Current ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_to_equity", "type": "float", "description": "Debt-to-equity ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_margin", "type": "float", "description": "Gross margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_margin", "type": "float", "description": "Operating margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "EBITDA margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "profit_margin", "type": "float", "description": "Profit margin, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield_5y_avg", "type": "float", "description": "5-year average dividend yield, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price-to-book ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value", "type": "int", "description": "Enterprise value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "overall_risk", "type": "float", "description": "Overall risk score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "audit_risk", "type": "float", "description": "Audit risk score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "board_risk", "type": "float", "description": "Board risk score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "compensation_risk", "type": "float", "description": "Compensation risk score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shareholder_rights_risk", "type": "float", "description": "Shareholder rights risk score.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "Beta relative to the broad market (5-year monthly).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_return_1y", "type": "float", "description": "One-year price return, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency in which the data is presented.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -14919,7 +16807,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -14968,49 +16857,56 @@ "type": "str", "description": "Designation of the key executive.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the key executive.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "pay", "type": "int", "description": "Pay of the key executive.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_pay", "type": "str", "description": "Currency of the pay.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gender", "type": "str", "description": "Gender of the key executive.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_born", "type": "int", "description": "Birth year of the key executive.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "title_since", "type": "int", "description": "Date the tile was held since.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [], @@ -15020,14 +16916,16 @@ "type": "int", "description": "Value of shares exercised.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unexercised_value", "type": "int", "description": "Value of shares not exercised.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -15047,7 +16945,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -15063,7 +16962,8 @@ "type": "int", "description": "Year of the compensation.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -15103,84 +17003,96 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_name", "type": "str", "description": "The name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "The industry of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year", "type": "int", "description": "Year of the compensation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name_and_position", "type": "str", "description": "Name and position.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "salary", "type": "Annotated[float, Ge(ge=0)]", "description": "Salary.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bonus", "type": "Annotated[float, Ge(ge=0)]", "description": "Bonus payments.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stock_award", "type": "Annotated[float, Ge(ge=0)]", "description": "Stock awards.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "incentive_plan_compensation", "type": "Annotated[float, Ge(ge=0)]", "description": "Incentive plan compensation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "all_other_compensation", "type": "Annotated[float, Ge(ge=0)]", "description": "All other compensation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total", "type": "Annotated[float, Ge(ge=0)]", "description": "Total compensation.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -15189,21 +17101,24 @@ "type": "date", "description": "Date of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "Date the filing was accepted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url", "type": "str", "description": "URL to the filing data.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -15223,7 +17138,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -15271,252 +17187,288 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "price", "type": "float", "description": "Price of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "Beta of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "vol_avg", "type": "int", "description": "Volume average of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mkt_cap", "type": "int", "description": "Market capitalization of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_div", "type": "float", "description": "Last dividend of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "range", "type": "str", "description": "Range of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "changes", "type": "float", "description": "Changes of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_name", "type": "str", "description": "Company name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "ISIN of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_short_name", "type": "str", "description": "Exchange short name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "Industry of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "website", "type": "str", "description": "Website of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "description", "type": "str", "description": "Description of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ceo", "type": "str", "description": "CEO of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "str", "description": "Sector of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Country of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "full_time_employees", "type": "str", "description": "Full time employees of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "phone", "type": "str", "description": "Phone of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "address", "type": "str", "description": "Address of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "city", "type": "str", "description": "City of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "state", "type": "str", "description": "State of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "zip", "type": "str", "description": "Zip of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dcf_diff", "type": "float", "description": "Discounted cash flow difference of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dcf", "type": "float", "description": "Discounted cash flow of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "image", "type": "str", "description": "Image of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ipo_date", "type": "date", "description": "IPO date of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "default_image", "type": "bool", "description": "If the image is the default image.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_etf", "type": "bool", "description": "If the company is an ETF.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_actively_trading", "type": "bool", "description": "If the company is actively trading.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_adr", "type": "bool", "description": "If the company is an ADR.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_fund", "type": "bool", "description": "If the company is a fund.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -15537,21 +17489,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 12, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -15567,7 +17522,8 @@ "type": "Literal['annual', 'quarter', 'ttm']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -15576,14 +17532,16 @@ "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -15623,21 +17581,24 @@ "type": "str", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Period of the financial ratios.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -15646,392 +17607,448 @@ "type": "float", "description": "Current ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_ratio", "type": "float", "description": "Cash ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_of_sales_outstanding", "type": "float", "description": "Days of sales outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_of_inventory_outstanding", "type": "float", "description": "Days of inventory outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cycle", "type": "float", "description": "Operating cycle.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_of_payables_outstanding", "type": "float", "description": "Days of payables outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_conversion_cycle", "type": "float", "description": "Cash conversion cycle.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross profit margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_profit_margin", "type": "float", "description": "Operating profit margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pretax_profit_margin", "type": "float", "description": "Pretax profit margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_profit_margin", "type": "float", "description": "Net profit margin.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "effective_tax_rate", "type": "float", "description": "Effective tax rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_on_capital_employed", "type": "float", "description": "Return on capital employed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_income_per_ebt", "type": "float", "description": "Net income per EBT.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebt_per_ebit", "type": "float", "description": "EBT per EBIT.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ebit_per_revenue", "type": "float", "description": "EBIT per revenue.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_ratio", "type": "float", "description": "Debt ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "debt_equity_ratio", "type": "float", "description": "Debt equity ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_term_debt_to_capitalization", "type": "float", "description": "Long term debt to capitalization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_debt_to_capitalization", "type": "float", "description": "Total debt to capitalization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_coverage", "type": "float", "description": "Interest coverage.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_flow_to_debt_ratio", "type": "float", "description": "Cash flow to debt ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_equity_multiplier", "type": "float", "description": "Company equity multiplier.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "receivables_turnover", "type": "float", "description": "Receivables turnover.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payables_turnover", "type": "float", "description": "Payables turnover.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inventory_turnover", "type": "float", "description": "Inventory turnover.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fixed_asset_turnover", "type": "float", "description": "Fixed asset turnover.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_turnover", "type": "float", "description": "Asset turnover.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cash_flow_per_share", "type": "float", "description": "Operating cash flow per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_per_share", "type": "float", "description": "Free cash flow per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "operating_cash_flow_sales_ratio", "type": "float", "description": "Operating cash flow sales ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_cash_flow_operating_cash_flow_ratio", "type": "float", "description": "Free cash flow operating cash flow ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cash_flow_coverage_ratios", "type": "float", "description": "Cash flow coverage ratios.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_term_coverage_ratios", "type": "float", "description": "Short term coverage ratios.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "capital_expenditure_coverage_ratio", "type": "float", "description": "Capital expenditure coverage ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_paid_and_capex_coverage_ratio", "type": "float", "description": "Dividend paid and capex coverage ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_payout_ratio", "type": "float", "description": "Dividend payout ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_book_value_ratio", "type": "float", "description": "Price book value ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_book_ratio", "type": "float", "description": "Price to book ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_sales_ratio", "type": "float", "description": "Price to sales ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_earnings_ratio", "type": "float", "description": "Price earnings ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_free_cash_flows_ratio", "type": "float", "description": "Price to free cash flows ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_to_operating_cash_flows_ratio", "type": "float", "description": "Price to operating cash flows ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_cash_flow_ratio", "type": "float", "description": "Price cash flow ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_earnings_to_growth_ratio", "type": "float", "description": "Price earnings to growth ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_sales_ratio", "type": "float", "description": "Price sales ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield_percentage", "type": "float", "description": "Dividend yield percentage.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_per_share", "type": "float", "description": "Dividend per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "enterprise_value_multiple", "type": "float", "description": "Enterprise value multiple.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_fair_value", "type": "float", "description": "Price fair value.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [] @@ -16052,21 +18069,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "structure", "type": "Literal['hierarchical', 'flat']", "description": "Structure of the returned data.", "default": "flat", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -16114,35 +18134,40 @@ "type": "date", "description": "The end date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the reporting period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the reporting period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "The filing date of the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "geographic_segment", "type": "int", "description": "Dictionary of the revenue by geographic segment.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -16163,21 +18188,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period", "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", - "optional": true + "optional": true, + "choices": null }, { "name": "structure", "type": "Literal['hierarchical', 'flat']", "description": "Structure of the returned data.", "default": "flat", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -16225,35 +18253,40 @@ "type": "date", "description": "The end date of the reporting period.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the reporting period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the reporting period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "date", "description": "The filing date of the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_line", "type": "int", "description": "Dictionary containing the revenue of the business line.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -16274,21 +18307,24 @@ "type": "str", "description": "Symbol to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "form_type", "type": "str", "description": "Filter by form type. Check the data provider for available types.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -16305,21 +18341,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "thea_enabled", "type": "bool", "description": "Return filings that have been read by Intrinio's Thea NLP.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "sec": [ @@ -16328,28 +18367,32 @@ "type": "str", "description": "Symbol to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "form_type", "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", "description": "Type of the SEC filing form.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "Union[int, str]", "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache. If True, cache will store for one day.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -16389,49 +18432,56 @@ "type": "date", "description": "The date of the filing.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "Accepted date of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "report_type", "type": "str", "description": "Type of filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_url", "type": "str", "description": "URL to the filing page.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "report_url", "type": "str", "description": "URL to the actual report.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [], @@ -16441,42 +18491,48 @@ "type": "str", "description": "Intrinio ID of the filing.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "period_end_date", "type": "date", "description": "Ending date of the fiscal period for the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sec_unique_id", "type": "str", "description": "SEC unique ID of the filing.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "instance_url", "type": "str", "description": "URL for the XBRL filing for the report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry_group", "type": "str", "description": "Industry group of the company.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "industry_category", "type": "str", "description": "Industry category of the company.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "sec": [ @@ -16485,91 +18541,104 @@ "type": "date", "description": "The date of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "act", "type": "Union[int, str]", "description": "The SEC Act number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "items", "type": "Union[str, float]", "description": "The SEC Item numbers.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "primary_doc_description", "type": "str", "description": "The description of the primary document.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "primary_doc", "type": "str", "description": "The filename of the primary document.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "accession_number", "type": "Union[int, str]", "description": "The accession number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "file_number", "type": "Union[int, str]", "description": "The file number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "film_number", "type": "Union[int, str]", "description": "The film number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_inline_xbrl", "type": "Union[int, str]", "description": "Whether the filing is an inline XBRL filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_xbrl", "type": "Union[int, str]", "description": "Whether the filing is an XBRL filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "size", "type": "Union[int, str]", "description": "The size of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "complete_submission_url", "type": "str", "description": "The URL to the complete filing submission.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_detail_url", "type": "str", "description": "The URL to the filing details.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -16589,7 +18658,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -16637,28 +18707,32 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "numerator", "type": "float", "description": "Numerator of the split.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "denominator", "type": "float", "description": "Denominator of the split.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "str", "description": "Split ratio.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -16679,14 +18753,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "year", "type": "int", "description": "Year of the earnings call transcript.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -16734,35 +18810,40 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "quarter", "type": "int", "description": "Quarter of the earnings call transcript.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "year", "type": "int", "description": "Year of the earnings call transcript.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "datetime", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "content", "type": "str", "description": "Content of the earnings call transcript.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -16783,14 +18864,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", "default": 252, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -16838,14 +18921,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "trailing_dividend_yield", "type": "float", "description": "Trailing dividend yield.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "tiingo": [] @@ -16866,21 +18951,24 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "page", "type": "int", "description": "Page number of the data to fetch.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -16928,273 +19016,312 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "investor_name", "type": "str", "description": "Investor name of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "security_name", "type": "str", "description": "Security name of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "type_of_security", "type": "str", "description": "Type of security of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "security_cusip", "type": "str", "description": "Security cusip of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "shares_type", "type": "str", "description": "Shares type of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "put_call_share", "type": "str", "description": "Put call share of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "investment_discretion", "type": "str", "description": "Investment discretion of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "industry_title", "type": "str", "description": "Industry title of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "weight", "type": "float", "description": "Weight of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_weight", "type": "float", "description": "Last weight of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_weight", "type": "float", "description": "Change in weight of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_weight_percentage", "type": "float", "description": "Change in weight percentage of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "market_value", "type": "int", "description": "Market value of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_market_value", "type": "int", "description": "Last market value of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_market_value", "type": "int", "description": "Change in market value of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_market_value_percentage", "type": "float", "description": "Change in market value percentage of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "shares_number", "type": "int", "description": "Shares number of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_shares_number", "type": "int", "description": "Last shares number of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_shares_number", "type": "float", "description": "Change in shares number of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_shares_number_percentage", "type": "float", "description": "Change in shares number percentage of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "quarter_end_price", "type": "float", "description": "Quarter end price of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "avg_price_paid", "type": "float", "description": "Average price paid of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_new", "type": "bool", "description": "Is the stock ownership new.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_sold_out", "type": "bool", "description": "Is the stock ownership sold out.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ownership", "type": "float", "description": "How much is the ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_ownership", "type": "float", "description": "Last ownership amount.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_ownership", "type": "float", "description": "Change in ownership amount.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_ownership_percentage", "type": "float", "description": "Change in ownership percentage.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "holding_period", "type": "int", "description": "Holding period of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "first_added", "type": "date", "description": "First added date of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "performance", "type": "float", "description": "Performance of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "performance_percentage", "type": "float", "description": "Performance percentage of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_performance", "type": "float", "description": "Last performance of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "change_in_performance", "type": "float", "description": "Change in performance of the stock ownership.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_counted_for_performance", "type": "bool", "description": "Is the stock ownership counted for performance.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -17215,7 +19342,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -17231,14 +19359,16 @@ "type": "bool", "description": "Include current quarter data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -17278,21 +19408,24 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [ @@ -17301,231 +19434,264 @@ "type": "int", "description": "Number of investors holding the stock.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_investors_holding", "type": "int", "description": "Number of investors holding the stock in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "investors_holding_change", "type": "int", "description": "Change in the number of investors holding the stock.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "number_of_13f_shares", "type": "int", "description": "Number of 13F shares.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_number_of_13f_shares", "type": "int", "description": "Number of 13F shares in the last quarter.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_of_13f_shares_change", "type": "int", "description": "Change in the number of 13F shares.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_invested", "type": "float", "description": "Total amount invested.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_total_invested", "type": "float", "description": "Total amount invested in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_invested_change", "type": "float", "description": "Change in the total amount invested.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ownership_percent", "type": "float", "description": "Ownership percent.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_ownership_percent", "type": "float", "description": "Ownership percent in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ownership_percent_change", "type": "float", "description": "Change in the ownership percent.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "new_positions", "type": "int", "description": "Number of new positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_new_positions", "type": "int", "description": "Number of new positions in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "new_positions_change", "type": "int", "description": "Change in the number of new positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "increased_positions", "type": "int", "description": "Number of increased positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_increased_positions", "type": "int", "description": "Number of increased positions in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "increased_positions_change", "type": "int", "description": "Change in the number of increased positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "closed_positions", "type": "int", "description": "Number of closed positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_closed_positions", "type": "int", "description": "Number of closed positions in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "closed_positions_change", "type": "int", "description": "Change in the number of closed positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "reduced_positions", "type": "int", "description": "Number of reduced positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_reduced_positions", "type": "int", "description": "Number of reduced positions in the last quarter.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "reduced_positions_change", "type": "int", "description": "Change in the number of reduced positions.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_calls", "type": "int", "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_total_calls", "type": "int", "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_calls_change", "type": "int", "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_puts", "type": "int", "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_total_puts", "type": "int", "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "total_puts_change", "type": "int", "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "put_call_ratio", "type": "float", "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "last_put_call_ratio", "type": "float", "description": "Put-call ratio on the previous reporting date.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "put_call_ratio_change", "type": "float", "description": "Change in the put-call ratio between the current and previous reporting dates.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -17545,14 +19711,16 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 500, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -17568,7 +19736,8 @@ "type": "Literal[None, 'award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", "description": "Type of the transaction.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -17577,28 +19746,32 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ownership_type", "type": "Literal['D', 'I']", "description": "Type of ownership.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort_by", "type": "Literal['filing_date', 'updated_on']", "description": "Field to sort by.", "default": "updated_on", - "optional": true + "optional": true, + "choices": null } ] }, @@ -17638,98 +19811,112 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_cik", "type": "Union[int, str]", "description": "CIK number of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_date", "type": "Union[date, datetime]", "description": "Filing date of the trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "transaction_date", "type": "date", "description": "Date of the transaction.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "owner_cik", "type": "Union[int, str]", "description": "Reporting individual's CIK.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "owner_name", "type": "str", "description": "Name of the reporting individual.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "owner_title", "type": "str", "description": "The title held by the reporting individual.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "transaction_type", "type": "str", "description": "Type of transaction being reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "acquisition_or_disposition", "type": "str", "description": "Acquisition or disposition of the shares.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "security_type", "type": "str", "description": "The type of security transacted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "securities_owned", "type": "float", "description": "Number of securities owned by the reporting individual.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "securities_transacted", "type": "float", "description": "Number of securities transacted by the reporting individual.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "transaction_price", "type": "float", "description": "The price of the transaction.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "filing_url", "type": "str", "description": "Link to the filing.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -17738,7 +19925,8 @@ "type": "str", "description": "Form type of the insider trading.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "intrinio": [ @@ -17747,105 +19935,120 @@ "type": "str", "description": "URL of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_name", "type": "str", "description": "Name of the company.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "conversion_exercise_price", "type": "float", "description": "Conversion/Exercise price of the shares.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "deemed_execution_date", "type": "date", "description": "Deemed execution date of the trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exercise_date", "type": "date", "description": "Exercise date of the trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "expiration_date", "type": "date", "description": "Expiration date of the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "underlying_security_title", "type": "str", "description": "Name of the underlying non-derivative security related to this derivative transaction.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "underlying_shares", "type": "Union[int, float]", "description": "Number of underlying shares related to this derivative transaction.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "nature_of_ownership", "type": "str", "description": "Nature of ownership of the insider trading.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "director", "type": "bool", "description": "Whether the owner is a director.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "officer", "type": "bool", "description": "Whether the owner is an officer.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ten_percent_owner", "type": "bool", "description": "Whether the owner is a 10% owner.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_relation", "type": "bool", "description": "Whether the owner is having another relation.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "derivative_transaction", "type": "bool", "description": "Whether the owner is having a derivative transaction.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "report_line_number", "type": "int", "description": "Report line number of the insider trading.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -17865,7 +20068,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -17915,42 +20119,48 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "free_float", "type": "float", "description": "Percentage of unrestricted shares of a publicly-traded company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "float_shares", "type": "float", "description": "Number of shares available for trading by the general public.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "outstanding_shares", "type": "float", "description": "Total number of shares of a publicly-traded company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "str", "description": "Source of the received data.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [], @@ -17960,14 +20170,16 @@ "type": "float", "description": "Total number of shares of a publicly-traded company, adjusted for splits.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "public_float", "type": "float", "description": "Aggregate market value of the shares of a publicly-traded company.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -17976,70 +20188,80 @@ "type": "int", "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_interest", "type": "int", "description": "Number of shares that are reported short.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_percent_of_float", "type": "float", "description": "Percentage of shares that are reported short, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "days_to_cover", "type": "float", "description": "Number of days to repurchase the shares as a ratio of average daily volume", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_interest_prev_month", "type": "int", "description": "Number of shares that were reported short in the previous month.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_interest_prev_date", "type": "date", "description": "Date of the previous month's report.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "insider_ownership", "type": "float", "description": "Percentage of shares held by insiders, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "institution_ownership", "type": "float", "description": "Percentage of shares held by institutions, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "institution_float_ownership", "type": "float", "description": "Percentage of float held by institutions, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "institutions_count", "type": "int", "description": "Number of institutions holding shares.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -18059,21 +20281,24 @@ "type": "str", "description": "Symbol to get data for. A CIK or Symbol can be used.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", "default": 1, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -18121,77 +20346,88 @@ "type": "date", "description": "The end-of-quarter date of the filing.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "issuer", "type": "str", "description": "The name of the issuer.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the security.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "asset_class", "type": "str", "description": "The title of the asset class for the security.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "security_type", "type": "Literal['SH', 'PRN']", "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "option_type", "type": "Literal['call', 'put']", "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "voting_authority_sole", "type": "int", "description": "The number of shares for which the Manager exercises sole voting authority (none).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "voting_authority_shared", "type": "int", "description": "The number of shares for which the Manager exercises a defined shared voting authority (none).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "voting_authority_other", "type": "int", "description": "The number of shares for which the Manager exercises other shared voting authority (none).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "principal_amount", "type": "int", "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "value", "type": "int", "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "sec": [ @@ -18200,7 +20436,8 @@ "type": "float", "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -18220,7 +20457,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -18237,14 +20475,16 @@ "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "source", "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", "description": "Source of the data.", "default": "iex", - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -18285,231 +20525,264 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "asset_type", "type": "str", "description": "Type of asset - i.e, stock, ETF, etc.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the company or asset.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The name or symbol of the venue where the data is from.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid", "type": "float", "description": "Price of the top bid order.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_size", "type": "int", "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_exchange", "type": "str", "description": "The specific trading venue where the purchase order was placed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask", "type": "float", "description": "Price of the top ask order.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_size", "type": "int", "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_exchange", "type": "str", "description": "The specific trading venue where the sale order was placed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quote_conditions", "type": "Union[str, int, List[str], List[int]]", "description": "Conditions or condition codes applicable to the quote.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quote_indicators", "type": "Union[str, int, List[str], List[int]]", "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sales_conditions", "type": "Union[str, int, List[str], List[int]]", "description": "Conditions or condition codes applicable to the sale.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sequence_number", "type": "int", "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_center", "type": "str", "description": "The ID of the UTP participant that originated the message.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "participant_timestamp", "type": "datetime", "description": "Timestamp for when the quote was generated by the exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trf_timestamp", "type": "datetime", "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sip_timestamp", "type": "datetime", "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_price", "type": "float", "description": "Price of the last trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_tick", "type": "str", "description": "Whether the last sale was an up or down tick.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_size", "type": "int", "description": "Size of the last trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_timestamp", "type": "datetime", "description": "Date and Time when the last price was recorded.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_volume", "type": "Union[int, float]", "description": "Volume of shares exchanged during the trading day on the specific exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in price from previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in price as a normalized percentage.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The one year high (52W High).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The one year low (52W Low).", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -18518,56 +20791,64 @@ "type": "float", "description": "50 day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_avg200", "type": "float", "description": "200 day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume", "type": "int", "description": "Average volume over the last 10 trading days.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "float", "description": "Market cap of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Number of shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps", "type": "float", "description": "Earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe", "type": "float", "description": "Price earnings ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_announcement", "type": "datetime", "description": "Upcoming earnings announcement date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -18576,28 +20857,32 @@ "type": "bool", "description": "Whether or not the current trade is from a darkpool.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "str", "description": "Source of the Intrinio data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated_on", "type": "datetime", "description": "Date and Time when the data was last updated.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "Security details related to the quote.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -18606,35 +20891,40 @@ "type": "float", "description": "50-day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma_200d", "type": "float", "description": "200-day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_average", "type": "float", "description": "Average daily trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_average_10d", "type": "float", "description": "Average daily trading volume in the last 10 days.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -18654,7 +20944,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -18670,42 +20961,48 @@ "type": "int", "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", "default": 50000, - "optional": true + "optional": true, + "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timestamp_lt", "type": "Union[datetime, str]", "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timestamp_gt", "type": "Union[datetime, str]", "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timestamp_lte", "type": "Union[datetime, str]", "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timestamp_gte", "type": "Union[datetime, str]", "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -18745,42 +21042,48 @@ "type": "str", "description": "The exchange ID for the ask.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ask", "type": "float", "description": "The last ask price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "ask_size", "type": "int", "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "bid_size", "type": "int", "description": "The bid size in round lots.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "bid", "type": "float", "description": "The last bid price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "bid_exchange", "type": "str", "description": "The exchange ID for the bid.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "polygon": [ @@ -18789,49 +21092,56 @@ "type": "str", "description": "The exchange tape.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "conditions", "type": "Union[str, List[int], List[str]]", "description": "A list of condition codes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "indicators", "type": "List[int]", "description": "A list of indicator codes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sequence_num", "type": "int", "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "participant_timestamp", "type": "datetime", "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sip_timestamp", "type": "datetime", "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trf_timestamp", "type": "datetime", "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -18851,28 +21161,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "interval", "type": "str", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -18888,7 +21202,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -18897,42 +21212,48 @@ "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "interval", "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "start_time", "type": "datetime.time", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_time", "type": "datetime.time", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timezone", "type": "str", "description": "Timezone of the data, in the IANA format (Continent/City).", "default": "America/New_York", - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", "description": "The source of the data.", "default": "realtime", - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -18941,35 +21262,40 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'unadjusted']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", - "optional": true + "optional": true, + "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -18978,7 +21304,8 @@ "type": "Literal['1d', '1W', '1M', '1Y']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -18987,42 +21314,48 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "include_actions", "type": "bool", "description": "Include dividends and stock splits in results.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", - "optional": true + "optional": true, + "choices": null }, { "name": "adjusted", "type": "bool", "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "prepost", "type": "bool", "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -19062,49 +21395,56 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -19113,28 +21453,32 @@ "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unadjusted_volume", "type": "float", "description": "Unadjusted volume of the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -19143,112 +21487,128 @@ "type": "float", "description": "Average trade price of an individual equity during the interval.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price of the symbol from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Percent change in the price of the symbol from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fifty_two_week_high", "type": "float", "description": "52 week high price for the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fifty_two_week_low", "type": "float", "description": "52 week low price for the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "factor", "type": "float", "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_time", "type": "datetime", "description": "The timestamp that represents the end of the interval span.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interval", "type": "str", "description": "The data time frequency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intra_period", "type": "bool", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -19257,7 +21617,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -19266,49 +21627,56 @@ "type": "float", "description": "The adjusted open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -19317,14 +21685,16 @@ "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -19344,7 +21714,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -19392,119 +21763,136 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_day", "type": "float", "description": "One-day return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "wtd", "type": "float", "description": "Week to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_week", "type": "float", "description": "One-week return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mtd", "type": "float", "description": "Month to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_month", "type": "float", "description": "One-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "qtd", "type": "float", "description": "Quarter to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_month", "type": "float", "description": "Three-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "six_month", "type": "float", "description": "Six-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ytd", "type": "float", "description": "Year to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_year", "type": "float", "description": "One-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "two_year", "type": "float", "description": "Two-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_year", "type": "float", "description": "Three-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "four_year", "type": "float", "description": "Four-year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "five_year", "type": "float", "description": "Five-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ten_year", "type": "float", "description": "Ten-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "max", "type": "float", "description": "Return from the beginning of the time series.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -19513,7 +21901,8 @@ "type": "str", "description": "The ticker symbol.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -19533,7 +21922,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -19549,21 +21939,24 @@ "type": "int", "description": "Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009.", "default": 24, - "optional": true + "optional": true, + "choices": null }, { "name": "skip_reports", "type": "int", "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -19603,42 +21996,48 @@ "type": "date", "description": "The settlement date of the fail.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP of the Security.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quantity", "type": "int", "description": "The number of fails on that settlement date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price", "type": "float", "description": "The price at the previous closing price from the settlement date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "description", "type": "str", "description": "The description of the Security.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "sec": [] @@ -19659,21 +22058,24 @@ "type": "str", "description": "Search query.", "default": "", - "optional": true + "optional": true, + "choices": null }, { "name": "is_symbol", "type": "bool", "description": "Whether to search by ticker symbol.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether to use the cache or not.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -19689,14 +22091,16 @@ "type": "bool", "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10000, - "optional": true + "optional": true, + "choices": null } ], "sec": [ @@ -19705,7 +22109,8 @@ "type": "bool", "description": "Whether to direct the search to the list of mutual funds and ETFs.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -19745,14 +22150,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -19761,21 +22168,24 @@ "type": "str", "description": "", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "lei", "type": "str", "description": "The Legal Entity Identifier (LEI) of the company.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "intrinio_id", "type": "str", "description": "The Intrinio ID of the company.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "sec": [ @@ -19784,7 +22194,8 @@ "type": "str", "description": "Central Index Key", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -19813,119 +22224,136 @@ "type": "int", "description": "Filter by market cap greater than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mktcap_max", "type": "int", "description": "Filter by market cap less than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_min", "type": "float", "description": "Filter by price greater than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price_max", "type": "float", "description": "Filter by price less than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta_min", "type": "float", "description": "Filter by a beta greater than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta_max", "type": "float", "description": "Filter by a beta less than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_min", "type": "int", "description": "Filter by volume greater than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_max", "type": "int", "description": "Filter by volume less than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_min", "type": "float", "description": "Filter by dividend amount greater than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_max", "type": "float", "description": "Filter by dividend amount less than this value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_etf", "type": "bool", "description": "If true, returns only ETFs.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "is_active", "type": "bool", "description": "If false, returns only inactive tickers.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "Literal['Consumer Cyclical', 'Energy', 'Technology', 'Industrials', 'Financial Services', 'Basic Materials', 'Communication Services', 'Consumer Defensive', 'Healthcare', 'Real Estate', 'Utilities', 'Industrial Goods', 'Financial', 'Services', 'Conglomerates']", "description": "Filter by sector.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "Filter by industry.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "Filter by country, as a two-letter country code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", "description": "Filter by exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "Limit the number of results to return.", "default": 50000, - "optional": true + "optional": true, + "choices": null } ] }, @@ -19965,14 +22393,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the company.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [ @@ -19981,84 +22411,96 @@ "type": "int", "description": "The market cap of ticker.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "str", "description": "The sector the ticker belongs to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "The industry ticker belongs to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price", "type": "float", "description": "The current price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_annual_dividend", "type": "float", "description": "The last annual amount dividend paid.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The current trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the asset trades on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_name", "type": "str", "description": "The full name of the primary exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The two-letter country abbreviation where the head office is located.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_etf", "type": "Literal[True, False]", "description": "Whether the ticker is an ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "actively_trading", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -20078,7 +22520,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -20128,266 +22571,304 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Common name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP identifier for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "International Securities Identification Number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "lei", "type": "str", "description": "Legal Entity Identifier assigned to the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "legal_name", "type": "str", "description": "Official legal name of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stock_exchange", "type": "str", "description": "Stock exchange where the company is traded.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sic", "type": "int", "description": "Standard Industrial Classification code for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "short_description", "type": "str", "description": "Short description of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "long_description", "type": "str", "description": "Long description of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ceo", "type": "str", "description": "Chief Executive Officer of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "company_url", "type": "str", "description": "URL of the company's website.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_address", "type": "str", "description": "Address of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mailing_address", "type": "str", "description": "Mailing address of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_phone_no", "type": "str", "description": "Phone number of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_address1", "type": "str", "description": "Address of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_address2", "type": "str", "description": "Address of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_address_city", "type": "str", "description": "City of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_address_postal_code", "type": "str", "description": "Zip code of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_state", "type": "str", "description": "State of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hq_country", "type": "str", "description": "Country of the company's headquarters.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inc_state", "type": "str", "description": "State in which the company is incorporated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inc_country", "type": "str", "description": "Country in which the company is incorporated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "employees", "type": "int", "description": "Number of employees working for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "entity_legal_form", "type": "str", "description": "Legal form of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "entity_status", "type": "str", "description": "Status of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "latest_filing_date", "type": "date", "description": "Date of the company's latest filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "irs_number", "type": "str", "description": "IRS number assigned to the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "str", "description": "Sector in which the company operates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry_category", "type": "str", "description": "Category of industry in which the company operates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry_group", "type": "str", "description": "Group of industry in which the company operates.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "template", "type": "str", "description": "Template used to standardize the company's financial statements.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "standardized_active", "type": "bool", "description": "Whether the company is active or not.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "first_fundamental_date", "type": "date", "description": "Date of the company's first fundamental.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_fundamental_date", "type": "date", "description": "Date of the company's last fundamental.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "first_stock_price_date", "type": "date", "description": "Date of the company's first stock price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_stock_price_date", "type": "date", "description": "Date of the company's last stock price.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -20396,91 +22877,104 @@ "type": "bool", "description": "If the symbol is an ETF.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_actively_trading", "type": "bool", "description": "If the company is actively trading.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_adr", "type": "bool", "description": "If the stock is an ADR.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "is_fund", "type": "bool", "description": "If the company is a fund.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "image", "type": "str", "description": "Image of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency in which the stock is traded.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "int", "description": "Market capitalization of the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_price", "type": "float", "description": "The last traded price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The one-year high of the price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The one-year low of the price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "annualized_dividend_amount", "type": "float", "description": "The annualized dividend payment based on the most recent regular dividend payment.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "Beta of the stock relative to the market.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -20489,14 +22983,16 @@ "type": "str", "description": "Intrinio ID for the company.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "thea_enabled", "type": "bool", "description": "Whether the company has been enabled for Thea.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -20505,70 +23001,80 @@ "type": "str", "description": "The timezone of the exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issue_type", "type": "str", "description": "The issuance type of the asset.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the asset is traded.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "int", "description": "The market capitalization of the asset.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "The number of listed shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_float", "type": "int", "description": "The number of shares in the public float.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_implied_outstanding", "type": "int", "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_short", "type": "int", "description": "The reported number of shares short.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "The dividend yield of the asset, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the asset relative to the broad market.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -20597,7 +23103,8 @@ "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", "description": "The market to fetch data for.", "default": "nasdaq", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -20606,7 +23113,8 @@ "type": "Union[Union[date, datetime, str], str]", "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [] @@ -20647,63 +23155,72 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "The change in price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "The change in price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -20712,98 +23229,112 @@ "type": "float", "description": "The last price of the stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_price_timestamp", "type": "Union[date, datetime]", "description": "The timestamp of the last price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma50", "type": "float", "description": "The 50-day moving average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma200", "type": "float", "description": "The 200-day moving average.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "int", "description": "Market cap of the stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "eps", "type": "float", "description": "Earnings per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "pe", "type": "float", "description": "Price to earnings ratio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Number of shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "The company name associated with the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange of the stock.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "earnings_date", "type": "Union[date, datetime]", "description": "The upcoming earnings announcement date.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -20812,70 +23343,80 @@ "type": "float", "description": "The last trade price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_size", "type": "int", "description": "The last trade size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_volume", "type": "int", "description": "The last trade volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_timestamp", "type": "datetime", "description": "The timestamp of the last trade.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_size", "type": "int", "description": "The size of the last bid price. Bid price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_price", "type": "float", "description": "The last bid price. Bid price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_price", "type": "float", "description": "The last ask price. Ask price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_size", "type": "int", "description": "The size of the last ask price. Ask price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_bid_timestamp", "type": "datetime", "description": "The timestamp of the last bid price. Bid price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_ask_timestamp", "type": "datetime", "description": "The timestamp of the last ask price. Ask price and size is not always available.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -20884,119 +23425,136 @@ "type": "float", "description": "The volume weighted average price of the stock on the current trading day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_open", "type": "float", "description": "The previous trading session opening price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_high", "type": "float", "description": "The previous trading session high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_low", "type": "float", "description": "The previous trading session low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_volume", "type": "float", "description": "The previous trading session volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_vwap", "type": "float", "description": "The previous trading session VWAP.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The last time the data was updated.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_size", "type": "int", "description": "The current bid size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_size", "type": "int", "description": "The current ask size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quote_timestamp", "type": "datetime", "description": "The timestamp of the last quote.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_price", "type": "float", "description": "The last trade price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_size", "type": "int", "description": "The last trade size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_conditions", "type": "List[int]", "description": "The last trade condition codes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_exchange", "type": "int", "description": "The last trade exchange ID code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_trade_timestamp", "type": "datetime", "description": "The last trade timestamp.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -21016,7 +23574,8 @@ "type": "str", "description": "Search query.", "default": "", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -21032,14 +23591,16 @@ "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", "description": "The exchange code the ETF trades on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_active", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -21048,7 +23609,8 @@ "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", "description": "Target a specific exchange by providing the MIC code.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -21088,14 +23650,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.(ETF)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -21104,77 +23668,88 @@ "type": "float", "description": "The market cap of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "str", "description": "The sector of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "The industry of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "price", "type": "float", "description": "The current price of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "last_annual_dividend", "type": "float", "description": "The last annual dividend paid.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "float", "description": "The current trading volume of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the ETF trades on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_name", "type": "str", "description": "The full name of the exchange the ETF trades on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The country the ETF is registered in.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "actively_trading", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -21183,42 +23758,48 @@ "type": "str", "description": "The exchange MIC code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "figi_ticker", "type": "str", "description": "The OpenFIGI ticker.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ric", "type": "str", "description": "The Reuters Instrument Code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The International Securities Identification Number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sedol", "type": "str", "description": "The Stock Exchange Daily Official List.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intrinio_id", "type": "str", "description": "The unique Intrinio ID for the security.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -21238,28 +23819,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "interval", "type": "str", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -21275,7 +23860,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -21284,42 +23870,48 @@ "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "interval", "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "start_time", "type": "datetime.time", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_time", "type": "datetime.time", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "timezone", "type": "str", "description": "Timezone of the data, in the IANA format (Continent/City).", "default": "America/New_York", - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", "description": "The source of the data.", "default": "realtime", - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -21328,35 +23920,40 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'unadjusted']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", - "optional": true + "optional": true, + "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -21365,7 +23962,8 @@ "type": "Literal['1d', '1W', '1M', '1Y']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -21374,42 +23972,48 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "include_actions", "type": "bool", "description": "Include dividends and stock splits in results.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", - "optional": true + "optional": true, + "choices": null }, { "name": "adjusted", "type": "bool", "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'adjustment' set as 'splits_and_dividends' instead.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "prepost", "type": "bool", "description": "This field is deprecated (4.1.5) and will be removed in a future version. Use 'extended_hours' as True instead.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -21449,49 +24053,56 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -21500,28 +24111,32 @@ "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unadjusted_volume", "type": "float", "description": "Unadjusted volume of the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -21530,112 +24145,128 @@ "type": "float", "description": "Average trade price of an individual equity during the interval.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price of the symbol from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Percent change in the price of the symbol from the previous day.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fifty_two_week_high", "type": "float", "description": "52 week high price for the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fifty_two_week_low", "type": "float", "description": "52 week low price for the symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "factor", "type": "float", "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_time", "type": "datetime", "description": "The timestamp that represents the end of the interval span.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interval", "type": "str", "description": "The data time frequency.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intra_period", "type": "bool", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -21644,7 +24275,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -21653,49 +24285,56 @@ "type": "float", "description": "The adjusted open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -21704,14 +24343,16 @@ "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -21731,7 +24372,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -21781,28 +24423,32 @@ "type": "str", "description": "Symbol representing the entity requested in the data. (ETF)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "description", "type": "str", "description": "Description of the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inception_date", "type": "str", "description": "Inception date of the ETF.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [ @@ -21811,84 +24457,96 @@ "type": "str", "description": "Company of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "ISIN of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "domicile", "type": "str", "description": "Domicile of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_class", "type": "str", "description": "Asset class of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "aum", "type": "float", "description": "Assets under management.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "nav", "type": "float", "description": "Net asset value of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "nav_currency", "type": "str", "description": "Currency of the ETF's net asset value.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "expense_ratio", "type": "float", "description": "The expense ratio, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holdings_count", "type": "int", "description": "Number of holdings.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "avg_volume", "type": "float", "description": "Average daily trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "website", "type": "str", "description": "Website of the issuer.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -21897,798 +24555,912 @@ "type": "date", "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "data_change_date", "type": "date", "description": "The last date on which there was a change in a classifications data field for this ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "etn_maturity_date", "type": "date", "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_listed", "type": "bool", "description": "If true, the ETF is still listed on an exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close_date", "type": "date", "description": "The date on which the ETF was de-listed if it is no longer listed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange Market Identifier Code (MIC).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "International Securities Identification Number (ISIN).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ric", "type": "str", "description": "Reuters Instrument Code (RIC).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sedol", "type": "str", "description": "Stock Exchange Daily Official List (SEDOL).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "figi_symbol", "type": "str", "description": "Financial Instrument Global Identifier (FIGI) symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_class_figi", "type": "str", "description": "Financial Instrument Global Identifier (FIGI).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firstbridge_id", "type": "str", "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "firstbridge_parent_id", "type": "str", "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intrinio_id", "type": "str", "description": "Intrinio unique identifier for the security.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "intraday_nav_symbol", "type": "str", "description": "Intraday Net Asset Value (NAV) symbol.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "primary_symbol", "type": "str", "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "etp_structure_type", "type": "str", "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "legal_structure", "type": "str", "description": "Legal structure of the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuer", "type": "str", "description": "Issuer of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "etn_issuing_bank", "type": "str", "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fund_family", "type": "str", "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "investment_style", "type": "str", "description": "Investment style of the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "derivatives_based", "type": "str", "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "income_category", "type": "str", "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_class", "type": "str", "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_asset_types", "type": "str", "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "single_category_designation", "type": "str", "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta_type", "type": "str", "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta_details", "type": "str", "description": "This field provides further detail within the traditional and smart beta categories.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap_range", "type": "str", "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap_weighting_type", "type": "str", "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_weighting_scheme", "type": "str", "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_linked", "type": "str", "description": "This field identifies whether an ETF is index linked or active.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_name", "type": "str", "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_symbol", "type": "str", "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "parent_index", "type": "str", "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_family", "type": "str", "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "broader_index_family", "type": "str", "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_provider", "type": "str", "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_provider_code", "type": "str", "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "replication_structure", "type": "str", "description": "The replication structure of the Exchange Traded Product (ETP).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "growth_value_tilt", "type": "str", "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "growth_type", "type": "str", "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value_type", "type": "str", "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sector", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "industry_group", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cross_sector_theme", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "natural_resources_type", "type": "str", "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "us_or_excludes_us", "type": "str", "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "developed_emerging", "type": "str", "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "specialized_region", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "continent", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "latin_america_sub_group", "type": "str", "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "europe_sub_group", "type": "str", "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asia_sub_group", "type": "str", "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "specific_country", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific country.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "china_listing_location", "type": "str", "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "us_state", "type": "str", "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "real_estate", "type": "str", "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fundamental_weighting_type", "type": "str", "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_weighting_type", "type": "str", "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bond_type", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "government_bond_types", "type": "str", "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "municipal_bond_region", "type": "str", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "municipal_vrdo", "type": "bool", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mortgage_bond_types", "type": "str", "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bond_tax_status", "type": "str", "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "credit_quality", "type": "str", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "average_maturity", "type": "str", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "specific_maturity_year", "type": "int", "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "commodity_types", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "energy_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "agricultural_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "livestock_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "metal_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inverse_leveraged", "type": "str", "description": "This field is populated if the ETF provides inverse or leveraged exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "target_date_multi_asset_type", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_pair", "type": "str", "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "social_environmental_type", "type": "str", "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "clean_energy_type", "type": "str", "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_type", "type": "str", "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "regular_dividend_payor_type", "type": "str", "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "quant_strategies_type", "type": "str", "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_quant_models", "type": "str", "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "hedge_fund_type", "type": "str", "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "excludes_financials", "type": "bool", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "excludes_technology", "type": "bool", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_only_nyse_stocks", "type": "bool", "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_only_nasdaq_stocks", "type": "bool", "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_mlp", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_preferred_stock", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_closed_end_funds", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "holds_adr", "type": "bool", "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "laddered", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "zero_coupon", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "floating_rate", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "build_america_bonds", "type": "bool", "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dynamic_futures_roll", "type": "bool", "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_hedged", "type": "bool", "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "includes_short_exposure", "type": "bool", "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ucits", "type": "bool", "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "registered_countries", "type": "str", "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuer_country", "type": "str", "description": "2 letter ISO country code for the country where the issuer is located.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "domicile", "type": "str", "description": "2 letter ISO country code for the country where the ETP is domiciled.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "listing_country", "type": "str", "description": "2 letter ISO country code for the country of the primary listing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "listing_region", "type": "str", "description": "Geographic region in the country of the primary listing falls.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bond_currency_denomination", "type": "str", "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "base_currency", "type": "str", "description": "Base currency in which NAV is reported.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "listing_currency", "type": "str", "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "number_of_holdings", "type": "int", "description": "The number of holdings in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_end_assets", "type": "float", "description": "Net assets in millions of dollars as of the most recent month end.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "net_expense_ratio", "type": "float", "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "etf_portfolio_turnover", "type": "float", "description": "The percentage of positions turned over in the last 12 months.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -22697,217 +25469,248 @@ "type": "str", "description": "The legal type of fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fund_family", "type": "str", "description": "The fund family.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "category", "type": "str", "description": "The fund category.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange the fund is listed on.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "The timezone of the exchange.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the fund is listed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "nav_price", "type": "float", "description": "The net asset value per unit of the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "total_assets", "type": "int", "description": "The total value of assets held by the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "trailing_pe", "type": "float", "description": "The trailing twelve month P/E ratio of the fund's assets.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield", "type": "float", "description": "The dividend yield of the fund, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_rate_ttm", "type": "float", "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "dividend_yield_ttm", "type": "float", "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The fifty-two week high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The fifty-two week low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma_50d", "type": "float", "description": "50-day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ma_200d", "type": "float", "description": "200-day moving average price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_ytd", "type": "float", "description": "The year-to-date return of the fund, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_3y_avg", "type": "float", "description": "The three year average return of the fund, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "return_5y_avg", "type": "float", "description": "The five year average return of the fund, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta_3y_avg", "type": "float", "description": "The three year average beta of the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg", "type": "float", "description": "The average daily trading volume of the fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg_10d", "type": "float", "description": "The average daily trading volume of the fund over the past ten days.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "bid_size", "type": "float", "description": "The current bid size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ask_size", "type": "float", "description": "The current ask size.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "open", "type": "float", "description": "The open price of the most recent trading session.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "float", "description": "The highest price of the most recent trading session.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "float", "description": "The lowest price of the most recent trading session.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume of the most recent trading session.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous closing price.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -22927,7 +25730,8 @@ "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -22975,14 +25779,16 @@ "type": "str", "description": "Sector of exposure.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "weight", "type": "float", "description": "Exposure of the ETF to the sector in normalized percentage points.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -23003,7 +25809,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -23051,7 +25858,8 @@ "type": "str", "description": "The country of the exposure. Corresponding values are normalized percentage points.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -23072,7 +25880,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -23089,14 +25898,16 @@ "type": "Literal['trailing', 'calendar']", "description": "The type of returns to return, a trailing or calendar window.", "default": "trailing", - "optional": true + "optional": true, + "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor, 'splits_only' will return pure price performance.", "default": "splits_and_dividends", - "optional": true + "optional": true, + "choices": null } ] }, @@ -23136,119 +25947,136 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_day", "type": "float", "description": "One-day return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "wtd", "type": "float", "description": "Week to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_week", "type": "float", "description": "One-week return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mtd", "type": "float", "description": "Month to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_month", "type": "float", "description": "One-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "qtd", "type": "float", "description": "Quarter to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_month", "type": "float", "description": "Three-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "six_month", "type": "float", "description": "Six-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ytd", "type": "float", "description": "Year to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_year", "type": "float", "description": "One-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "two_year", "type": "float", "description": "Two-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_year", "type": "float", "description": "Three-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "four_year", "type": "float", "description": "Four-year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "five_year", "type": "float", "description": "Five-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ten_year", "type": "float", "description": "Ten-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "max", "type": "float", "description": "Return from the beginning of the time series.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -23257,7 +26085,8 @@ "type": "str", "description": "The ticker symbol.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "intrinio": [ @@ -23266,105 +26095,120 @@ "type": "float", "description": "Annualized rate of return from inception.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volatility_one_year", "type": "float", "description": "Trailing one-year annualized volatility.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volatility_three_year", "type": "float", "description": "Trailing three-year annualized volatility.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volatility_five_year", "type": "float", "description": "Trailing five-year annualized volatility.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg_30", "type": "float", "description": "The one-month average daily volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg_90", "type": "float", "description": "The three-month average daily volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume_avg_180", "type": "float", "description": "The six-month average daily volume.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "beta", "type": "float", "description": "Beta compared to the S&P 500.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "nav", "type": "float", "description": "Net asset value per share.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_cap", "type": "float", "description": "The market capitalization.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "The number of shares outstanding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "date", "description": "The date of the data.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -23384,7 +26228,8 @@ "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -23400,14 +26245,16 @@ "type": "Union[Union[str, date], str]", "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "str", "description": "The CIK of the filing entity. Overrides symbol.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -23416,7 +26263,8 @@ "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "sec": [ @@ -23425,14 +26273,16 @@ "type": "Union[Union[str, date], str]", "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache for the request.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -23472,14 +26322,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF holding.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -23488,147 +26340,168 @@ "type": "str", "description": "The LEI of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "title", "type": "str", "description": "The title of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "balance", "type": "int", "description": "The balance of the holding, in shares or units.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "units", "type": "Union[str, float]", "description": "The type of units.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "The currency of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "The value of the holding, in dollars.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payoff_profile", "type": "str", "description": "The payoff profile of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_category", "type": "str", "description": "The asset category of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuer_category", "type": "str", "description": "The issuer category of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The country of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_restricted", "type": "str", "description": "Whether the holding is restricted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fair_value_level", "type": "int", "description": "The fair value level of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_cash_collateral", "type": "str", "description": "Whether the holding is cash collateral.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_non_cash_collateral", "type": "str", "description": "Whether the holding is non-cash collateral.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_loan_by_fund", "type": "str", "description": "Whether the holding is loan by fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "str", "description": "The CIK of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "acceptance_datetime", "type": "str", "description": "The acceptance datetime of the filing.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "Union[date, datetime]", "description": "The date the data was updated.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -23637,126 +26510,144 @@ "type": "str", "description": "The common name for the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "security_type", "type": "str", "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The International Securities Identification Number.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ric", "type": "str", "description": "The Reuters Instrument Code.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sedol", "type": "str", "description": "The Stock Exchange Daily Official List.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "share_class_figi", "type": "str", "description": "The OpenFIGI symbol for the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The country or region of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity_date", "type": "date", "description": "The maturity date for the debt security, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "contract_expiry_date", "type": "date", "description": "Expiry date for the futures contract held, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "coupon", "type": "float", "description": "The coupon rate of the debt security, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "balance", "type": "Union[int, float]", "description": "The number of units of the security held, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unit", "type": "str", "description": "The units of the 'balance' field.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "units_per_share", "type": "float", "description": "Number of units of the security held per share outstanding of the ETF, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "face_value", "type": "float", "description": "The face value of the debt security, if available.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "derivatives_value", "type": "float", "description": "The notional value of derivatives contracts held.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "The market value of the holding, on the 'as_of' date.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "date", "description": "The 'as_of' date for the holding.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "sec": [ @@ -23765,511 +26656,584 @@ "type": "str", "description": "The LEI of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "other_id", "type": "str", "description": "Internal identifier for the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "balance", "type": "float", "description": "The balance of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding in ETF in %.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "value", "type": "float", "description": "The value of the holding in USD.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payoff_profile", "type": "str", "description": "The payoff profile of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "units", "type": "Union[str, float]", "description": "The units of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "The currency of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_category", "type": "str", "description": "The asset category of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuer_category", "type": "str", "description": "The issuer category of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "country", "type": "str", "description": "The country of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_restricted", "type": "str", "description": "Whether the holding is restricted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "fair_value_level", "type": "int", "description": "The fair value level of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_cash_collateral", "type": "str", "description": "Whether the holding is cash collateral.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_non_cash_collateral", "type": "str", "description": "Whether the holding is non-cash collateral.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_loan_by_fund", "type": "str", "description": "Whether the holding is loan by fund.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "loan_value", "type": "float", "description": "The loan value of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "issuer_conditional", "type": "str", "description": "The issuer conditions of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "asset_conditional", "type": "str", "description": "The asset conditions of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity_date", "type": "date", "description": "The maturity date of the debt security.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "coupon_kind", "type": "str", "description": "The type of coupon for the debt security.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_type", "type": "str", "description": "The type of rate for the debt security, floating or fixed.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "annualized_return", "type": "float", "description": "The annualized return on the debt security.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_default", "type": "str", "description": "If the debt security is defaulted.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "in_arrears", "type": "str", "description": "If the debt security is in arrears.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_paid_kind", "type": "str", "description": "If the debt security payments are paid in kind.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "derivative_category", "type": "str", "description": "The derivative category of the holding.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "counterparty", "type": "str", "description": "The counterparty of the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "underlying_name", "type": "str", "description": "The name of the underlying asset associated with the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "option_type", "type": "str", "description": "The type of option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "derivative_payoff", "type": "str", "description": "The payoff profile of the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "expiry_date", "type": "date", "description": "The expiry or termination date of the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exercise_price", "type": "float", "description": "The exercise price of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exercise_currency", "type": "str", "description": "The currency of the option exercise price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "shares_per_contract", "type": "float", "description": "The number of shares per contract.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "delta", "type": "Union[str, float]", "description": "The delta of the option.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_type_rec", "type": "str", "description": "The type of rate for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "receive_currency", "type": "str", "description": "The receive currency of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "upfront_receive", "type": "float", "description": "The upfront amount received of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "floating_rate_index_rec", "type": "str", "description": "The floating rate index for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "floating_rate_spread_rec", "type": "float", "description": "The floating rate spread for reveivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_tenor_rec", "type": "str", "description": "The rate tenor for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_tenor_unit_rec", "type": "Union[int, str]", "description": "The rate tenor unit for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reset_date_rec", "type": "str", "description": "The reset date for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reset_date_unit_rec", "type": "Union[int, str]", "description": "The reset date unit for receivable portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_type_pmnt", "type": "str", "description": "The type of rate for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "payment_currency", "type": "str", "description": "The payment currency of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "upfront_payment", "type": "float", "description": "The upfront amount received of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "floating_rate_index_pmnt", "type": "str", "description": "The floating rate index for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "floating_rate_spread_pmnt", "type": "float", "description": "The floating rate spread for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_tenor_pmnt", "type": "str", "description": "The rate tenor for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "rate_tenor_unit_pmnt", "type": "Union[int, str]", "description": "The rate tenor unit for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reset_date_pmnt", "type": "str", "description": "The reset date for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "reset_date_unit_pmnt", "type": "Union[int, str]", "description": "The reset date unit for payment portion of the swap.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "repo_type", "type": "str", "description": "The type of repo.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_cleared", "type": "str", "description": "If the repo is cleared.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_tri_party", "type": "str", "description": "If the repo is tri party.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "principal_amount", "type": "float", "description": "The principal amount of the repo.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "principal_currency", "type": "str", "description": "The currency of the principal amount.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "collateral_type", "type": "str", "description": "The collateral type of the repo.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "collateral_amount", "type": "float", "description": "The collateral amount of the repo.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "collateral_currency", "type": "str", "description": "The currency of the collateral amount.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_currency", "type": "str", "description": "The currency of the exchange rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "exchange_rate", "type": "float", "description": "The exchange rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_sold", "type": "str", "description": "The currency sold in a Forward Derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_amount_sold", "type": "float", "description": "The amount of currency sold in a Forward Derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_bought", "type": "str", "description": "The currency bought in a Forward Derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency_amount_bought", "type": "float", "description": "The amount of currency bought in a Forward Derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "notional_amount", "type": "float", "description": "The notional amount of the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "notional_currency", "type": "str", "description": "The currency of the derivative's notional amount.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "unrealized_gain", "type": "float", "description": "The unrealized gain or loss on the derivative.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -24289,7 +27253,8 @@ "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -24305,7 +27270,8 @@ "type": "str", "description": "The CIK of the filing entity. Overrides symbol.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -24345,7 +27311,8 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fmp": [] @@ -24366,7 +27333,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -24414,119 +27382,136 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_day", "type": "float", "description": "One-day return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "wtd", "type": "float", "description": "Week to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_week", "type": "float", "description": "One-week return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "mtd", "type": "float", "description": "Month to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_month", "type": "float", "description": "One-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "qtd", "type": "float", "description": "Quarter to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_month", "type": "float", "description": "Three-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "six_month", "type": "float", "description": "Six-month return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ytd", "type": "float", "description": "Year to date return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "one_year", "type": "float", "description": "One-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "two_year", "type": "float", "description": "Two-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "three_year", "type": "float", "description": "Three-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "four_year", "type": "float", "description": "Four-year", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "five_year", "type": "float", "description": "Five-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "ten_year", "type": "float", "description": "Ten-year return.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "max", "type": "float", "description": "Return from the beginning of the time series.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -24535,7 +27520,8 @@ "type": "str", "description": "The ticker symbol.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -24555,7 +27541,8 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -24603,35 +27590,40 @@ "type": "str", "description": "The symbol of the equity requested.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "etf_symbol", "type": "str", "description": "The symbol of the ETF with exposure to the requested equity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "shares", "type": "float", "description": "The number of shares held in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "market_value", "type": "Union[int, float]", "description": "The market value of the equity position in the ETF.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [] @@ -24652,14 +27644,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -24675,7 +27669,8 @@ "type": "Literal['overnight', 'term_30', 'term_90', '1_week_term_structure', '1_month_term_structure', '3_month_term_structure', '6_month_term_structure', '1_year_term_structure', '2_year_term_structure', '30_day_ma', '90_day_ma']", "description": "Period of AMERIBOR rate.", "default": "overnight", - "optional": true + "optional": true, + "choices": null } ] }, @@ -24715,14 +27710,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "AMERIBOR rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -24743,14 +27740,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -24766,7 +27765,8 @@ "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", "description": "Period of SONIA rate.", "default": "rate", - "optional": true + "optional": true, + "choices": null } ] }, @@ -24806,14 +27806,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "SONIA rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -24834,14 +27836,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -24889,14 +27893,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "IORB rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -24917,14 +27923,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -24941,7 +27949,8 @@ "type": "Literal['monthly', 'daily', 'weekly', 'daily_excl_weekend', 'annual', 'biweekly', 'volume']", "description": "Period of FED rate.", "default": "weekly", - "optional": true + "optional": true, + "choices": null } ] }, @@ -24981,14 +27990,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "FED rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "federal_reserve": [], @@ -25019,7 +28030,8 @@ "type": "bool", "description": "Flag to show long run projections", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -25059,56 +28071,64 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "range_high", "type": "float", "description": "High projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "central_tendency_high", "type": "float", "description": "Central tendency of high projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "median", "type": "float", "description": "Median projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "range_midpoint", "type": "float", "description": "Midpoint projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "central_tendency_midpoint", "type": "float", "description": "Central tendency of midpoint projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "range_low", "type": "float", "description": "Low projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "central_tendency_low", "type": "float", "description": "Central tendency of low projection of rates.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25129,14 +28149,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25152,7 +28174,8 @@ "type": "Literal['volume_weighted_trimmed_mean_rate', 'number_of_transactions', 'number_of_active_banks', 'total_volume', 'share_of_volume_of_the_5_largest_active_banks', 'rate_at_75th_percentile_of_volume', 'rate_at_25th_percentile_of_volume']", "description": "Period of ESTR rate.", "default": "volume_weighted_trimmed_mean_rate", - "optional": true + "optional": true, + "choices": null } ] }, @@ -25192,14 +28215,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "ESTR rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25220,21 +28245,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interest_rate_type", "type": "Literal['deposit', 'lending', 'refinancing']", "description": "The type of interest rate.", "default": "lending", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25282,14 +28310,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "European Central Bank Interest Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25310,14 +28340,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25333,7 +28365,8 @@ "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", "description": "FRED series ID of DWPCR data.", "default": "daily_excl_weekend", - "optional": true + "optional": true, + "choices": null } ] }, @@ -25373,14 +28406,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Discount Window Primary Credit Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25401,21 +28436,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity", "type": "Literal['3m', '2y']", "description": "The maturity", "default": "3m", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25463,14 +28501,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "TreasuryConstantMaturity Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25491,21 +28531,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity", "type": "Literal['10y', '5y', '1y', '6m', '3m']", "description": "The maturity", "default": "10y", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25553,14 +28596,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Selected Treasury Constant Maturity Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25581,21 +28626,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity", "type": "Literal['3m', '6m']", "description": "The maturity", "default": "3m", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25643,14 +28691,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "SelectedTreasuryBill Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25671,14 +28721,16 @@ "type": "Union[date, str]", "description": "A specific date to get data for. Defaults to the most recent FRED entry.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "inflation_adjusted", "type": "bool", "description": "Get inflation adjusted rates.", "default": false, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25726,14 +28778,16 @@ "type": "float", "description": "Maturity of the treasury rate in years.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Associated rate given in decimal form (0.05 is 5%)", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -25754,14 +28808,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25810,98 +28866,112 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "week_4", "type": "float", "description": "4 week Treasury bills rate (secondary market).", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_1", "type": "float", "description": "1 month Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_2", "type": "float", "description": "2 month Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_3", "type": "float", "description": "3 month Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "month_6", "type": "float", "description": "6 month Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_1", "type": "float", "description": "1 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_2", "type": "float", "description": "2 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_3", "type": "float", "description": "3 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_5", "type": "float", "description": "5 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_7", "type": "float", "description": "7 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_10", "type": "float", "description": "10 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_20", "type": "float", "description": "20 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "year_30", "type": "float", "description": "30 year Treasury rate.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "federal_reserve": [], @@ -25923,21 +28993,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_type", "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", "description": "The type of series.", "default": "yield", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -25953,28 +29026,32 @@ "type": "Literal['all', 'duration', 'eur', 'usd']", "description": "The type of category.", "default": "all", - "optional": true + "optional": true, + "choices": null }, { "name": "area", "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", "description": "The type of area.", "default": "us", - "optional": true + "optional": true, + "choices": null }, { "name": "grade", "type": "Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector']", "description": "The type of grade.", "default": "non_sovereign", - "optional": true + "optional": true, + "choices": null }, { "name": "options", "type": "bool", "description": "Whether to include options in the results.", "default": false, - "optional": true + "optional": true, + "choices": null } ] }, @@ -26014,14 +29091,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "ICE BofA US Corporate Bond Indices Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -26042,21 +29121,24 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "index_type", "type": "Literal['aaa', 'baa']", "description": "The type of series.", "default": "aaa", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26072,7 +29154,8 @@ "type": "Literal['treasury', 'fed_funds']", "description": "The type of spread.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -26112,14 +29195,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Moody Corporate Bond Index Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -26140,14 +29225,16 @@ "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "yield_curve", "type": "Literal['spot', 'par']", "description": "The yield curve type.", "default": "spot", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26195,28 +29282,32 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "HighQualityMarketCorporateBond Rate.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "maturity", "type": "str", "description": "Maturity.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "yield_curve", "type": "Literal['spot', 'par']", "description": "The yield curve type.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [ @@ -26225,7 +29316,8 @@ "type": "str", "description": "FRED series id.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -26245,28 +29337,35 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity", "type": "Union[Union[float, str], List[Union[float, str]]]", "description": "Maturities in years. Multiple items allowed for provider(s): fred.", "default": 10.0, - "optional": true + "optional": true, + "choices": null }, { "name": "category", "type": "Union[str, List[str]]", "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", "default": "spot_rate", - "optional": true + "optional": true, + "choices": [ + "par_yield", + "spot_rate" + ] }, { "name": "provider", @@ -26314,14 +29413,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Spot Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -26342,35 +29443,40 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "maturity", "type": "Literal['overnight', '7d', '15d', '30d', '60d', '90d']", "description": "The maturity.", "default": "30d", - "optional": true + "optional": true, + "choices": null }, { "name": "category", "type": "Literal['asset_backed', 'financial', 'nonfinancial']", "description": "The category.", "default": "financial", - "optional": true + "optional": true, + "choices": null }, { "name": "grade", "type": "Literal['aa', 'a2_p2']", "description": "The grade.", "default": "aa", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26418,14 +29524,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "Commercial Paper Rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -26446,14 +29554,16 @@ "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26469,7 +29579,8 @@ "type": "Literal['overnight', '30_day', '90_day', '180_day', 'index']", "description": "Period of SOFR rate.", "default": "overnight", - "optional": true + "optional": true, + "choices": null } ] }, @@ -26509,14 +29620,16 @@ "type": "date", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "rate", "type": "float", "description": "SOFR rate.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "fred": [] @@ -26537,28 +29650,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interval", "type": "str", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26574,7 +29691,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -26583,7 +29701,8 @@ "type": "int", "description": "The number of data entries to return.", "default": 10000, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -26592,21 +29711,24 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -26615,7 +29737,8 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ] }, @@ -26655,42 +29778,48 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "Annotated[float, Strict(strict=True)]", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "Annotated[float, Strict(strict=True)]", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "Annotated[float, Strict(strict=True)]", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "Annotated[float, Strict(strict=True)]", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -26699,21 +29828,24 @@ "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [], @@ -26723,7 +29855,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -26744,28 +29877,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "interval", "type": "str", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -26781,7 +29918,8 @@ "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -26790,7 +29928,8 @@ "type": "int", "description": "The number of data entries to return.", "default": 10000, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -26799,21 +29938,24 @@ "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [ @@ -26822,7 +29964,8 @@ "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", - "optional": true + "optional": true, + "choices": null } ] }, @@ -26862,42 +30005,48 @@ "type": "Union[date, datetime]", "description": "The date of the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "open", "type": "Annotated[float, Strict(strict=True)]", "description": "The open price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "high", "type": "Annotated[float, Strict(strict=True)]", "description": "The high price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "low", "type": "Annotated[float, Strict(strict=True)]", "description": "The low price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "close", "type": "Annotated[float, Strict(strict=True)]", "description": "The close price.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -26906,21 +30055,24 @@ "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [], @@ -26930,7 +30082,8 @@ "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -26951,7 +30104,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -26967,7 +30121,8 @@ "type": "Literal['dowjones', 'sp500', 'nasdaq']", "description": "None", "default": "dowjones", - "optional": true + "optional": true, + "choices": null } ] }, @@ -27007,14 +30162,16 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "name", "type": "str", "description": "Name of the constituent company in the index.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -27023,42 +30180,48 @@ "type": "str", "description": "Sector the constituent company in the index belongs to.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "sub_sector", "type": "str", "description": "Sub-sector the constituent company in the index belongs to.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "headquarter", "type": "str", "description": "Location of the headquarter of the constituent company in the index.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "date_first_added", "type": "Union[str, date]", "description": "Date the constituent company was added to the index.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "founded", "type": "Union[str, date]", "description": "Founding year of the constituent company in the index.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -27120,14 +30283,16 @@ "type": "str", "description": "Name of the index.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "currency", "type": "str", "description": "Currency the index is traded in.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -27136,14 +30301,16 @@ "type": "str", "description": "Stock exchange where the index is listed.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "exchange_short_name", "type": "str", "description": "Short name of the stock exchange where the index is listed.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -27152,14 +30319,16 @@ "type": "str", "description": "ID code for keying the index in the OpenBB Terminal.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol for the index.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -27179,21 +30348,24 @@ "type": "int", "description": "The number of data entries to return. The number of articles to return.", "default": 2500, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -27209,84 +30381,96 @@ "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "display", "type": "Literal['headline', 'abstract', 'full']", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", "default": "full", - "optional": true + "optional": true, + "choices": null }, { "name": "updated_since", "type": "int", "description": "Number of seconds since the news was updated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "published_since", "type": "int", "description": "Number of seconds since the news was published.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['id', 'created', 'updated']", "description": "Key to sort the news by.", "default": "created", - "optional": true + "optional": true, + "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order to sort the news by.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "channels", "type": "str", "description": "Channels of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topics", "type": "str", "description": "Topics of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "authors", "type": "str", "description": "Authors of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "content_types", "type": "str", "description": "Content types of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [], @@ -27296,63 +30480,72 @@ "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", "description": "The source of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment", "type": "Literal['positive', 'neutral', 'negative']", "description": "Return news only from this source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "language", "type": "str", "description": "Filter by language. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topic", "type": "str", "description": "Filter by topic. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count_greater_than", "type": "int", "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count_less_than", "type": "int", "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_spam", "type": "bool", "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance_greater_than", "type": "float", "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance_less_than", "type": "float", "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -27361,14 +30554,16 @@ "type": "int", "description": "Page offset, used in conjunction with limit.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "str", "description": "A comma-separated list of the domains requested.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -27408,35 +30603,40 @@ "type": "datetime", "description": "The date of the data. The published date of the article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "title", "type": "str", "description": "Title of the article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "images", "type": "List[Dict[str, str]]", "description": "Images associated with the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "text", "type": "str", "description": "Text/body of the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url", "type": "str", "description": "URL to the article.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "benzinga": [ @@ -27445,49 +30645,56 @@ "type": "str", "description": "Article ID.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "author", "type": "str", "description": "Author of the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "teaser", "type": "str", "description": "Teaser of the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "channels", "type": "str", "description": "Channels associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stocks", "type": "str", "description": "Stocks associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "datetime", "description": "Updated date of the news.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -27496,7 +30703,8 @@ "type": "str", "description": "News source.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "intrinio": [ @@ -27505,91 +30713,104 @@ "type": "str", "description": "The source of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "summary", "type": "str", "description": "The summary of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topics", "type": "str", "description": "The topics related to the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count", "type": "int", "description": "The word count of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance", "type": "float", "description": "How strongly correlated the news article is to the business", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment", "type": "str", "description": "The sentiment of the news article - i.e, negative, positive.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment_confidence", "type": "float", "description": "The confidence score of the sentiment rating.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "language", "type": "str", "description": "The language of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "spam", "type": "bool", "description": "Whether the news article is spam.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "copyright", "type": "str", "description": "The copyright notice of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "company", "type": "IntrinioCompany", "description": "The Intrinio Company object. Contains details company reference data.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The Intrinio Security object. Contains the security details related to the news article.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -27598,35 +30819,40 @@ "type": "str", "description": "Ticker tagged in the fetched news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "article_id", "type": "int", "description": "Unique ID of the news article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "site", "type": "str", "description": "News source.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "crawl_date", "type": "datetime", "description": "Date the news article was crawled.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -27646,28 +30872,32 @@ "type": "Union[str, List[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 2500, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -27683,84 +30913,96 @@ "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "display", "type": "Literal['headline', 'abstract', 'full']", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", "default": "full", - "optional": true + "optional": true, + "choices": null }, { "name": "updated_since", "type": "int", "description": "Number of seconds since the news was updated.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "published_since", "type": "int", "description": "Number of seconds since the news was published.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sort", "type": "Literal['id', 'created', 'updated']", "description": "Key to sort the news by.", "default": "created", - "optional": true + "optional": true, + "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order to sort the news by.", "default": "desc", - "optional": true + "optional": true, + "choices": null }, { "name": "isin", "type": "str", "description": "The company's ISIN.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cusip", "type": "str", "description": "The company's CUSIP.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "channels", "type": "str", "description": "Channels of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topics", "type": "str", "description": "Topics of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "authors", "type": "str", "description": "Authors of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "content_types", "type": "str", "description": "Content types of the news to retrieve.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -27769,7 +31011,8 @@ "type": "int", "description": "Page number of the results. Use in combination with limit.", "default": 0, - "optional": true + "optional": true, + "choices": null } ], "intrinio": [ @@ -27778,63 +31021,72 @@ "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", "description": "The source of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment", "type": "Literal['positive', 'neutral', 'negative']", "description": "Return news only from this source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "language", "type": "str", "description": "Filter by language. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topic", "type": "str", "description": "Filter by topic. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count_greater_than", "type": "int", "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count_less_than", "type": "int", "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "is_spam", "type": "bool", "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance_greater_than", "type": "float", "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance_less_than", "type": "float", "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -27843,7 +31095,8 @@ "type": "Literal['asc', 'desc']", "description": "Sort order of the articles.", "default": "desc", - "optional": true + "optional": true, + "choices": null } ], "tiingo": [ @@ -27852,14 +31105,16 @@ "type": "int", "description": "Page offset, used in conjunction with limit.", "default": 0, - "optional": true + "optional": true, + "choices": null }, { "name": "source", "type": "str", "description": "A comma-separated list of the domains requested.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "yfinance": [] @@ -27900,42 +31155,48 @@ "type": "datetime", "description": "The date of the data. Here it is the published date of the article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "title", "type": "str", "description": "Title of the article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "text", "type": "str", "description": "Text/body of the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "images", "type": "List[Dict[str, str]]", "description": "Images associated with the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "url", "type": "str", "description": "URL to the article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "symbols", "type": "str", "description": "Symbols associated with the article.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "benzinga": [ @@ -27944,56 +31205,64 @@ "type": "List[Dict[str, str]]", "description": "URL to the images of the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "author", "type": "str", "description": "Author of the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "teaser", "type": "str", "description": "Teaser of the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "channels", "type": "str", "description": "Channels associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "stocks", "type": "str", "description": "Stocks associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "updated", "type": "datetime", "description": "Updated date of the news.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "fmp": [ @@ -28002,7 +31271,8 @@ "type": "str", "description": "Name of the news source.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "intrinio": [ @@ -28011,84 +31281,96 @@ "type": "str", "description": "The source of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "summary", "type": "str", "description": "The summary of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "topics", "type": "str", "description": "The topics related to the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "word_count", "type": "int", "description": "The word count of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "business_relevance", "type": "float", "description": "How strongly correlated the news article is to the business", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment", "type": "str", "description": "The sentiment of the news article - i.e, negative, positive.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "sentiment_confidence", "type": "float", "description": "The confidence score of the sentiment rating.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "language", "type": "str", "description": "The language of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "spam", "type": "bool", "description": "Whether the news article is spam.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "copyright", "type": "str", "description": "The copyright notice of the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The Intrinio Security object. Contains the security details related to the news article.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "polygon": [ @@ -28097,35 +31379,40 @@ "type": "str", "description": "Source of the article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "tags", "type": "str", "description": "Keywords/tags in the article", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "amp_url", "type": "str", "description": "AMP URL.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "publisher", "type": "PolygonPublisher", "description": "Publisher of the article.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "tiingo": [ @@ -28134,28 +31421,32 @@ "type": "str", "description": "Tags associated with the news article.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "article_id", "type": "int", "description": "Unique ID of the news article.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "source", "type": "str", "description": "News source.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "crawl_date", "type": "datetime", "description": "Date the news article was crawled.", "default": "", - "optional": false + "optional": false, + "choices": null } ], "yfinance": [ @@ -28164,7 +31455,8 @@ "type": "str", "description": "Source of the news article", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -28184,7 +31476,8 @@ "type": "str", "description": "Symbol to get data for.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "provider", @@ -28200,7 +31493,8 @@ "type": "bool", "description": "Whether or not to use cache for the request, default is True.", "default": true, - "optional": true + "optional": true, + "choices": null } ] }, @@ -28240,7 +31534,8 @@ "type": "Union[int, str]", "description": "Central Index Key (CIK) for the requested entity.", "default": null, - "optional": true + "optional": true, + "choices": null } ], "sec": [] @@ -28261,14 +31556,16 @@ "type": "str", "description": "Search query.", "default": "", - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -28317,14 +31614,16 @@ "type": "str", "description": "The name of the institution.", "default": null, - "optional": true + "optional": true, + "choices": null }, { "name": "cik", "type": "Union[int, str]", "description": "Central Index Key (CIK)", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -28344,14 +31643,16 @@ "type": "str", "description": "Search query.", "default": "", - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -28367,7 +31668,8 @@ "type": "str", "description": "Enter an optional URL path to fetch the next level.", "default": null, - "optional": true + "optional": true, + "choices": null } ] }, @@ -28408,7 +31710,8 @@ "type": "List[str]", "description": "Dictionary of URLs to SEC Schema Files", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -28428,14 +31731,16 @@ "type": "str", "description": "Search query.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache. If True, cache will store for seven days.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -28484,7 +31789,8 @@ "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -28546,35 +31852,40 @@ "type": "datetime", "description": "The date of publication.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "title", "type": "str", "description": "The title of the release.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "summary", "type": "str", "description": "Short summary of the release.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "id", "type": "str", "description": "The identifier associated with the release.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "link", "type": "str", "description": "URL to the release.", "default": "", - "optional": false + "optional": false, + "choices": null } ] }, @@ -28594,14 +31905,16 @@ "type": "str", "description": "Search query.", "default": "", - "optional": true + "optional": true, + "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, - "optional": true + "optional": true, + "choices": null }, { "name": "provider", @@ -28650,21 +31963,24 @@ "type": "int", "description": "Sector Industrial Code (SIC)", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "industry", "type": "str", "description": "Industry title.", "default": "", - "optional": false + "optional": false, + "choices": null }, { "name": "office", "type": "str", "description": "Reporting office within the Corporate Finance Office", "default": "", - "optional": false + "optional": false, + "choices": null } ] },