diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index 79cf66ca6e0..c06597475a3 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -1,16 +1,16 @@ { - "openbb": "4.4.1", + "openbb": "4.4.2", "info": { "title": "OpenBB Platform (Python)", "description": "Investment research for everyone, anywhere.", - "core": "1.4.2", + "core": "1.4.3", "extensions": { "openbb_core_extension": [ "commodity@1.3.0", "crypto@1.4.0", "currency@1.4.0", "derivatives@1.4.0", - "economy@1.4.0", + "economy@1.4.1", "equity@1.4.0", "etf@1.4.0", "fixedincome@1.4.2", @@ -20,21 +20,21 @@ ], "openbb_provider_extension": [ "benzinga@1.4.0", - "bls@1.1.0", + "bls@1.1.1", "cftc@1.1.0", "econdb@1.3.0", - "federal_reserve@1.4.0", + "federal_reserve@1.4.1", "fmp@1.4.1", "fred@1.4.1", "imf@1.1.0", "intrinio@1.4.0", "oecd@1.4.0", "polygon@1.4.0", - "sec@1.4.1", + "sec@1.4.2", "tiingo@1.4.0", "tradingeconomics@1.4.0", "us_eia@1.1.0", - "yfinance@1.4.1" + "yfinance@1.4.2" ], "openbb_obbject_extension": [] } @@ -147,7 +147,7 @@ "OBBject": [ { "name": "results", - "type": "List[CommoditySpotPrices]", + "type": "list[CommoditySpotPrices]", "description": "Serializable results." }, { @@ -157,8 +157,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -167,7 +167,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -217,7 +217,10 @@ ], "fred": [] }, - "model": "CommoditySpotPrices" + "model": "CommoditySpotPrices", + "openapi_extra": { + "model": "CommoditySpotPrices" + } }, "/commodity/petroleum_status_report": { "deprecated": { @@ -270,7 +273,7 @@ }, { "name": "table", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The specific table element within the category to be returned, default is 'stocks', if the category is 'weekly_estimates', else 'all'.\n Note: Choices represent all available tables from the entire collection and are not all available for every category.\n Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category.\n Choices are:\n all\n conventional_gas\n crude\n crude_production\n crude_production_avg\n diesel\n ethanol_plant_production\n ethanol_plant_production_avg\n exports\n exports_avg\n heating_oil\n imports\n imports_avg\n imports_by_country\n imports_by_country_avg\n inputs_and_utilization\n inputs_and_utilization_avg\n jet_fuel\n monthly\n net_imports_inc_spr_avg\n net_imports_incl_spr\n net_production\n net_production_avg\n net_production_by_product\n net_production_by_production_avg\n product_by_region\n product_by_region_avg\n product_supplied\n product_supplied_avg\n propane\n rbob\n refiner_blender_net_production\n refiner_blender_net_production_avg\n stocks\n supply\n supply_avg\n ulta_low_sulfur_distillate_reclassification\n ulta_low_sulfur_distillate_reclassification_avg\n weekly Multiple items allowed for provider(s): eia.", "default": null, "optional": true, @@ -330,7 +333,7 @@ "OBBject": [ { "name": "results", - "type": "List[PetroleumStatusReport]", + "type": "list[PetroleumStatusReport]", "description": "Serializable results." }, { @@ -340,8 +343,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -350,7 +353,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -416,7 +419,10 @@ ], "eia": [] }, - "model": "PetroleumStatusReport" + "model": "PetroleumStatusReport", + "openapi_extra": { + "model": "PetroleumStatusReport" + } }, "/commodity/short_term_energy_outlook": { "deprecated": { @@ -447,7 +453,7 @@ "eia": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. If provided, overrides the 'table' parameter to return only the specified symbol from the STEO API. Multiple items allowed for provider(s): eia.", "default": null, "optional": true, @@ -506,7 +512,7 @@ "OBBject": [ { "name": "results", - "type": "List[ShortTermEnergyOutlook]", + "type": "list[ShortTermEnergyOutlook]", "description": "Serializable results." }, { @@ -516,8 +522,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -526,7 +532,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -592,7 +598,10 @@ ], "eia": [] }, - "model": "ShortTermEnergyOutlook" + "model": "ShortTermEnergyOutlook", + "openapi_extra": { + "model": "ShortTermEnergyOutlook" + } }, "/crypto/price/historical": { "deprecated": { @@ -605,7 +614,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "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, @@ -695,7 +704,7 @@ }, { "name": "exchanges", - "type": "Union[Union[list[str], str], List[Union[list[str], str]]]", + "type": "Union[Union[list[str], str], list[Union[list[str], str]]]", "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple items allowed for provider(s): tiingo.", "default": null, "optional": true, @@ -731,7 +740,7 @@ "OBBject": [ { "name": "results", - "type": "List[CryptoHistorical]", + "type": "list[CryptoHistorical]", "description": "Serializable results." }, { @@ -741,8 +750,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -751,7 +760,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -871,7 +880,10 @@ ], "yfinance": [] }, - "model": "CryptoHistorical" + "model": "CryptoHistorical", + "openapi_extra": { + "model": "CryptoHistorical" + } }, "/crypto/search": { "deprecated": { @@ -897,7 +909,7 @@ "OBBject": [ { "name": "results", - "type": "List[CryptoSearch]", + "type": "list[CryptoSearch]", "description": "Serializable results." }, { @@ -907,8 +919,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -917,7 +929,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -968,7 +980,10 @@ } ] }, - "model": "CryptoSearch" + "model": "CryptoSearch", + "openapi_extra": { + "model": "CryptoSearch" + } }, "/currency/price/historical": { "deprecated": { @@ -981,7 +996,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "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, @@ -1099,7 +1114,7 @@ "OBBject": [ { "name": "results", - "type": "List[CurrencyHistorical]", + "type": "list[CurrencyHistorical]", "description": "Serializable results." }, { @@ -1109,8 +1124,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -1119,7 +1134,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -1222,7 +1237,10 @@ "tiingo": [], "yfinance": [] }, - "model": "CurrencyHistorical" + "model": "CurrencyHistorical", + "openapi_extra": { + "model": "CurrencyHistorical" + } }, "/currency/search": { "deprecated": { @@ -1250,7 +1268,7 @@ "OBBject": [ { "name": "results", - "type": "List[CurrencyPairs]", + "type": "list[CurrencyPairs]", "description": "Serializable results." }, { @@ -1260,8 +1278,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -1270,7 +1288,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -1405,7 +1423,10 @@ } ] }, - "model": "CurrencyPairs" + "model": "CurrencyPairs", + "openapi_extra": { + "model": "CurrencyPairs" + } }, "/currency/snapshots": { "deprecated": { @@ -1418,7 +1439,7 @@ "standard": [ { "name": "base", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", "default": "usd", "optional": true, @@ -1434,7 +1455,7 @@ }, { "name": "counter_currencies", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "An optional list of counter currency symbols to filter for. None returns all.", "default": null, "optional": true, @@ -1448,7 +1469,7 @@ "OBBject": [ { "name": "results", - "type": "List[CurrencySnapshots]", + "type": "list[CurrencySnapshots]", "description": "Serializable results." }, { @@ -1458,8 +1479,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -1468,7 +1489,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -1769,7 +1790,10 @@ } ] }, - "model": "CurrencySnapshots" + "model": "CurrencySnapshots", + "openapi_extra": { + "model": "CurrencySnapshots" + } }, "/derivatives/options/chains": { "deprecated": { @@ -1915,7 +1939,7 @@ "OBBject": [ { "name": "results", - "type": "List[OptionsChains]", + "type": "list[OptionsChains]", "description": "Serializable results." }, { @@ -1925,8 +1949,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -1935,7 +1959,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -1944,7 +1968,7 @@ "standard": [ { "name": "underlying_symbol", - "type": "List[str]", + "type": "list[str]", "description": "Underlying symbol for the option.", "default": "", "optional": true, @@ -1952,7 +1976,7 @@ }, { "name": "underlying_price", - "type": "List[float]", + "type": "list[float]", "description": "Price of the underlying stock.", "default": "", "optional": true, @@ -1960,7 +1984,7 @@ }, { "name": "contract_symbol", - "type": "List[str]", + "type": "list[str]", "description": "Contract symbol for the option.", "default": "", "optional": false, @@ -1968,7 +1992,7 @@ }, { "name": "eod_date", - "type": "List[date]", + "type": "list[date]", "description": "Date for which the options chains are returned.", "default": "", "optional": true, @@ -1976,7 +2000,7 @@ }, { "name": "expiration", - "type": "List[date]", + "type": "list[date]", "description": "Expiration date of the contract.", "default": "", "optional": false, @@ -1984,7 +2008,7 @@ }, { "name": "dte", - "type": "List[int]", + "type": "list[int]", "description": "Days to expiration of the contract.", "default": "", "optional": true, @@ -1992,7 +2016,7 @@ }, { "name": "strike", - "type": "List[float]", + "type": "list[float]", "description": "Strike price of the contract.", "default": "", "optional": false, @@ -2000,7 +2024,7 @@ }, { "name": "option_type", - "type": "List[str]", + "type": "list[str]", "description": "Call or Put.", "default": "", "optional": false, @@ -2008,7 +2032,7 @@ }, { "name": "contract_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "Number of underlying units per contract.", "default": "", "optional": true, @@ -2016,7 +2040,7 @@ }, { "name": "open_interest", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "Open interest on the contract.", "default": "", "optional": true, @@ -2024,7 +2048,7 @@ }, { "name": "volume", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "The trading volume.", "default": "", "optional": true, @@ -2032,7 +2056,7 @@ }, { "name": "theoretical_price", - "type": "List[float]", + "type": "list[float]", "description": "Theoretical value of the option.", "default": "", "optional": true, @@ -2040,7 +2064,7 @@ }, { "name": "last_trade_price", - "type": "List[float]", + "type": "list[float]", "description": "Last trade price of the option.", "default": "", "optional": true, @@ -2048,7 +2072,7 @@ }, { "name": "last_trade_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "Last trade size of the option.", "default": "", "optional": true, @@ -2056,7 +2080,7 @@ }, { "name": "last_trade_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The timestamp of the last trade.", "default": "", "optional": true, @@ -2064,7 +2088,7 @@ }, { "name": "tick", - "type": "List[str]", + "type": "list[str]", "description": "Whether the last tick was up or down in price.", "default": "", "optional": true, @@ -2072,7 +2096,7 @@ }, { "name": "bid", - "type": "List[float]", + "type": "list[float]", "description": "Current bid price for the option.", "default": "", "optional": true, @@ -2080,7 +2104,7 @@ }, { "name": "bid_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "Bid size for the option.", "default": "", "optional": true, @@ -2088,7 +2112,7 @@ }, { "name": "bid_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The timestamp of the bid price.", "default": "", "optional": true, @@ -2096,7 +2120,7 @@ }, { "name": "bid_exchange", - "type": "List[str]", + "type": "list[str]", "description": "The exchange of the bid price.", "default": "", "optional": true, @@ -2104,7 +2128,7 @@ }, { "name": "ask", - "type": "List[float]", + "type": "list[float]", "description": "Current ask price for the option.", "default": "", "optional": true, @@ -2112,7 +2136,7 @@ }, { "name": "ask_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "Ask size for the option.", "default": "", "optional": true, @@ -2120,7 +2144,7 @@ }, { "name": "ask_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The timestamp of the ask price.", "default": "", "optional": true, @@ -2128,7 +2152,7 @@ }, { "name": "ask_exchange", - "type": "List[str]", + "type": "list[str]", "description": "The exchange of the ask price.", "default": "", "optional": true, @@ -2136,7 +2160,7 @@ }, { "name": "mark", - "type": "List[float]", + "type": "list[float]", "description": "The mid-price between the latest bid and ask.", "default": "", "optional": true, @@ -2144,7 +2168,7 @@ }, { "name": "open", - "type": "List[float]", + "type": "list[float]", "description": "The open price.", "default": "", "optional": true, @@ -2152,7 +2176,7 @@ }, { "name": "open_bid", - "type": "List[float]", + "type": "list[float]", "description": "The opening bid price for the option that day.", "default": "", "optional": true, @@ -2160,7 +2184,7 @@ }, { "name": "open_ask", - "type": "List[float]", + "type": "list[float]", "description": "The opening ask price for the option that day.", "default": "", "optional": true, @@ -2168,7 +2192,7 @@ }, { "name": "high", - "type": "List[float]", + "type": "list[float]", "description": "The high price.", "default": "", "optional": true, @@ -2176,7 +2200,7 @@ }, { "name": "bid_high", - "type": "List[float]", + "type": "list[float]", "description": "The highest bid price for the option that day.", "default": "", "optional": true, @@ -2184,7 +2208,7 @@ }, { "name": "ask_high", - "type": "List[float]", + "type": "list[float]", "description": "The highest ask price for the option that day.", "default": "", "optional": true, @@ -2192,7 +2216,7 @@ }, { "name": "low", - "type": "List[float]", + "type": "list[float]", "description": "The low price.", "default": "", "optional": true, @@ -2200,7 +2224,7 @@ }, { "name": "bid_low", - "type": "List[float]", + "type": "list[float]", "description": "The lowest bid price for the option that day.", "default": "", "optional": true, @@ -2208,7 +2232,7 @@ }, { "name": "ask_low", - "type": "List[float]", + "type": "list[float]", "description": "The lowest ask price for the option that day.", "default": "", "optional": true, @@ -2216,7 +2240,7 @@ }, { "name": "close", - "type": "List[float]", + "type": "list[float]", "description": "The close price.", "default": "", "optional": true, @@ -2224,7 +2248,7 @@ }, { "name": "close_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "The closing trade size for the option that day.", "default": "", "optional": true, @@ -2232,7 +2256,7 @@ }, { "name": "close_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The time of the closing price for the option that day.", "default": "", "optional": true, @@ -2240,7 +2264,7 @@ }, { "name": "close_bid", - "type": "List[float]", + "type": "list[float]", "description": "The closing bid price for the option that day.", "default": "", "optional": true, @@ -2248,7 +2272,7 @@ }, { "name": "close_bid_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "The closing bid size for the option that day.", "default": "", "optional": true, @@ -2256,7 +2280,7 @@ }, { "name": "close_bid_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The time of the bid closing price for the option that day.", "default": "", "optional": true, @@ -2264,7 +2288,7 @@ }, { "name": "close_ask", - "type": "List[float]", + "type": "list[float]", "description": "The closing ask price for the option that day.", "default": "", "optional": true, @@ -2272,7 +2296,7 @@ }, { "name": "close_ask_size", - "type": "List[Union[int, float]]", + "type": "list[Union[int, float]]", "description": "The closing ask size for the option that day.", "default": "", "optional": true, @@ -2280,7 +2304,7 @@ }, { "name": "close_ask_time", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The time of the ask closing price for the option that day.", "default": "", "optional": true, @@ -2288,7 +2312,7 @@ }, { "name": "prev_close", - "type": "List[float]", + "type": "list[float]", "description": "The previous close price.", "default": "", "optional": true, @@ -2296,7 +2320,7 @@ }, { "name": "change", - "type": "List[float]", + "type": "list[float]", "description": "The change in the price of the option.", "default": "", "optional": true, @@ -2304,7 +2328,7 @@ }, { "name": "change_percent", - "type": "List[float]", + "type": "list[float]", "description": "Change, in normalized percentage points, of the option.", "default": "", "optional": true, @@ -2312,7 +2336,7 @@ }, { "name": "implied_volatility", - "type": "List[float]", + "type": "list[float]", "description": "Implied volatility of the option.", "default": "", "optional": true, @@ -2320,7 +2344,7 @@ }, { "name": "delta", - "type": "List[float]", + "type": "list[float]", "description": "Delta of the option.", "default": "", "optional": true, @@ -2328,7 +2352,7 @@ }, { "name": "gamma", - "type": "List[float]", + "type": "list[float]", "description": "Gamma of the option.", "default": "", "optional": true, @@ -2336,7 +2360,7 @@ }, { "name": "theta", - "type": "List[float]", + "type": "list[float]", "description": "Theta of the option.", "default": "", "optional": true, @@ -2344,7 +2368,7 @@ }, { "name": "vega", - "type": "List[float]", + "type": "list[float]", "description": "Vega of the option.", "default": "", "optional": true, @@ -2352,7 +2376,7 @@ }, { "name": "rho", - "type": "List[float]", + "type": "list[float]", "description": "Rho of the option.", "default": "", "optional": true, @@ -2363,7 +2387,7 @@ "yfinance": [ { "name": "in_the_money", - "type": "List[bool]", + "type": "list[bool]", "description": "Whether the option is in the money.", "default": "", "optional": true, @@ -2371,7 +2395,7 @@ }, { "name": "currency", - "type": "List[str]", + "type": "list[str]", "description": "Currency of the option.", "default": "", "optional": true, @@ -2379,7 +2403,10 @@ } ] }, - "model": "OptionsChains" + "model": "OptionsChains", + "openapi_extra": { + "model": "OptionsChains" + } }, "/derivatives/options/unusual": { "deprecated": { @@ -2470,7 +2497,7 @@ "OBBject": [ { "name": "results", - "type": "List[OptionsUnusual]", + "type": "list[OptionsUnusual]", "description": "Serializable results." }, { @@ -2480,8 +2507,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -2490,7 +2517,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -2589,7 +2616,10 @@ } ] }, - "model": "OptionsUnusual" + "model": "OptionsUnusual", + "openapi_extra": { + "model": "OptionsUnusual" + } }, "/derivatives/options/snapshots": { "deprecated": { @@ -2623,7 +2653,7 @@ "OBBject": [ { "name": "results", - "type": "List[OptionsSnapshots]", + "type": "list[OptionsSnapshots]", "description": "Serializable results." }, { @@ -2633,8 +2663,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -2643,7 +2673,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -2652,7 +2682,7 @@ "standard": [ { "name": "underlying_symbol", - "type": "List[str]", + "type": "list[str]", "description": "Ticker symbol of the underlying asset.", "default": "", "optional": false, @@ -2660,7 +2690,7 @@ }, { "name": "contract_symbol", - "type": "List[str]", + "type": "list[str]", "description": "Symbol of the options contract.", "default": "", "optional": false, @@ -2668,7 +2698,7 @@ }, { "name": "expiration", - "type": "List[date]", + "type": "list[date]", "description": "Expiration date of the options contract.", "default": "", "optional": false, @@ -2676,7 +2706,7 @@ }, { "name": "dte", - "type": "List[int]", + "type": "list[int]", "description": "Number of days to expiration of the options contract.", "default": "", "optional": true, @@ -2684,7 +2714,7 @@ }, { "name": "strike", - "type": "List[float]", + "type": "list[float]", "description": "Strike price of the options contract.", "default": "", "optional": false, @@ -2692,7 +2722,7 @@ }, { "name": "option_type", - "type": "List[str]", + "type": "list[str]", "description": "The type of option.", "default": "", "optional": false, @@ -2700,7 +2730,7 @@ }, { "name": "volume", - "type": "List[int]", + "type": "list[int]", "description": "The trading volume.", "default": "", "optional": true, @@ -2708,7 +2738,7 @@ }, { "name": "open_interest", - "type": "List[int]", + "type": "list[int]", "description": "Open interest at the time.", "default": "", "optional": true, @@ -2716,7 +2746,7 @@ }, { "name": "last_price", - "type": "List[float]", + "type": "list[float]", "description": "Last trade price at the time.", "default": "", "optional": true, @@ -2724,7 +2754,7 @@ }, { "name": "last_size", - "type": "List[int]", + "type": "list[int]", "description": "Lot size of the last trade.", "default": "", "optional": true, @@ -2732,7 +2762,7 @@ }, { "name": "last_timestamp", - "type": "List[datetime]", + "type": "list[datetime]", "description": "Timestamp of the last price.", "default": "", "optional": true, @@ -2740,7 +2770,7 @@ }, { "name": "open", - "type": "List[float]", + "type": "list[float]", "description": "The open price.", "default": "", "optional": true, @@ -2748,7 +2778,7 @@ }, { "name": "high", - "type": "List[float]", + "type": "list[float]", "description": "The high price.", "default": "", "optional": true, @@ -2756,7 +2786,7 @@ }, { "name": "low", - "type": "List[float]", + "type": "list[float]", "description": "The low price.", "default": "", "optional": true, @@ -2764,7 +2794,7 @@ }, { "name": "close", - "type": "List[float]", + "type": "list[float]", "description": "The close price.", "default": "", "optional": true, @@ -2774,7 +2804,7 @@ "intrinio": [ { "name": "bid", - "type": "List[float]", + "type": "list[float]", "description": "The last bid price at the time.", "default": "", "optional": true, @@ -2782,7 +2812,7 @@ }, { "name": "bid_size", - "type": "List[int]", + "type": "list[int]", "description": "The size of the last bid price.", "default": "", "optional": true, @@ -2790,7 +2820,7 @@ }, { "name": "bid_timestamp", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The timestamp of the last bid price.", "default": "", "optional": true, @@ -2798,7 +2828,7 @@ }, { "name": "ask", - "type": "List[float]", + "type": "list[float]", "description": "The last ask price at the time.", "default": "", "optional": true, @@ -2806,7 +2836,7 @@ }, { "name": "ask_size", - "type": "List[int]", + "type": "list[int]", "description": "The size of the last ask price.", "default": "", "optional": true, @@ -2814,7 +2844,7 @@ }, { "name": "ask_timestamp", - "type": "List[datetime]", + "type": "list[datetime]", "description": "The timestamp of the last ask price.", "default": "", "optional": true, @@ -2822,7 +2852,7 @@ }, { "name": "total_bid_volume", - "type": "List[int]", + "type": "list[int]", "description": "Total volume of bids.", "default": "", "optional": true, @@ -2830,7 +2860,7 @@ }, { "name": "bid_high", - "type": "List[float]", + "type": "list[float]", "description": "The highest bid price.", "default": "", "optional": true, @@ -2838,7 +2868,7 @@ }, { "name": "bid_low", - "type": "List[float]", + "type": "list[float]", "description": "The lowest bid price.", "default": "", "optional": true, @@ -2846,7 +2876,7 @@ }, { "name": "total_ask_volume", - "type": "List[int]", + "type": "list[int]", "description": "Total volume of asks.", "default": "", "optional": true, @@ -2854,7 +2884,7 @@ }, { "name": "ask_high", - "type": "List[float]", + "type": "list[float]", "description": "The highest ask price.", "default": "", "optional": true, @@ -2862,7 +2892,7 @@ }, { "name": "ask_low", - "type": "List[float]", + "type": "list[float]", "description": "The lowest ask price.", "default": "", "optional": true, @@ -2870,7 +2900,10 @@ } ] }, - "model": "OptionsSnapshots" + "model": "OptionsSnapshots", + "openapi_extra": { + "model": "OptionsSnapshots" + } }, "/derivatives/futures/historical": { "deprecated": { @@ -2883,7 +2916,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false, @@ -2929,7 +2962,7 @@ "OBBject": [ { "name": "results", - "type": "List[FuturesHistorical]", + "type": "list[FuturesHistorical]", "description": "Serializable results." }, { @@ -2939,8 +2972,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -2949,7 +2982,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3007,7 +3040,10 @@ ], "yfinance": [] }, - "model": "FuturesHistorical" + "model": "FuturesHistorical", + "openapi_extra": { + "model": "FuturesHistorical" + } }, "/derivatives/futures/curve": { "deprecated": { @@ -3028,7 +3064,7 @@ }, { "name": "date", - "type": "Union[Union[date, str], List[Union[date, str]]]", + "type": "Union[Union[date, str], list[Union[date, str]]]", "description": "A specific date to get data for. Multiple items allowed for provider(s): yfinance.", "default": null, "optional": true, @@ -3041,7 +3077,7 @@ "OBBject": [ { "name": "results", - "type": "List[FuturesCurve]", + "type": "list[FuturesCurve]", "description": "Serializable results." }, { @@ -3051,8 +3087,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -3061,7 +3097,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3095,7 +3131,10 @@ ], "yfinance": [] }, - "model": "FuturesCurve" + "model": "FuturesCurve", + "openapi_extra": { + "model": "FuturesCurve" + } }, "/economy/gdp/forecast": { "deprecated": { @@ -3126,7 +3165,7 @@ "oecd": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Country, or countries, to get forward GDP projections for. Default is all. Multiple items allowed for provider(s): oecd.", "default": "all", "optional": true, @@ -3215,7 +3254,7 @@ "OBBject": [ { "name": "results", - "type": "List[GdpForecast]", + "type": "list[GdpForecast]", "description": "Serializable results." }, { @@ -3225,8 +3264,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -3235,7 +3274,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3269,7 +3308,10 @@ ], "oecd": [] }, - "model": "GdpForecast" + "model": "GdpForecast", + "openapi_extra": { + "model": "GdpForecast" + } }, "/economy/gdp/nominal": { "deprecated": { @@ -3300,7 +3342,7 @@ "econdb": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data.Use 'all' to get data for all available countries. Multiple items allowed for provider(s): econdb.", "default": "united_states", "optional": true, @@ -3318,7 +3360,7 @@ "oecd": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Use 'all' to get data for all available countries. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, @@ -3423,7 +3465,7 @@ "OBBject": [ { "name": "results", - "type": "List[GdpNominal]", + "type": "list[GdpNominal]", "description": "Serializable results." }, { @@ -3433,8 +3475,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -3443,7 +3485,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3503,7 +3545,10 @@ ], "oecd": [] }, - "model": "GdpNominal" + "model": "GdpNominal", + "openapi_extra": { + "model": "GdpNominal" + } }, "/economy/gdp/real": { "deprecated": { @@ -3534,7 +3579,7 @@ "econdb": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data.Use 'all' to get data for all available countries. Multiple items allowed for provider(s): econdb.", "default": "united_states", "optional": true, @@ -3552,7 +3597,7 @@ "oecd": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Use 'all' to get data for all available countries. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, @@ -3634,7 +3679,7 @@ "OBBject": [ { "name": "results", - "type": "List[GdpReal]", + "type": "list[GdpReal]", "description": "Serializable results." }, { @@ -3644,8 +3689,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -3654,7 +3699,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3714,7 +3759,10 @@ ], "oecd": [] }, - "model": "GdpReal" + "model": "GdpReal", + "openapi_extra": { + "model": "GdpReal" + } }, "/economy/survey/bls_series": { "deprecated": { @@ -3727,7 +3775,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): bls.", "default": "", "optional": false, @@ -3781,7 +3829,7 @@ "OBBject": [ { "name": "results", - "type": "List[BlsSeries]", + "type": "list[BlsSeries]", "description": "Serializable results." }, { @@ -3791,8 +3839,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -3801,7 +3849,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -3924,7 +3972,10 @@ } ] }, - "model": "BlsSeries" + "model": "BlsSeries", + "openapi_extra": { + "model": "BlsSeries" + } }, "/economy/survey/bls_search": { "deprecated": { @@ -3989,7 +4040,7 @@ "OBBject": [ { "name": "results", - "type": "List[BlsSearch]", + "type": "list[BlsSearch]", "description": "Serializable results." }, { @@ -3999,8 +4050,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4009,7 +4060,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4043,7 +4094,10 @@ ], "bls": [] }, - "model": "BlsSearch" + "model": "BlsSearch", + "openapi_extra": { + "model": "BlsSearch" + } }, "/economy/survey/sloos": { "deprecated": { @@ -4114,7 +4168,7 @@ "OBBject": [ { "name": "results", - "type": "List[SeniorLoanOfficerSurvey]", + "type": "list[SeniorLoanOfficerSurvey]", "description": "Serializable results." }, { @@ -4124,8 +4178,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4134,7 +4188,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4176,7 +4230,10 @@ ], "fred": [] }, - "model": "SeniorLoanOfficerSurvey" + "model": "SeniorLoanOfficerSurvey", + "openapi_extra": { + "model": "SeniorLoanOfficerSurvey" + } }, "/economy/survey/university_of_michigan": { "deprecated": { @@ -4251,7 +4308,7 @@ "OBBject": [ { "name": "results", - "type": "List[UniversityOfMichigan]", + "type": "list[UniversityOfMichigan]", "description": "Serializable results." }, { @@ -4261,8 +4318,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4271,7 +4328,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4305,7 +4362,10 @@ ], "fred": [] }, - "model": "UniversityOfMichigan" + "model": "UniversityOfMichigan", + "openapi_extra": { + "model": "UniversityOfMichigan" + } }, "/economy/survey/economic_conditions_chicago": { "deprecated": { @@ -4380,7 +4440,7 @@ "OBBject": [ { "name": "results", - "type": "List[SurveyOfEconomicConditionsChicago]", + "type": "list[SurveyOfEconomicConditionsChicago]", "description": "Serializable results." }, { @@ -4390,8 +4450,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4400,7 +4460,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4490,7 +4550,10 @@ ], "fred": [] }, - "model": "SurveyOfEconomicConditionsChicago" + "model": "SurveyOfEconomicConditionsChicago", + "openapi_extra": { + "model": "SurveyOfEconomicConditionsChicago" + } }, "/economy/survey/manufacturing_outlook_texas": { "deprecated": { @@ -4521,7 +4584,7 @@ "fred": [ { "name": "topic", - "type": "Union[Union[Literal['business_activity', 'business_outlook', 'capex', 'prices_paid', 'production', 'inventory', 'new_orders', 'new_orders_growth', 'unfilled_orders', 'shipments', 'delivery_time', 'employment', 'wages', 'hours_worked'], str], List[Union[Literal['business_activity', 'business_outlook', 'capex', 'prices_paid', 'production', 'inventory', 'new_orders', 'new_orders_growth', 'unfilled_orders', 'shipments', 'delivery_time', 'employment', 'wages', 'hours_worked'], str]]]", + "type": "Union[Union[Literal['business_activity', 'business_outlook', 'capex', 'prices_paid', 'production', 'inventory', 'new_orders', 'new_orders_growth', 'unfilled_orders', 'shipments', 'delivery_time', 'employment', 'wages', 'hours_worked'], str], list[Union[Literal['business_activity', 'business_outlook', 'capex', 'prices_paid', 'production', 'inventory', 'new_orders', 'new_orders_growth', 'unfilled_orders', 'shipments', 'delivery_time', 'employment', 'wages', 'hours_worked'], str]]]", "description": "The topic for the survey response. Multiple items allowed for provider(s): fred.", "default": "new_orders_growth", "optional": true, @@ -4588,7 +4651,7 @@ "OBBject": [ { "name": "results", - "type": "List[ManufacturingOutlookTexas]", + "type": "list[ManufacturingOutlookTexas]", "description": "Serializable results." }, { @@ -4598,8 +4661,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4608,7 +4671,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4666,7 +4729,10 @@ ], "fred": [] }, - "model": "ManufacturingOutlookTexas" + "model": "ManufacturingOutlookTexas", + "openapi_extra": { + "model": "ManufacturingOutlookTexas" + } }, "/economy/survey/nonfarm_payrolls": { "deprecated": { @@ -4679,7 +4745,7 @@ "standard": [ { "name": "date", - "type": "Union[Union[date, str], List[Union[date, str]]]", + "type": "Union[Union[date, str], list[Union[date, str]]]", "description": "A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -4719,7 +4785,7 @@ "OBBject": [ { "name": "results", - "type": "List[NonFarmPayrolls]", + "type": "list[NonFarmPayrolls]", "description": "Serializable results." }, { @@ -4729,8 +4795,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -4739,7 +4805,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -4814,7 +4880,10 @@ } ] }, - "model": "NonFarmPayrolls" + "model": "NonFarmPayrolls", + "openapi_extra": { + "model": "NonFarmPayrolls" + } }, "/economy/calendar": { "deprecated": { @@ -4846,7 +4915,7 @@ "tradingeconomics": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", "default": null, "optional": true, @@ -5086,7 +5155,7 @@ }, { "name": "calendar_id", - "type": "Union[Union[None, int, str], List[Union[None, int, str]]]", + "type": "Union[Union[None, int, str], list[Union[None, int, str]]]", "description": "Get events by TradingEconomics Calendar ID. Multiple items allowed for provider(s): tradingeconomics.", "default": null, "optional": true, @@ -5098,7 +5167,7 @@ "OBBject": [ { "name": "results", - "type": "List[EconomicCalendar]", + "type": "list[EconomicCalendar]", "description": "Serializable results." }, { @@ -5108,8 +5177,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -5118,7 +5187,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -5339,7 +5408,10 @@ } ] }, - "model": "EconomicCalendar" + "model": "EconomicCalendar", + "openapi_extra": { + "model": "EconomicCalendar" + } }, "/economy/cpi": { "deprecated": { @@ -5352,65 +5424,11 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): fred, oecd.", "default": "united_states", "optional": true, - "choices": [ - "G20", - "G7", - "argentina", - "australia", - "austria", - "belgium", - "brazil", - "canada", - "chile", - "china", - "colombia", - "costa_rica", - "czech_republic", - "denmark", - "estonia", - "euro_area_20", - "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", - "russia", - "saudi_arabia", - "slovak_republic", - "slovenia", - "south_africa", - "spain", - "sweden", - "switzerland", - "turkey", - "united_kingdom", - "united_states", - "all" - ] + "choices": null }, { "name": "transform", @@ -5525,7 +5543,7 @@ "OBBject": [ { "name": "results", - "type": "List[ConsumerPriceIndex]", + "type": "list[ConsumerPriceIndex]", "description": "Serializable results." }, { @@ -5535,8 +5553,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -5545,7 +5563,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -5589,7 +5607,10 @@ } ] }, - "model": "ConsumerPriceIndex" + "model": "ConsumerPriceIndex", + "openapi_extra": { + "model": "ConsumerPriceIndex" + } }, "/economy/risk_premium": { "deprecated": { @@ -5606,7 +5627,7 @@ "OBBject": [ { "name": "results", - "type": "List[RiskPremium]", + "type": "list[RiskPremium]", "description": "Serializable results." }, { @@ -5616,8 +5637,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -5626,7 +5647,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -5668,7 +5689,10 @@ ], "fmp": [] }, - "model": "RiskPremium" + "model": "RiskPremium", + "openapi_extra": { + "model": "RiskPremium" + } }, "/economy/balance_of_payments": { "deprecated": { @@ -5759,7 +5783,7 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceOfPayments]", + "type": "list[BalanceOfPayments]", "description": "Serializable results." }, { @@ -5769,8 +5793,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -5779,7 +5803,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -5957,7 +5981,10 @@ ], "fred": [] }, - "model": "BalanceOfPayments" + "model": "BalanceOfPayments", + "openapi_extra": { + "model": "BalanceOfPayments" + } }, "/economy/fred_search": { "deprecated": { @@ -6062,7 +6089,7 @@ }, { "name": "tag_names", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -6070,7 +6097,7 @@ }, { "name": "exclude_tag_names", - "type": "Union[str, List[str]]", + "type": "Union[str, list[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. This parameter is ignored when search_type is 'release'. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -6090,7 +6117,7 @@ "OBBject": [ { "name": "results", - "type": "List[FredSearch]", + "type": "list[FredSearch]", "description": "Serializable results." }, { @@ -6100,8 +6127,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -6110,7 +6137,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -6296,7 +6323,10 @@ ], "fred": [] }, - "model": "FredSearch" + "model": "FredSearch", + "openapi_extra": { + "model": "FredSearch" + } }, "/economy/fred_series": { "deprecated": { @@ -6309,7 +6339,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "default": "", "optional": false, @@ -6425,7 +6455,7 @@ "OBBject": [ { "name": "results", - "type": "List[FredSeries]", + "type": "list[FredSeries]", "description": "Serializable results." }, { @@ -6435,8 +6465,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -6445,7 +6475,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -6473,7 +6503,10 @@ } ] }, - "model": "FredSeries" + "model": "FredSeries", + "openapi_extra": { + "model": "FredSeries" + } }, "/economy/fred_release_table": { "deprecated": { @@ -6502,7 +6535,7 @@ }, { "name": "date", - "type": "Union[Union[None, date, str], List[Union[None, date, str]]]", + "type": "Union[Union[None, date, str], list[Union[None, date, str]]]", "description": "A specific date to get data for. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -6515,7 +6548,7 @@ "OBBject": [ { "name": "results", - "type": "List[FredReleaseTable]", + "type": "list[FredReleaseTable]", "description": "Serializable results." }, { @@ -6525,8 +6558,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -6535,7 +6568,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -6625,7 +6658,10 @@ ], "fred": [] }, - "model": "FredReleaseTable" + "model": "FredReleaseTable", + "openapi_extra": { + "model": "FredReleaseTable" + } }, "/economy/money_measures": { "deprecated": { @@ -6667,7 +6703,7 @@ "OBBject": [ { "name": "results", - "type": "List[MoneyMeasures]", + "type": "list[MoneyMeasures]", "description": "Serializable results." }, { @@ -6677,8 +6713,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -6687,7 +6723,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -6761,7 +6797,10 @@ ], "federal_reserve": [] }, - "model": "MoneyMeasures" + "model": "MoneyMeasures", + "openapi_extra": { + "model": "MoneyMeasures" + } }, "/economy/unemployment": { "deprecated": { @@ -6774,57 +6813,11 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, - "choices": [ - "all", - "australia", - "austria", - "belgium", - "canada", - "chile", - "colombia", - "costa_rica", - "czech_republic", - "denmark", - "estonia", - "euro_area20", - "european_union27_2020", - "finland", - "france", - "g7", - "germany", - "greece", - "hungary", - "iceland", - "ireland", - "israel", - "italy", - "japan", - "korea", - "latvia", - "lithuania", - "luxembourg", - "mexico", - "netherlands", - "new_zealand", - "norway", - "oecd", - "poland", - "portugal", - "russia", - "slovakia", - "slovenia", - "south_africa", - "spain", - "sweden", - "switzerland", - "turkey", - "united_kingdom", - "united_states" - ] + "choices": null }, { "name": "frequency", @@ -6902,7 +6895,7 @@ "OBBject": [ { "name": "results", - "type": "List[Unemployment]", + "type": "list[Unemployment]", "description": "Serializable results." }, { @@ -6912,8 +6905,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -6922,7 +6915,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -6956,7 +6949,10 @@ ], "oecd": [] }, - "model": "Unemployment" + "model": "Unemployment", + "openapi_extra": { + "model": "Unemployment" + } }, "/economy/composite_leading_indicator": { "deprecated": { @@ -6987,7 +6983,7 @@ "oecd": [ { "name": "country", - "type": "Union[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str], List[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str]]]", + "type": "Union[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str], list[Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str]]]", "description": "Country to get the CLI for, default is G20. Multiple items allowed for provider(s): oecd.", "default": "g20", "optional": true, @@ -7039,7 +7035,7 @@ "OBBject": [ { "name": "results", - "type": "List[CompositeLeadingIndicator]", + "type": "list[CompositeLeadingIndicator]", "description": "Serializable results." }, { @@ -7049,8 +7045,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7059,7 +7055,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7093,7 +7089,10 @@ ], "oecd": [] }, - "model": "CompositeLeadingIndicator" + "model": "CompositeLeadingIndicator", + "openapi_extra": { + "model": "CompositeLeadingIndicator" + } }, "/economy/short_term_interest_rate": { "deprecated": { @@ -7144,7 +7143,7 @@ "OBBject": [ { "name": "results", - "type": "List[STIR]", + "type": "list[STIR]", "description": "Serializable results." }, { @@ -7154,8 +7153,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7164,7 +7163,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7198,7 +7197,10 @@ ], "oecd": [] }, - "model": "STIR" + "model": "STIR", + "openapi_extra": { + "model": "STIR" + } }, "/economy/long_term_interest_rate": { "deprecated": { @@ -7249,7 +7251,7 @@ "OBBject": [ { "name": "results", - "type": "List[LTIR]", + "type": "list[LTIR]", "description": "Serializable results." }, { @@ -7259,8 +7261,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7269,7 +7271,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7303,7 +7305,10 @@ ], "oecd": [] }, - "model": "LTIR" + "model": "LTIR", + "openapi_extra": { + "model": "LTIR" + } }, "/economy/fred_regional": { "deprecated": { @@ -7459,7 +7464,7 @@ "OBBject": [ { "name": "results", - "type": "List[FredRegional]", + "type": "list[FredRegional]", "description": "Serializable results." }, { @@ -7469,8 +7474,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7479,7 +7484,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7530,7 +7535,10 @@ } ] }, - "model": "FredRegional" + "model": "FredRegional", + "openapi_extra": { + "model": "FredRegional" + } }, "/economy/country_profile": { "deprecated": { @@ -7543,7 +7551,7 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false, @@ -7573,7 +7581,7 @@ "OBBject": [ { "name": "results", - "type": "List[CountryProfile]", + "type": "list[CountryProfile]", "description": "Serializable results." }, { @@ -7583,8 +7591,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7593,7 +7601,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7715,7 +7723,10 @@ ], "econdb": [] }, - "model": "CountryProfile" + "model": "CountryProfile", + "openapi_extra": { + "model": "CountryProfile" + } }, "/economy/available_indicators": { "deprecated": { @@ -7739,7 +7750,7 @@ "imf": [ { "name": "query", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The query string to search through the available indicators. Use semicolons to separate multiple terms. Multiple items allowed for provider(s): imf.", "default": null, "optional": true, @@ -7751,7 +7762,7 @@ "OBBject": [ { "name": "results", - "type": "List[AvailableIndicators]", + "type": "list[AvailableIndicators]", "description": "Serializable results." }, { @@ -7761,8 +7772,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -7771,7 +7782,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -7944,7 +7955,10 @@ } ] }, - "model": "AvailableIndicators" + "model": "AvailableIndicators", + "openapi_extra": { + "model": "AvailableIndicators" + } }, "/economy/indicators": { "deprecated": { @@ -7957,7 +7971,7 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "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, imf.", "default": null, "optional": true, @@ -8200,7 +8214,7 @@ "econdb": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Use `available_indicators()` to get a list of available symbols. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false, @@ -8234,7 +8248,7 @@ "imf": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Use `available_indicators()` to get the list of available symbols. Use 'IRFCL' to get all the data from International Reserves & Foreign Currency Liquidity indicators. Use 'core_fsi' to get the core Financial Soundness Indicators. Use 'core_fsi_underlying' to include underlying data for the core Financial Soundness Indicators. Complete tables are available only by single country, and are keyed as described below. The default is 'irfcl_top_lines'. Available presets not listed in `available_indicators()` are:\n\n 'IRFCL': All the data from the set of indicators. Not compatible with multiple countries.\n 'irfcl_top_lines': The default, top line items from the IRFCL data. Compatible with multiple countries.\n 'reserve_assets_and_other_fx_assets': Table I of the IRFCL data. Not compatible with multiple countries.\n 'predetermined_drains_on_fx_assets': Table II of the IRFCL data. Not compatible with multiple countries.\n 'contingent_drains_fx_assets': Table III of the IRFCL data. Not compatible with multiple countries.\n 'memorandum_items': The memorandum items table of the IRFCL data. Not compatible with multiple countries.\n 'gold_reserves': Gold reserves as value in USD and Fine Troy Ounces. Compatible with multiple countries.\n 'derivative_assets': Net derivative assets as value in USD. Compatible with multipile countries.\n 'fsi_core': The core Financial Soundness Indicators. Compatible with multiple countries.\n 'fsi_core_underlying': The core FSIs underlying series data. Not compatible with country='all'.\n 'fsi_encouraged_set': The encouraged set of Financial Soundness Indicators. Not compatible with country='all'.\n 'fsi_other': The other Financial Soundness Indicators. Not compatible with country='all'.\n 'fsi_balance_sheets': Data categorized as Balance Sheets and Income Statements. Not compatible with country='all'.\n 'fsi_all': All the Financial Soundness Indicators. Not compatible with multiple countries. Multiple items allowed for provider(s): imf.", "default": "irfcl_top_lines", "optional": true, @@ -8258,7 +8272,7 @@ "OBBject": [ { "name": "results", - "type": "List[EconomicIndicators]", + "type": "list[EconomicIndicators]", "description": "Serializable results." }, { @@ -8268,8 +8282,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -8278,7 +8292,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -8386,7 +8400,10 @@ } ] }, - "model": "EconomicIndicators" + "model": "EconomicIndicators", + "openapi_extra": { + "model": "EconomicIndicators" + } }, "/economy/central_bank_holdings": { "deprecated": { @@ -8435,7 +8452,7 @@ }, { "name": "cusip", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": " Multiple items allowed for provider(s): federal_reserve.", "default": null, "optional": true, @@ -8463,7 +8480,7 @@ "OBBject": [ { "name": "results", - "type": "List[CentralBankHoldings]", + "type": "list[CentralBankHoldings]", "description": "Serializable results." }, { @@ -8473,8 +8490,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -8483,7 +8500,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -8686,7 +8703,10 @@ } ] }, - "model": "CentralBankHoldings" + "model": "CentralBankHoldings", + "openapi_extra": { + "model": "CentralBankHoldings" + } }, "/economy/share_price_index": { "deprecated": { @@ -8699,69 +8719,11 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, - "choices": [ - "G20", - "G7", - "all", - "argentina", - "australia", - "austria", - "belgium", - "brazil", - "bulgaria", - "canada", - "chile", - "china", - "colombia", - "costa_rica", - "croatia", - "czech_republic", - "denmark", - "estonia", - "euro_area_19", - "euro_area_20", - "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" - ] + "choices": null }, { "name": "frequency", @@ -8807,7 +8769,7 @@ "OBBject": [ { "name": "results", - "type": "List[SharePriceIndex]", + "type": "list[SharePriceIndex]", "description": "Serializable results." }, { @@ -8817,8 +8779,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -8827,7 +8789,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -8861,7 +8823,10 @@ ], "oecd": [] }, - "model": "SharePriceIndex" + "model": "SharePriceIndex", + "openapi_extra": { + "model": "SharePriceIndex" + } }, "/economy/house_price_index": { "deprecated": { @@ -8874,69 +8839,11 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, - "choices": [ - "G20", - "G7", - "argentina", - "australia", - "austria", - "belgium", - "brazil", - "bulgaria", - "canada", - "chile", - "china", - "colombia", - "costa_rica", - "croatia", - "czech_republic", - "denmark", - "estonia", - "euro_area_20", - "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" - ] + "choices": null }, { "name": "frequency", @@ -8994,7 +8901,7 @@ "OBBject": [ { "name": "results", - "type": "List[HousePriceIndex]", + "type": "list[HousePriceIndex]", "description": "Serializable results." }, { @@ -9004,8 +8911,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9014,7 +8921,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9048,7 +8955,10 @@ ], "oecd": [] }, - "model": "HousePriceIndex" + "model": "HousePriceIndex", + "openapi_extra": { + "model": "HousePriceIndex" + } }, "/economy/immediate_interest_rate": { "deprecated": { @@ -9061,61 +8971,11 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, - "choices": [ - "belgium", - "bulgaria", - "brazil", - "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", - "romania", - "russia", - "euro_area19", - "colombia", - "italy", - "india", - "china", - "croatia", - "all" - ] + "choices": null }, { "name": "start_date", @@ -9157,7 +9017,7 @@ "OBBject": [ { "name": "results", - "type": "List[ImmediateInterestRate]", + "type": "list[ImmediateInterestRate]", "description": "Serializable results." }, { @@ -9167,8 +9027,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9177,7 +9037,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9211,7 +9071,10 @@ ], "oecd": [] }, - "model": "ImmediateInterestRate" + "model": "ImmediateInterestRate", + "openapi_extra": { + "model": "ImmediateInterestRate" + } }, "/economy/interest_rates": { "deprecated": { @@ -9224,7 +9087,7 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, @@ -9328,7 +9191,7 @@ "OBBject": [ { "name": "results", - "type": "List[CountryInterestRates]", + "type": "list[CountryInterestRates]", "description": "Serializable results." }, { @@ -9338,8 +9201,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9348,7 +9211,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9382,7 +9245,10 @@ ], "oecd": [] }, - "model": "CountryInterestRates" + "model": "CountryInterestRates", + "openapi_extra": { + "model": "CountryInterestRates" + } }, "/economy/retail_prices": { "deprecated": { @@ -9399,59 +9265,7 @@ "description": "The item or basket of items to query.", "default": null, "optional": true, - "choices": [ - "beverages", - "cereals", - "dairy", - "fuel", - "meats", - "produce", - "bacon", - "bananas", - "beans", - "beef", - "beer", - "bread", - "butter", - "cheese", - "chicken", - "chops", - "coffee", - "cookies", - "corn", - "diesel", - "eggs", - "electricity", - "flour", - "gas", - "gasoline", - "grapefruit", - "groud_beef", - "ham", - "ice_cream", - "lemons", - "lettuce", - "malt_beverages", - "milk", - "oil", - "orange_juice", - "oranges", - "potato_chips", - "potatoes", - "pork", - "rice", - "soft_drinks", - "spaghetti", - "steak", - "strawberries", - "sugar", - "tomatoes", - "unleaded", - "usda", - "vodka", - "wine", - "yogurt" - ] + "choices": null }, { "name": "country", @@ -9459,9 +9273,7 @@ "description": "The country to get data.", "default": "united_states", "optional": true, - "choices": [ - "united_states" - ] + "choices": null }, { "name": "start_date", @@ -9527,7 +9339,7 @@ "OBBject": [ { "name": "results", - "type": "List[RetailPrices]", + "type": "list[RetailPrices]", "description": "Serializable results." }, { @@ -9537,8 +9349,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9547,7 +9359,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9597,7 +9409,10 @@ ], "fred": [] }, - "model": "RetailPrices" + "model": "RetailPrices", + "openapi_extra": { + "model": "RetailPrices" + } }, "/economy/primary_dealer_positioning": { "deprecated": { @@ -9654,7 +9469,7 @@ "OBBject": [ { "name": "results", - "type": "List[PrimaryDealerPositioning]", + "type": "list[PrimaryDealerPositioning]", "description": "Serializable results." }, { @@ -9664,8 +9479,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9674,7 +9489,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9725,7 +9540,10 @@ } ] }, - "model": "PrimaryDealerPositioning" + "model": "PrimaryDealerPositioning", + "openapi_extra": { + "model": "PrimaryDealerPositioning" + } }, "/economy/pce": { "deprecated": { @@ -9738,7 +9556,7 @@ "standard": [ { "name": "date", - "type": "Union[Union[date, str], List[Union[date, str]]]", + "type": "Union[Union[date, str], list[Union[date, str]]]", "description": "A specific date to get data for. Default is the latest report. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -9769,7 +9587,7 @@ "OBBject": [ { "name": "results", - "type": "List[PersonalConsumptionExpenditures]", + "type": "list[PersonalConsumptionExpenditures]", "description": "Serializable results." }, { @@ -9779,8 +9597,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9789,7 +9607,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9872,7 +9690,10 @@ } ] }, - "model": "PersonalConsumptionExpenditures" + "model": "PersonalConsumptionExpenditures", + "openapi_extra": { + "model": "PersonalConsumptionExpenditures" + } }, "/economy/export_destinations": { "deprecated": { @@ -9885,7 +9706,7 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false, @@ -9898,7 +9719,7 @@ "OBBject": [ { "name": "results", - "type": "List[ExportDestinations]", + "type": "list[ExportDestinations]", "description": "Serializable results." }, { @@ -9908,8 +9729,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -9918,7 +9739,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -9977,7 +9798,10 @@ } ] }, - "model": "ExportDestinations" + "model": "ExportDestinations", + "openapi_extra": { + "model": "ExportDestinations" + } }, "/economy/primary_dealer_fails": { "deprecated": { @@ -10038,7 +9862,7 @@ "OBBject": [ { "name": "results", - "type": "List[PrimaryDealerFails]", + "type": "list[PrimaryDealerFails]", "description": "Serializable results." }, { @@ -10048,8 +9872,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -10058,7 +9882,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -10101,7 +9925,10 @@ } ] }, - "model": "PrimaryDealerFails" + "model": "PrimaryDealerFails", + "openapi_extra": { + "model": "PrimaryDealerFails" + } }, "/economy/port_volume": { "deprecated": { @@ -10135,7 +9962,7 @@ "OBBject": [ { "name": "results", - "type": "List[PortVolume]", + "type": "list[PortVolume]", "description": "Serializable results." }, { @@ -10145,8 +9972,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -10155,7 +9982,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -10230,7 +10057,10 @@ } ] }, - "model": "PortVolume" + "model": "PortVolume", + "openapi_extra": { + "model": "PortVolume" + } }, "/economy/direction_of_trade": { "deprecated": { @@ -10243,7 +10073,7 @@ "standard": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple items allowed for provider(s): imf.", "default": null, "optional": true, @@ -10499,7 +10329,7 @@ }, { "name": "counterpart", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple items allowed for provider(s): imf.", "default": null, "optional": true, @@ -10792,7 +10622,7 @@ "OBBject": [ { "name": "results", - "type": "List[DirectionOfTrade]", + "type": "list[DirectionOfTrade]", "description": "Serializable results." }, { @@ -10802,8 +10632,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -10812,7 +10642,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -10878,7 +10708,10 @@ ], "imf": [] }, - "model": "DirectionOfTrade" + "model": "DirectionOfTrade", + "openapi_extra": { + "model": "DirectionOfTrade" + } }, "/economy/fomc_documents": { "deprecated": { @@ -10936,7 +10769,7 @@ "OBBject": [ { "name": "results", - "type": "List[FomcDocuments]", + "type": "list[FomcDocuments]", "description": "Serializable results." }, { @@ -10946,8 +10779,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -10956,7 +10789,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -10974,7 +10807,20 @@ } ] }, - "model": "FomcDocuments" + "model": "FomcDocuments", + "openapi_extra": { + "widget_config": { + "type": "multi_file_viewer", + "name": "FOMC Document Viewer", + "description": "View FOMC materials.", + "gridData": { + "w": 30, + "h": 27 + }, + "refetchInterval": false + }, + "model": "FomcDocuments" + } }, "/equity/calendar/ipo": { "deprecated": { @@ -11049,7 +10895,7 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarIpo]", + "type": "list[CalendarIpo]", "description": "Serializable results." }, { @@ -11059,8 +10905,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11069,7 +10915,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11256,7 +11102,10 @@ } ] }, - "model": "CalendarIpo" + "model": "CalendarIpo", + "openapi_extra": { + "model": "CalendarIpo" + } }, "/equity/calendar/dividend": { "deprecated": { @@ -11290,7 +11139,7 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarDividend]", + "type": "list[CalendarDividend]", "description": "Serializable results." }, { @@ -11300,8 +11149,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11310,7 +11159,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11393,7 +11242,10 @@ } ] }, - "model": "CalendarDividend" + "model": "CalendarDividend", + "openapi_extra": { + "model": "CalendarDividend" + } }, "/equity/calendar/splits": { "deprecated": { @@ -11427,7 +11279,7 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarSplits]", + "type": "list[CalendarSplits]", "description": "Serializable results." }, { @@ -11437,8 +11289,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11447,7 +11299,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11497,7 +11349,10 @@ ], "fmp": [] }, - "model": "CalendarSplits" + "model": "CalendarSplits", + "openapi_extra": { + "model": "CalendarSplits" + } }, "/equity/calendar/events": { "deprecated": { @@ -11531,7 +11386,7 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarEvents]", + "type": "list[CalendarEvents]", "description": "Serializable results." }, { @@ -11541,8 +11396,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11551,7 +11406,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11626,7 +11481,10 @@ } ] }, - "model": "CalendarEvents" + "model": "CalendarEvents", + "openapi_extra": { + "model": "CalendarEvents" + } }, "/equity/calendar/earnings": { "deprecated": { @@ -11660,7 +11518,7 @@ "OBBject": [ { "name": "results", - "type": "List[CalendarEarnings]", + "type": "list[CalendarEarnings]", "description": "Serializable results." }, { @@ -11670,8 +11528,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11680,7 +11538,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11779,7 +11637,10 @@ } ] }, - "model": "CalendarEarnings" + "model": "CalendarEarnings", + "openapi_extra": { + "model": "CalendarEarnings" + } }, "/equity/compare/peers": { "deprecated": { @@ -11805,7 +11666,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityPeers]", + "type": "list[EquityPeers]", "description": "Serializable results." }, { @@ -11815,8 +11676,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -11825,7 +11686,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -11834,7 +11695,7 @@ "standard": [ { "name": "peers_list", - "type": "List[str]", + "type": "list[str]", "description": "A list of equity peers based on sector, exchange and market cap.", "default": "", "optional": true, @@ -11843,7 +11704,10 @@ ], "fmp": [] }, - "model": "EquityPeers" + "model": "EquityPeers", + "openapi_extra": { + "model": "EquityPeers" + } }, "/equity/compare/company_facts": { "deprecated": { @@ -11856,7 +11720,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): sec.", "default": null, "optional": true, @@ -11868,288 +11732,7 @@ "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.", "default": "", "optional": true, - "choices": [ - "AccountsPayableCurrent", - "AccountsReceivableNet", - "AccountsReceivableNetCurrent", - "AccrualForTaxesOtherThanIncomeTaxesCurrent", - "AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent", - "AccruedIncomeTaxesCurrent", - "AccruedIncomeTaxesNoncurrent", - "AccruedInsuranceCurrent", - "AccruedLiabilitiesCurrent", - "AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment", - "AccumulatedOtherComprehensiveIncomeLossNetOfTax", - "AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets", - "AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue", - "AdvertisingExpense", - "AllocatedShareBasedCompensationExpense", - "AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount", - "AssetImpairmentCharges", - "Assets", - "AssetsCurrent", - "AssetsNoncurrent", - "BuildingsAndImprovementsGross", - "CapitalLeaseObligationsCurrent", - "CapitalLeaseObligationsNoncurrent", - "Cash", - "CashAndCashEquivalentsAtCarryingValue", - "CashCashEquivalentsAndShortTermInvestments", - "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents", - "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations", - "CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect", - "CommercialPaper", - "CommitmentsAndContingencies", - "CommonStockDividendsPerShareCashPaid", - "CommonStockDividendsPerShareDeclared", - "CommonStocksIncludingAdditionalPaidInCapital", - "ComprehensiveIncomeNetOfTax", - "ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest", - "ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest", - "ConstructionInProgressGross", - "ContractWithCustomerAssetNet", - "ContractWithCustomerLiability", - "ContractWithCustomerLiabilityCurrent", - "ContractWithCustomerLiabilityNoncurrent", - "CostOfGoodsAndServicesSold", - "CostOfRevenue", - "CurrentFederalTaxExpenseBenefit", - "CurrentForeignTaxExpenseBenefit", - "CurrentIncomeTaxExpenseBenefit", - "CurrentStateAndLocalTaxExpenseBenefit", - "DebtInstrumentFaceAmount", - "DebtInstrumentFairValue", - "DebtLongtermAndShorttermCombinedAmount", - "DeferredFederalIncomeTaxExpenseBenefit", - "DeferredForeignIncomeTaxExpenseBenefit", - "DeferredIncomeTaxExpenseBenefit", - "DeferredIncomeTaxLiabilities", - "DeferredIncomeTaxLiabilitiesNet", - "DeferredIncomeTaxesAndTaxCredits", - "DeferredRevenue", - "DeferredTaxAssetsGross", - "DeferredTaxAssetsLiabilitiesNet", - "DeferredTaxAssetsNet", - "DeferredTaxLiabilities", - "DefinedContributionPlanCostRecognized", - "Depreciation", - "DepreciationAmortizationAndAccretionNet", - "DepreciationAmortizationAndOther", - "DepreciationAndAmortization", - "DepreciationDepletionAndAmortization", - "DerivativeCollateralObligationToReturnCash", - "DerivativeCollateralRightToReclaimCash", - "DerivativeFairValueOfDerivativeNet", - "DerivativeLiabilityCollateralRightToReclaimCashOffset", - "DerivativeNotionalAmount", - "DistributedEarnings", - "Dividends", - "DividendsCash", - "DividendsPayableAmountPerShare", - "DividendsPayableCurrent", - "EarningsPerShareBasic", - "EarningsPerShareDiluted", - "EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents", - "EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations", - "EmployeeRelatedLiabilitiesCurrent", - "EmployeeRelatedLiabilitiesCurrentAndNoncurrent", - "EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense", - "FinanceLeaseInterestExpense", - "FinanceLeaseInterestPaymentOnLiability", - "FinanceLeaseLiability", - "FinanceLeaseLiabilityCurrent", - "FinanceLeaseLiabilityNoncurrent", - "FinanceLeaseLiabilityPaymentsDue", - "FinanceLeaseLiabilityPaymentsDueAfterYearFive", - "FinanceLeaseLiabilityPaymentsDueNextTwelveMonths", - "FinanceLeaseLiabilityPaymentsDueYearFive", - "FinanceLeaseLiabilityPaymentsDueYearFour", - "FinanceLeaseLiabilityPaymentsDueYearThree", - "FinanceLeaseLiabilityPaymentsDueYearTwo", - "FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear", - "FinanceLeaseLiabilityUndiscountedExcessAmount", - "FinanceLeasePrincipalPayments", - "FinanceLeaseRightOfUseAsset", - "FinancingReceivableAllowanceForCreditLosses", - "FiniteLivedIntangibleAssetsNet", - "FixturesAndEquipmentGross", - "GainLossOnInvestments", - "GainLossOnInvestmentsAndDerivativeInstruments", - "GainLossOnSaleOfBusiness", - "GainsLossesOnExtinguishmentOfDebt", - "GeneralAndAdministrativeExpense", - "Goodwill", - "GrossProfit", - "ImpairmentOfIntangibleAssetsExcludingGoodwill", - "ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill", - "IncomeLossFromContinuingOperations", - "IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity", - "IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest", - "IncomeLossFromContinuingOperationsPerBasicShare", - "IncomeLossFromContinuingOperationsPerDilutedShare", - "IncomeTaxExpenseBenefit", - "IncomeTaxesPaid", - "IncomeTaxesPaidNet", - "IncreaseDecreaseInAccountsAndOtherReceivables", - "IncreaseDecreaseInAccountsPayable", - "IncreaseDecreaseInAccountsReceivable", - "IncreaseDecreaseInAccruedIncomeTaxesPayable", - "IncreaseDecreaseInAccruedLiabilities", - "IncreaseDecreaseInAccruedTaxesPayable", - "IncreaseDecreaseInContractWithCustomerLiability", - "IncreaseDecreaseInDeferredIncomeTaxes", - "IncreaseDecreaseInInventories", - "IncreaseDecreaseInOtherCurrentAssets", - "IncreaseDecreaseInOtherCurrentLiabilities", - "IncreaseDecreaseInOtherNoncurrentAssets", - "IncreaseDecreaseInOtherNoncurrentLiabilities", - "IncreaseDecreaseInPensionPlanObligations", - "IncrementalCommonSharesAttributableToShareBasedPaymentArrangements", - "InterestAndDebtExpense", - "InterestExpenseDebt", - "InterestIncomeExpenseNet", - "InterestPaid", - "InterestPaidNet", - "InventoryNet", - "InvestmentIncomeInterest", - "Land", - "LeaseAndRentalExpense", - "LesseeOperatingLeaseLiabilityPaymentsDue", - "LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive", - "LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths", - "LesseeOperatingLeaseLiabilityPaymentsDueYearFive", - "LesseeOperatingLeaseLiabilityPaymentsDueYearFour", - "LesseeOperatingLeaseLiabilityPaymentsDueYearThree", - "LesseeOperatingLeaseLiabilityPaymentsDueYearTwo", - "LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear", - "LettersOfCreditOutstandingAmount", - "Liabilities", - "LiabilitiesAndStockholdersEquity", - "LiabilitiesCurrent", - "LineOfCredit", - "LineOfCreditFacilityMaximumBorrowingCapacity", - "LongTermDebt", - "LongTermDebtCurrent", - "LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive", - "LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths", - "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive", - "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour", - "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree", - "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo", - "LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear", - "LongTermDebtNoncurrent", - "LongTermInvestments", - "LossContingencyEstimateOfPossibleLoss", - "MachineryAndEquipmentGross", - "MarketableSecuritiesCurrent", - "MarketableSecuritiesNoncurrent", - "MinorityInterest", - "NetCashProvidedByUsedInFinancingActivities", - "NetCashProvidedByUsedInInvestingActivities", - "NetCashProvidedByUsedInOperatingActivities", - "NetIncomeLoss", - "NetIncomeLossAttributableToNoncontrollingInterest", - "NetIncomeLossAttributableToNonredeemableNoncontrollingInterest", - "NetIncomeLossAttributableToRedeemableNoncontrollingInterest", - "NoncurrentAssets", - "NoncurrentAssets", - "NoninterestIncome", - "NonoperatingIncomeExpense", - "NotesReceivableNet", - "OperatingExpenses", - "OperatingIncomeLoss", - "OperatingLeaseCost", - "OperatingLeaseLiability", - "OperatingLeaseLiabilityCurrent", - "OperatingLeaseLiabilityNoncurrent", - "OperatingLeaseRightOfUseAsset", - "OtherAccruedLiabilitiesCurrent", - "OtherAssetsCurrent", - "OtherAssetsNoncurrent", - "OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax", - "OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax", - "OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax", - "OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax", - "OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax", - "OtherComprehensiveIncomeLossNetOfTax", - "OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent", - "OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax", - "OtherIncome", - "OtherLiabilitiesCurrent", - "OtherLiabilitiesNoncurrent", - "OtherLongTermDebt", - "OtherNoncashIncomeExpense", - "PaymentsForCapitalImprovements", - "PaymentsForProceedsFromBusinessesAndInterestInAffiliates", - "PaymentsForProceedsFromOtherInvestingActivities", - "PaymentsForRent", - "PaymentsForRepurchaseOfCommonStock", - "PaymentsOfDebtExtinguishmentCosts", - "PaymentsOfDividends", - "PaymentsOfDividendsMinorityInterest", - "PaymentsToAcquireInvestments", - "PaymentsToAcquirePropertyPlantAndEquipment", - "PreferredStockSharesOutstanding", - "PreferredStockValue", - "PrepaidExpenseAndOtherAssetsCurrent", - "PrepaidExpenseCurrent", - "ProceedsFromDebtMaturingInMoreThanThreeMonths", - "ProceedsFromDebtNetOfIssuanceCosts", - "ProceedsFromDivestitureOfBusinesses", - "ProceedsFromInvestments", - "ProceedsFromIssuanceOfCommonStock", - "ProceedsFromIssuanceOfDebt", - "ProceedsFromIssuanceOfLongTermDebt", - "ProceedsFromIssuanceOfUnsecuredDebt", - "ProceedsFromIssuanceOrSaleOfEquity", - "ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities", - "ProceedsFromPaymentsForOtherFinancingActivities", - "ProceedsFromPaymentsToMinorityShareholders", - "ProceedsFromRepaymentsOfShortTermDebt", - "ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess", - "ProceedsFromSaleOfPropertyPlantAndEquipment", - "ProceedsFromStockOptionsExercised", - "ProfitLoss", - "PropertyPlantAndEquipmentGross", - "PropertyPlantAndEquipmentNet", - "ReceivablesNetCurrent", - "RedeemableNoncontrollingInterestEquityCarryingAmount", - "RepaymentsOfDebtMaturingInMoreThanThreeMonths", - "RepaymentsOfLongTermDebt", - "ResearchAndDevelopmentExpense", - "RestrictedCash", - "RestrictedCashAndCashEquivalents", - "RestrictedStockExpense", - "RestructuringCharges", - "RetainedEarningsAccumulatedDeficit", - "RevenueFromContractWithCustomerExcludingAssessedTax", - "Revenues", - "SecuredLongTermDebt", - "SellingAndMarketingExpense", - "SellingGeneralAndAdministrativeExpense", - "ShareBasedCompensation", - "ShortTermBorrowings", - "ShortTermInvestments", - "StockIssuedDuringPeriodValueNewIssues", - "StockOptionPlanExpense", - "StockRedeemedOrCalledDuringPeriodValue", - "StockRepurchasedAndRetiredDuringPeriodValue", - "StockRepurchasedDuringPeriodValue", - "StockholdersEquity", - "StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest", - "StockholdersEquityOther", - "TaxesPayableCurrent", - "TradingSecuritiesDebt", - "TreasuryStockAcquiredAverageCostPerShare", - "TreasuryStockSharesAcquired", - "UnrealizedGainLossOnInvestments", - "UnrecognizedTaxBenefits", - "UnsecuredDebt", - "VariableLeaseCost", - "WeightedAverageNumberDilutedSharesOutstandingAdjustment", - "WeightedAverageNumberOfDilutedSharesOutstanding", - "WeightedAverageNumberOfSharesOutstandingBasic" - ] + "choices": null } ], "sec": [ @@ -12205,7 +11788,7 @@ "OBBject": [ { "name": "results", - "type": "List[CompareCompanyFacts]", + "type": "list[CompareCompanyFacts]", "description": "Serializable results." }, { @@ -12215,8 +11798,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -12225,7 +11808,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -12356,7 +11939,10 @@ } ] }, - "model": "CompareCompanyFacts" + "model": "CompareCompanyFacts", + "openapi_extra": { + "model": "CompareCompanyFacts" + } }, "/equity/estimates/price_target": { "deprecated": { @@ -12369,7 +11955,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", "default": null, "optional": true, @@ -12455,7 +12041,7 @@ }, { "name": "analyst_ids", - "type": "Union[Union[str, List[str]], List[Union[str, List[str]]]]", + "type": "Union[Union[str, list[str]], list[Union[str, list[str]]]]", "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, @@ -12463,7 +12049,7 @@ }, { "name": "firm_ids", - "type": "Union[Union[str, List[str]], List[Union[str, List[str]]]]", + "type": "Union[Union[str, list[str]], list[Union[str, list[str]]]]", "description": "Comma-separated list of firm IDs. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, @@ -12471,7 +12057,7 @@ }, { "name": "fields", - "type": "Union[Union[str, List[str]], List[Union[str, List[str]]]]", + "type": "Union[Union[str, list[str]], list[Union[str, list[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. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, @@ -12493,7 +12079,7 @@ "OBBject": [ { "name": "results", - "type": "List[PriceTarget]", + "type": "list[PriceTarget]", "description": "Serializable results." }, { @@ -12503,8 +12089,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -12513,7 +12099,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -12758,7 +12344,10 @@ } ] }, - "model": "PriceTarget" + "model": "PriceTarget", + "openapi_extra": { + "model": "PriceTarget" + } }, "/equity/estimates/historical": { "deprecated": { @@ -12771,7 +12360,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -12801,7 +12390,7 @@ "OBBject": [ { "name": "results", - "type": "List[AnalystEstimates]", + "type": "list[AnalystEstimates]", "description": "Serializable results." }, { @@ -12811,8 +12400,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -12821,7 +12410,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -13007,7 +12596,10 @@ ], "fmp": [] }, - "model": "AnalystEstimates" + "model": "AnalystEstimates", + "openapi_extra": { + "model": "AnalystEstimates" + } }, "/equity/estimates/consensus": { "deprecated": { @@ -13020,7 +12612,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": null, "optional": true, @@ -13044,7 +12636,7 @@ "OBBject": [ { "name": "results", - "type": "List[PriceTargetConsensus]", + "type": "list[PriceTargetConsensus]", "description": "Serializable results." }, { @@ -13054,8 +12646,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -13064,7 +12656,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -13214,7 +12806,10 @@ } ] }, - "model": "PriceTargetConsensus" + "model": "PriceTargetConsensus", + "openapi_extra": { + "model": "PriceTargetConsensus" + } }, "/equity/estimates/analyst_search": { "deprecated": { @@ -13227,7 +12822,7 @@ "standard": [ { "name": "analyst_name", - "type": "Union[str, List[str]]", + "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, @@ -13235,7 +12830,7 @@ }, { "name": "firm_name", - "type": "Union[str, List[str]]", + "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, @@ -13245,15 +12840,15 @@ "benzinga": [ { "name": "analyst_ids", - "type": "Union[str, List[str]]", - "description": "List of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", + "type": "Union[str, list[str]]", + "description": "list of analyst IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, "choices": null }, { "name": "firm_ids", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, @@ -13277,7 +12872,7 @@ }, { "name": "fields", - "type": "Union[str, List[str]]", + "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, @@ -13289,7 +12884,7 @@ "OBBject": [ { "name": "results", - "type": "List[AnalystSearch]", + "type": "list[AnalystSearch]", "description": "Serializable results." }, { @@ -13299,8 +12894,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -13309,7 +12904,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -13768,7 +13363,10 @@ } ] }, - "model": "AnalystSearch" + "model": "AnalystSearch", + "openapi_extra": { + "model": "AnalystSearch" + } }, "/equity/estimates/forward_sales": { "deprecated": { @@ -13781,7 +13379,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true, @@ -13827,7 +13425,7 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardSalesEstimates]", + "type": "list[ForwardSalesEstimates]", "description": "Serializable results." }, { @@ -13837,8 +13435,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -13847,7 +13445,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -14034,7 +13632,10 @@ } ] }, - "model": "ForwardSalesEstimates" + "model": "ForwardSalesEstimates", + "openapi_extra": { + "model": "ForwardSalesEstimates" + } }, "/equity/estimates/forward_ebitda": { "deprecated": { @@ -14047,7 +13648,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true, @@ -14103,7 +13704,7 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardEbitdaEstimates]", + "type": "list[ForwardEbitdaEstimates]", "description": "Serializable results." }, { @@ -14113,8 +13714,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -14123,7 +13724,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -14255,7 +13856,10 @@ } ] }, - "model": "ForwardEbitdaEstimates" + "model": "ForwardEbitdaEstimates", + "openapi_extra": { + "model": "ForwardEbitdaEstimates" + } }, "/equity/estimates/forward_eps": { "deprecated": { @@ -14268,7 +13872,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true, @@ -14340,7 +13944,7 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardEpsEstimates]", + "type": "list[ForwardEpsEstimates]", "description": "Serializable results." }, { @@ -14350,8 +13954,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -14360,7 +13964,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -14516,7 +14120,10 @@ } ] }, - "model": "ForwardEpsEstimates" + "model": "ForwardEpsEstimates", + "openapi_extra": { + "model": "ForwardEpsEstimates" + } }, "/equity/estimates/forward_pe": { "deprecated": { @@ -14529,7 +14136,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true, @@ -14542,7 +14149,7 @@ "OBBject": [ { "name": "results", - "type": "List[ForwardPeEstimates]", + "type": "list[ForwardPeEstimates]", "description": "Serializable results." }, { @@ -14552,8 +14159,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -14562,7 +14169,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -14653,7 +14260,10 @@ } ] }, - "model": "ForwardPeEstimates" + "model": "ForwardPeEstimates", + "openapi_extra": { + "model": "ForwardPeEstimates" + } }, "/equity/discovery/gainers": { "deprecated": { @@ -14688,7 +14298,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityGainers]", + "type": "list[EquityGainers]", "description": "Serializable results." }, { @@ -14698,8 +14308,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -14708,7 +14318,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -14927,7 +14537,10 @@ } ] }, - "model": "EquityGainers" + "model": "EquityGainers", + "openapi_extra": { + "model": "EquityGainers" + } }, "/equity/discovery/losers": { "deprecated": { @@ -14962,7 +14575,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityLosers]", + "type": "list[EquityLosers]", "description": "Serializable results." }, { @@ -14972,8 +14585,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -14982,7 +14595,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -15201,7 +14814,10 @@ } ] }, - "model": "EquityLosers" + "model": "EquityLosers", + "openapi_extra": { + "model": "EquityLosers" + } }, "/equity/discovery/active": { "deprecated": { @@ -15236,7 +14852,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityActive]", + "type": "list[EquityActive]", "description": "Serializable results." }, { @@ -15246,8 +14862,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -15256,7 +14872,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -15475,7 +15091,10 @@ } ] }, - "model": "EquityActive" + "model": "EquityActive", + "openapi_extra": { + "model": "EquityActive" + } }, "/equity/discovery/undervalued_large_caps": { "deprecated": { @@ -15510,7 +15129,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityUndervaluedLargeCaps]", + "type": "list[EquityUndervaluedLargeCaps]", "description": "Serializable results." }, { @@ -15520,8 +15139,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -15530,7 +15149,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -15749,7 +15368,10 @@ } ] }, - "model": "EquityUndervaluedLargeCaps" + "model": "EquityUndervaluedLargeCaps", + "openapi_extra": { + "model": "EquityUndervaluedLargeCaps" + } }, "/equity/discovery/undervalued_growth": { "deprecated": { @@ -15784,7 +15406,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityUndervaluedGrowth]", + "type": "list[EquityUndervaluedGrowth]", "description": "Serializable results." }, { @@ -15794,8 +15416,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -15804,7 +15426,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -16023,7 +15645,10 @@ } ] }, - "model": "EquityUndervaluedGrowth" + "model": "EquityUndervaluedGrowth", + "openapi_extra": { + "model": "EquityUndervaluedGrowth" + } }, "/equity/discovery/aggressive_small_caps": { "deprecated": { @@ -16058,7 +15683,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityAggressiveSmallCaps]", + "type": "list[EquityAggressiveSmallCaps]", "description": "Serializable results." }, { @@ -16068,8 +15693,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -16078,7 +15703,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -16297,7 +15922,10 @@ } ] }, - "model": "EquityAggressiveSmallCaps" + "model": "EquityAggressiveSmallCaps", + "openapi_extra": { + "model": "EquityAggressiveSmallCaps" + } }, "/equity/discovery/growth_tech": { "deprecated": { @@ -16332,7 +15960,7 @@ "OBBject": [ { "name": "results", - "type": "List[GrowthTechEquities]", + "type": "list[GrowthTechEquities]", "description": "Serializable results." }, { @@ -16342,8 +15970,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -16352,7 +15980,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -16571,7 +16199,10 @@ } ] }, - "model": "GrowthTechEquities" + "model": "GrowthTechEquities", + "openapi_extra": { + "model": "GrowthTechEquities" + } }, "/equity/discovery/filings": { "deprecated": { @@ -16630,7 +16261,7 @@ "OBBject": [ { "name": "results", - "type": "List[DiscoveryFilings]", + "type": "list[DiscoveryFilings]", "description": "Serializable results." }, { @@ -16640,8 +16271,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -16650,7 +16281,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -16708,7 +16339,10 @@ ], "fmp": [] }, - "model": "DiscoveryFilings" + "model": "DiscoveryFilings", + "openapi_extra": { + "model": "DiscoveryFilings" + } }, "/equity/discovery/latest_financial_reports": { "deprecated": { @@ -16730,7 +16364,7 @@ }, { "name": "report_type", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple items allowed for provider(s): sec.", "default": null, "optional": true, @@ -16755,7 +16389,7 @@ "OBBject": [ { "name": "results", - "type": "List[LatestFinancialReports]", + "type": "list[LatestFinancialReports]", "description": "Serializable results." }, { @@ -16765,8 +16399,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -16775,7 +16409,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -16898,7 +16532,10 @@ } ] }, - "model": "LatestFinancialReports" + "model": "LatestFinancialReports", + "openapi_extra": { + "model": "LatestFinancialReports" + } }, "/equity/fundamental/multiples": { "deprecated": { @@ -16911,7 +16548,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -16924,7 +16561,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityValuationMultiples]", + "type": "list[EquityValuationMultiples]", "description": "Serializable results." }, { @@ -16934,8 +16571,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -16944,7 +16581,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -17442,7 +17079,10 @@ ], "fmp": [] }, - "model": "EquityValuationMultiples" + "model": "EquityValuationMultiples", + "openapi_extra": { + "model": "EquityValuationMultiples" + } }, "/equity/fundamental/balance": { "deprecated": { @@ -17647,7 +17287,7 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceSheet]", + "type": "list[BalanceSheet]", "description": "Serializable results." }, { @@ -17657,8 +17297,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -17667,7 +17307,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -19059,7 +18699,10 @@ ], "yfinance": [] }, - "model": "BalanceSheet" + "model": "BalanceSheet", + "openapi_extra": { + "model": "BalanceSheet" + } }, "/equity/fundamental/balance_growth": { "deprecated": { @@ -19105,7 +18748,7 @@ "OBBject": [ { "name": "results", - "type": "List[BalanceSheetGrowth]", + "type": "list[BalanceSheetGrowth]", "description": "Serializable results." }, { @@ -19115,8 +18758,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -19125,7 +18768,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -19480,7 +19123,10 @@ } ] }, - "model": "BalanceSheetGrowth" + "model": "BalanceSheetGrowth", + "openapi_extra": { + "model": "BalanceSheetGrowth" + } }, "/equity/fundamental/cash": { "deprecated": { @@ -19688,7 +19334,7 @@ "OBBject": [ { "name": "results", - "type": "List[CashFlowStatement]", + "type": "list[CashFlowStatement]", "description": "Serializable results." }, { @@ -19698,8 +19344,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -19708,7 +19354,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -20500,7 +20146,10 @@ ], "yfinance": [] }, - "model": "CashFlowStatement" + "model": "CashFlowStatement", + "openapi_extra": { + "model": "CashFlowStatement" + } }, "/equity/fundamental/reported_financials": { "deprecated": { @@ -20575,7 +20224,7 @@ "OBBject": [ { "name": "results", - "type": "List[ReportedFinancials]", + "type": "list[ReportedFinancials]", "description": "Serializable results." }, { @@ -20585,8 +20234,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -20595,7 +20244,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -20629,7 +20278,10 @@ ], "intrinio": [] }, - "model": "ReportedFinancials" + "model": "ReportedFinancials", + "openapi_extra": { + "model": "ReportedFinancials" + } }, "/equity/fundamental/cash_growth": { "deprecated": { @@ -20675,7 +20327,7 @@ "OBBject": [ { "name": "results", - "type": "List[CashFlowStatementGrowth]", + "type": "list[CashFlowStatementGrowth]", "description": "Serializable results." }, { @@ -20685,8 +20337,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -20695,7 +20347,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -20978,7 +20630,10 @@ } ] }, - "model": "CashFlowStatementGrowth" + "model": "CashFlowStatementGrowth", + "openapi_extra": { + "model": "CashFlowStatementGrowth" + } }, "/equity/fundamental/dividends": { "deprecated": { @@ -21031,7 +20686,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalDividends]", + "type": "list[HistoricalDividends]", "description": "Serializable results." }, { @@ -21041,8 +20696,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21051,7 +20706,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21145,7 +20800,10 @@ ], "yfinance": [] }, - "model": "HistoricalDividends" + "model": "HistoricalDividends", + "openapi_extra": { + "model": "HistoricalDividends" + } }, "/equity/fundamental/historical_eps": { "deprecated": { @@ -21180,7 +20838,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalEps]", + "type": "list[HistoricalEps]", "description": "Serializable results." }, { @@ -21190,8 +20848,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21200,7 +20858,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21291,7 +20949,10 @@ } ] }, - "model": "HistoricalEps" + "model": "HistoricalEps", + "openapi_extra": { + "model": "HistoricalEps" + } }, "/equity/fundamental/employee_count": { "deprecated": { @@ -21317,7 +20978,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalEmployees]", + "type": "list[HistoricalEmployees]", "description": "Serializable results." }, { @@ -21327,8 +20988,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21337,7 +20998,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21419,7 +21080,10 @@ ], "fmp": [] }, - "model": "HistoricalEmployees" + "model": "HistoricalEmployees", + "openapi_extra": { + "model": "HistoricalEmployees" + } }, "/equity/fundamental/search_attributes": { "deprecated": { @@ -21453,7 +21117,7 @@ "OBBject": [ { "name": "results", - "type": "List[SearchAttributes]", + "type": "list[SearchAttributes]", "description": "Serializable results." }, { @@ -21463,8 +21127,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21473,7 +21137,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21571,7 +21235,10 @@ ], "intrinio": [] }, - "model": "SearchAttributes" + "model": "SearchAttributes", + "openapi_extra": { + "model": "SearchAttributes" + } }, "/equity/fundamental/latest_attributes": { "deprecated": { @@ -21584,7 +21251,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, @@ -21592,7 +21259,7 @@ }, { "name": "tag", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, @@ -21605,7 +21272,7 @@ "OBBject": [ { "name": "results", - "type": "List[LatestAttributes]", + "type": "list[LatestAttributes]", "description": "Serializable results." }, { @@ -21615,8 +21282,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21625,7 +21292,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21659,7 +21326,10 @@ ], "intrinio": [] }, - "model": "LatestAttributes" + "model": "LatestAttributes", + "openapi_extra": { + "model": "LatestAttributes" + } }, "/equity/fundamental/historical_attributes": { "deprecated": { @@ -21672,7 +21342,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, @@ -21680,7 +21350,7 @@ }, { "name": "tag", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, @@ -21741,7 +21411,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalAttributes]", + "type": "list[HistoricalAttributes]", "description": "Serializable results." }, { @@ -21751,8 +21421,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -21761,7 +21431,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -21803,7 +21473,10 @@ ], "intrinio": [] }, - "model": "HistoricalAttributes" + "model": "HistoricalAttributes", + "openapi_extra": { + "model": "HistoricalAttributes" + } }, "/equity/fundamental/income": { "deprecated": { @@ -22011,7 +21684,7 @@ "OBBject": [ { "name": "results", - "type": "List[IncomeStatement]", + "type": "list[IncomeStatement]", "description": "Serializable results." }, { @@ -22021,8 +21694,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -22031,7 +21704,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -23311,7 +22984,10 @@ ], "yfinance": [] }, - "model": "IncomeStatement" + "model": "IncomeStatement", + "openapi_extra": { + "model": "IncomeStatement" + } }, "/equity/fundamental/income_growth": { "deprecated": { @@ -23357,7 +23033,7 @@ "OBBject": [ { "name": "results", - "type": "List[IncomeStatementGrowth]", + "type": "list[IncomeStatementGrowth]", "description": "Serializable results." }, { @@ -23367,8 +23043,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -23377,7 +23053,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -23628,7 +23304,10 @@ } ] }, - "model": "IncomeStatementGrowth" + "model": "IncomeStatementGrowth", + "openapi_extra": { + "model": "IncomeStatementGrowth" + } }, "/equity/fundamental/metrics": { "deprecated": { @@ -23641,7 +23320,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, @@ -23684,7 +23363,7 @@ "OBBject": [ { "name": "results", - "type": "List[KeyMetrics]", + "type": "list[KeyMetrics]", "description": "Serializable results." }, { @@ -23694,8 +23373,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -23704,7 +23383,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -24783,7 +24462,10 @@ } ] }, - "model": "KeyMetrics" + "model": "KeyMetrics", + "openapi_extra": { + "model": "KeyMetrics" + } }, "/equity/fundamental/management": { "deprecated": { @@ -24810,7 +24492,7 @@ "OBBject": [ { "name": "results", - "type": "List[KeyExecutives]", + "type": "list[KeyExecutives]", "description": "Serializable results." }, { @@ -24820,8 +24502,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -24830,7 +24512,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -24922,7 +24604,10 @@ } ] }, - "model": "KeyExecutives" + "model": "KeyExecutives", + "openapi_extra": { + "model": "KeyExecutives" + } }, "/equity/fundamental/management_compensation": { "deprecated": { @@ -24935,7 +24620,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -24957,7 +24642,7 @@ "OBBject": [ { "name": "results", - "type": "List[ExecutiveCompensation]", + "type": "list[ExecutiveCompensation]", "description": "Serializable results." }, { @@ -24967,8 +24652,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -24977,7 +24662,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -25108,7 +24793,10 @@ } ] }, - "model": "ExecutiveCompensation" + "model": "ExecutiveCompensation", + "openapi_extra": { + "model": "ExecutiveCompensation" + } }, "/equity/fundamental/ratios": { "deprecated": { @@ -25178,7 +24866,7 @@ "OBBject": [ { "name": "results", - "type": "List[FinancialRatios]", + "type": "list[FinancialRatios]", "description": "Serializable results." }, { @@ -25188,8 +24876,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -25198,7 +24886,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -25682,7 +25370,10 @@ ], "intrinio": [] }, - "model": "FinancialRatios" + "model": "FinancialRatios", + "openapi_extra": { + "model": "FinancialRatios" + } }, "/equity/fundamental/revenue_per_geography": { "deprecated": { @@ -25720,7 +25411,7 @@ "OBBject": [ { "name": "results", - "type": "List[RevenueGeographic]", + "type": "list[RevenueGeographic]", "description": "Serializable results." }, { @@ -25730,8 +25421,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -25740,7 +25431,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -25798,7 +25489,10 @@ ], "fmp": [] }, - "model": "RevenueGeographic" + "model": "RevenueGeographic", + "openapi_extra": { + "model": "RevenueGeographic" + } }, "/equity/fundamental/revenue_per_segment": { "deprecated": { @@ -25836,7 +25530,7 @@ "OBBject": [ { "name": "results", - "type": "List[RevenueBusinessLine]", + "type": "list[RevenueBusinessLine]", "description": "Serializable results." }, { @@ -25846,8 +25540,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -25856,7 +25550,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -25914,14 +25608,17 @@ ], "fmp": [] }, - "model": "RevenueBusinessLine" + "model": "RevenueBusinessLine", + "openapi_extra": { + "model": "RevenueBusinessLine" + } }, "/equity/fundamental/filings": { "deprecated": { "flag": null, "message": null }, - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "description": "Get public company filings.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.filings(provider='fmp')\nobb.equity.fundamental.filings(limit=100, provider='fmp')\n```\n\n", "parameters": { "standard": [ @@ -25932,11 +25629,97 @@ "default": null, "optional": true, "choices": null + } + ], + "fmp": [ + { + "name": "form_type", + "type": "str", + "description": "SEC form type to filter by.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "limit", + "type": "int", + "description": "Number of results to return.", + "default": 1000, + "optional": true, + "choices": null + } + ], + "intrinio": [ + { + "name": "form_type", + "type": "str", + "description": "SEC form type to filter by.", + "default": null, + "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, + "choices": null + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "limit", + "type": "int", + "description": "The number of data entries to return.", + "default": null, + "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, + "choices": null + } + ], + "sec": [ + { + "name": "cik", + "type": "Union[int, str]", + "description": "Lookup filings by Central Index Key (CIK) instead of by symbol.", + "default": null, + "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, + "choices": null + }, + { + "name": "end_date", + "type": "Union[date, str]", + "description": "End date of the data, in YYYY-MM-DD format.", + "default": null, + "optional": true, + "choices": null }, { "name": "form_type", - "type": "Union[str, List[str]]", - "description": "Filter by form type. Check the data provider for available types. Multiple items allowed for provider(s): sec.", + "type": "Union[str, list[str]]", + "description": "SEC form type to filter by. Multiple items allowed for provider(s): sec.", "default": null, "optional": true, "choices": [ @@ -26308,75 +26091,6 @@ "name": "limit", "type": "int", "description": "The number of data entries to return.", - "default": 100, - "optional": true, - "choices": null - } - ], - "fmp": [], - "intrinio": [ - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "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, - "choices": null - }, - { - "name": "thea_enabled", - "type": "bool", - "description": "Return filings that have been read by Intrinio's Thea NLP.", - "default": null, - "optional": true, - "choices": null - } - ], - "sec": [ - { - "name": "symbol", - "type": "str", - "description": "Symbol to get data for.", - "default": null, - "optional": true, - "choices": null - }, - { - "name": "form_type", - "type": "Union[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'], str]", - "description": "Type of the SEC filing form.", - "default": null, - "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, - "choices": null - }, - { - "name": "start_date", - "type": "Union[date, str]", - "description": "Start date of the data, in YYYY-MM-DD format.", - "default": null, - "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, "choices": null @@ -26395,7 +26109,7 @@ "OBBject": [ { "name": "results", - "type": "List[CompanyFilings]", + "type": "list[CompanyFilings]", "description": "Serializable results." }, { @@ -26405,8 +26119,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -26415,7 +26129,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -26431,9 +26145,27 @@ "choices": null }, { - "name": "accepted_date", - "type": "datetime", - "description": "Accepted date of the filing.", + "name": "report_type", + "type": "str", + "description": "Type of filing.", + "default": null, + "optional": true, + "choices": null + }, + { + "name": "report_url", + "type": "str", + "description": "URL to the actual report.", + "default": "", + "optional": false, + "choices": null + } + ], + "fmp": [ + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", "default": null, "optional": true, "choices": null @@ -26455,31 +26187,14 @@ "choices": null }, { - "name": "report_type", - "type": "str", - "description": "Type of filing.", + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", "default": null, "optional": true, "choices": null - }, - { - "name": "filing_url", - "type": "str", - "description": "URL to the filing page.", - "default": null, - "optional": true, - "choices": null - }, - { - "name": "report_url", - "type": "str", - "description": "URL to the actual report.", - "default": "", - "optional": false, - "choices": null } ], - "fmp": [], "intrinio": [ { "name": "id", @@ -26497,6 +26212,14 @@ "optional": true, "choices": null }, + { + "name": "accepted_date", + "type": "datetime", + "description": "Accepted date of the filing.", + "default": null, + "optional": true, + "choices": null + }, { "name": "sec_unique_id", "type": "str", @@ -26505,6 +26228,14 @@ "optional": false, "choices": null }, + { + "name": "filing_url", + "type": "str", + "description": "URL to the filing page.", + "default": null, + "optional": true, + "choices": null + }, { "name": "instance_url", "type": "str", @@ -26528,6 +26259,14 @@ "default": "", "optional": false, "choices": null + }, + { + "name": "word_count", + "type": "int", + "description": "Number of words in the filing, if available.", + "default": null, + "optional": true, + "choices": null } ], "sec": [ @@ -26637,7 +26376,10 @@ } ] }, - "model": "CompanyFilings" + "model": "CompanyFilings", + "openapi_extra": { + "model": "CompanyFilings" + } }, "/equity/fundamental/historical_splits": { "deprecated": { @@ -26663,7 +26405,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalSplits]", + "type": "list[HistoricalSplits]", "description": "Serializable results." }, { @@ -26673,8 +26415,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -26683,7 +26425,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -26725,7 +26467,10 @@ ], "fmp": [] }, - "model": "HistoricalSplits" + "model": "HistoricalSplits", + "openapi_extra": { + "model": "HistoricalSplits" + } }, "/equity/fundamental/transcript": { "deprecated": { @@ -26738,7 +26483,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -26746,7 +26491,7 @@ }, { "name": "year", - "type": "Union[Union[int, str], List[Union[int, str]]]", + "type": "Union[Union[int, str], list[Union[int, str]]]", "description": "Year of the earnings call transcript. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -26759,7 +26504,7 @@ "OBBject": [ { "name": "results", - "type": "List[EarningsCallTranscript]", + "type": "list[EarningsCallTranscript]", "description": "Serializable results." }, { @@ -26769,8 +26514,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -26779,7 +26524,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -26829,7 +26574,10 @@ ], "fmp": [] }, - "model": "EarningsCallTranscript" + "model": "EarningsCallTranscript", + "openapi_extra": { + "model": "EarningsCallTranscript" + } }, "/equity/fundamental/trailing_dividend_yield": { "deprecated": { @@ -26863,7 +26611,7 @@ "OBBject": [ { "name": "results", - "type": "List[TrailingDividendYield]", + "type": "list[TrailingDividendYield]", "description": "Serializable results." }, { @@ -26873,8 +26621,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -26883,7 +26631,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -26909,7 +26657,10 @@ ], "tiingo": [] }, - "model": "TrailingDividendYield" + "model": "TrailingDividendYield", + "openapi_extra": { + "model": "TrailingDividendYield" + } }, "/equity/fundamental/management_discussion_analysis": { "deprecated": { @@ -26992,7 +26743,7 @@ "OBBject": [ { "name": "results", - "type": "List[ManagementDiscussionAnalysis]", + "type": "list[ManagementDiscussionAnalysis]", "description": "Serializable results." }, { @@ -27002,8 +26753,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -27012,7 +26763,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -27071,7 +26822,20 @@ } ] }, - "model": "ManagementDiscussionAnalysis" + "model": "ManagementDiscussionAnalysis", + "openapi_extra": { + "widget_config": { + "type": "markdown", + "data": { + "dataKey": "results.content", + "columnsDefs": [] + }, + "staleTime": 86400000, + "refetchInterval": 86400000, + "source": "SEC" + }, + "model": "ManagementDiscussionAnalysis" + } }, "/equity/ownership/major_holders": { "deprecated": { @@ -27113,7 +26877,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityOwnership]", + "type": "list[EquityOwnership]", "description": "Serializable results." }, { @@ -27123,8 +26887,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -27133,7 +26897,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -27455,7 +27219,10 @@ ], "fmp": [] }, - "model": "EquityOwnership" + "model": "EquityOwnership", + "openapi_extra": { + "model": "EquityOwnership" + } }, "/equity/ownership/institutional": { "deprecated": { @@ -27498,7 +27265,7 @@ "OBBject": [ { "name": "results", - "type": "List[InstitutionalOwnership]", + "type": "list[InstitutionalOwnership]", "description": "Serializable results." }, { @@ -27508,8 +27275,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -27518,7 +27285,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -27817,7 +27584,10 @@ } ] }, - "model": "InstitutionalOwnership" + "model": "InstitutionalOwnership", + "openapi_extra": { + "model": "InstitutionalOwnership" + } }, "/equity/ownership/insider_trading": { "deprecated": { @@ -27939,7 +27709,7 @@ "OBBject": [ { "name": "results", - "type": "List[InsiderTrading]", + "type": "list[InsiderTrading]", "description": "Serializable results." }, { @@ -27949,8 +27719,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -27959,7 +27729,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -28374,7 +28144,10 @@ } ] }, - "model": "InsiderTrading" + "model": "InsiderTrading", + "openapi_extra": { + "model": "InsiderTrading" + } }, "/equity/ownership/share_statistics": { "deprecated": { @@ -28387,7 +28160,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false, @@ -28402,7 +28175,7 @@ "OBBject": [ { "name": "results", - "type": "List[ShareStatistics]", + "type": "list[ShareStatistics]", "description": "Serializable results." }, { @@ -28412,8 +28185,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -28422,7 +28195,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -28580,7 +28353,10 @@ } ] }, - "model": "ShareStatistics" + "model": "ShareStatistics", + "openapi_extra": { + "model": "ShareStatistics" + } }, "/equity/ownership/form_13f": { "deprecated": { @@ -28622,7 +28398,7 @@ "OBBject": [ { "name": "results", - "type": "List[Form13FHR]", + "type": "list[Form13FHR]", "description": "Serializable results." }, { @@ -28632,8 +28408,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -28642,7 +28418,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -28757,7 +28533,10 @@ } ] }, - "model": "Form13FHR" + "model": "Form13FHR", + "openapi_extra": { + "model": "Form13FHR" + } }, "/equity/ownership/government_trades": { "deprecated": { @@ -28770,7 +28549,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": null, "optional": true, @@ -28799,7 +28578,7 @@ "OBBject": [ { "name": "results", - "type": "List[GovernmentTrades]", + "type": "list[GovernmentTrades]", "description": "Serializable results." }, { @@ -28809,8 +28588,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -28819,7 +28598,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -28926,7 +28705,10 @@ } ] }, - "model": "GovernmentTrades" + "model": "GovernmentTrades", + "openapi_extra": { + "model": "GovernmentTrades" + } }, "/equity/price/quote": { "deprecated": { @@ -28939,7 +28721,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, @@ -28971,7 +28753,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityQuote]", + "type": "list[EquityQuote]", "description": "Serializable results." }, { @@ -28981,8 +28763,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -28991,7 +28773,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -29080,7 +28862,7 @@ }, { "name": "quote_conditions", - "type": "Union[str, int, List[str], List[int]]", + "type": "Union[str, int, list[str], list[int]]", "description": "Conditions or condition codes applicable to the quote.", "default": null, "optional": true, @@ -29088,7 +28870,7 @@ }, { "name": "quote_indicators", - "type": "Union[str, int, List[str], List[int]]", + "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, @@ -29096,7 +28878,7 @@ }, { "name": "sales_conditions", - "type": "Union[str, int, List[str], List[int]]", + "type": "Union[str, int, list[str], list[int]]", "description": "Conditions or condition codes applicable to the sale.", "default": null, "optional": true, @@ -29406,7 +29188,10 @@ } ] }, - "model": "EquityQuote" + "model": "EquityQuote", + "openapi_extra": { + "model": "EquityQuote" + } }, "/equity/price/nbbo": { "deprecated": { @@ -29481,7 +29266,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityNBBO]", + "type": "list[EquityNBBO]", "description": "Serializable results." }, { @@ -29491,8 +29276,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -29501,7 +29286,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -29568,7 +29353,7 @@ }, { "name": "conditions", - "type": "Union[str, List[int], List[str]]", + "type": "Union[str, list[int], list[str]]", "description": "A list of condition codes.", "default": null, "optional": true, @@ -29576,7 +29361,7 @@ }, { "name": "indicators", - "type": "List[int]", + "type": "list[int]", "description": "A list of indicator codes.", "default": null, "optional": true, @@ -29616,7 +29401,10 @@ } ] }, - "model": "EquityNBBO" + "model": "EquityNBBO", + "openapi_extra": { + "model": "EquityNBBO" + } }, "/equity/price/historical": { "deprecated": { @@ -29629,7 +29417,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false, @@ -29851,7 +29639,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityHistorical]", + "type": "list[EquityHistorical]", "description": "Serializable results." }, { @@ -29861,8 +29649,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -29871,7 +29659,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -30186,7 +29974,10 @@ } ] }, - "model": "EquityHistorical" + "model": "EquityHistorical", + "openapi_extra": { + "model": "EquityHistorical" + } }, "/equity/price/performance": { "deprecated": { @@ -30199,7 +29990,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -30212,7 +30003,7 @@ "OBBject": [ { "name": "results", - "type": "List[PricePerformance]", + "type": "list[PricePerformance]", "description": "Serializable results." }, { @@ -30222,8 +30013,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -30232,7 +30023,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -30387,7 +30178,10 @@ } ] }, - "model": "PricePerformance" + "model": "PricePerformance", + "openapi_extra": { + "model": "PricePerformance" + } }, "/equity/shorts/fails_to_deliver": { "deprecated": { @@ -30438,7 +30232,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityFTD]", + "type": "list[EquityFTD]", "description": "Serializable results." }, { @@ -30448,8 +30242,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -30458,7 +30252,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -30516,7 +30310,10 @@ ], "sec": [] }, - "model": "EquityFTD" + "model": "EquityFTD", + "openapi_extra": { + "model": "EquityFTD" + } }, "/equity/search": { "deprecated": { @@ -30585,7 +30382,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquitySearch]", + "type": "list[EquitySearch]", "description": "Serializable results." }, { @@ -30595,8 +30392,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -30605,7 +30402,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -30666,7 +30463,10 @@ } ] }, - "model": "EquitySearch" + "model": "EquitySearch", + "openapi_extra": { + "model": "EquitySearch" + } }, "/equity/screener": { "deprecated": { @@ -31290,7 +31090,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityScreener]", + "type": "list[EquityScreener]", "description": "Serializable results." }, { @@ -31300,8 +31100,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -31310,7 +31110,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -31595,7 +31395,10 @@ } ] }, - "model": "EquityScreener" + "model": "EquityScreener", + "openapi_extra": { + "model": "EquityScreener" + } }, "/equity/profile": { "deprecated": { @@ -31608,7 +31411,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, @@ -31623,7 +31426,7 @@ "OBBject": [ { "name": "results", - "type": "List[EquityInfo]", + "type": "list[EquityInfo]", "description": "Serializable results." }, { @@ -31633,8 +31436,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -31643,7 +31446,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -32162,7 +31965,10 @@ } ] }, - "model": "EquityInfo" + "model": "EquityInfo", + "openapi_extra": { + "model": "EquityInfo" + } }, "/equity/market_snapshots": { "deprecated": { @@ -32256,7 +32062,7 @@ "OBBject": [ { "name": "results", - "type": "List[MarketSnapshots]", + "type": "list[MarketSnapshots]", "description": "Serializable results." }, { @@ -32266,8 +32072,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -32276,7 +32082,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -32667,7 +32473,7 @@ }, { "name": "last_trade_conditions", - "type": "List[int]", + "type": "list[int]", "description": "The last trade condition codes.", "default": null, "optional": true, @@ -32691,7 +32497,10 @@ } ] }, - "model": "MarketSnapshots" + "model": "MarketSnapshots", + "openapi_extra": { + "model": "MarketSnapshots" + } }, "/equity/historical_market_cap": { "deprecated": { @@ -32704,7 +32513,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false, @@ -32749,7 +32558,7 @@ "OBBject": [ { "name": "results", - "type": "List[HistoricalMarketCap]", + "type": "list[HistoricalMarketCap]", "description": "Serializable results." }, { @@ -32759,8 +32568,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -32769,7 +32578,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -32804,7 +32613,10 @@ "fmp": [], "intrinio": [] }, - "model": "HistoricalMarketCap" + "model": "HistoricalMarketCap", + "openapi_extra": { + "model": "HistoricalMarketCap" + } }, "/etf/search": { "deprecated": { @@ -32864,7 +32676,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfSearch]", + "type": "list[EtfSearch]", "description": "Serializable results." }, { @@ -32874,8 +32686,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -32884,7 +32696,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -33034,7 +32846,7 @@ { "name": "sedol", "type": "str", - "description": "The Stock Exchange Daily Official List.", + "description": "The Stock Exchange Daily Official list.", "default": null, "optional": true, "choices": null @@ -33049,7 +32861,10 @@ } ] }, - "model": "EtfSearch" + "model": "EtfSearch", + "openapi_extra": { + "model": "EtfSearch" + } }, "/etf/historical": { "deprecated": { @@ -33062,7 +32877,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false, @@ -33284,7 +33099,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHistorical]", + "type": "list[EtfHistorical]", "description": "Serializable results." }, { @@ -33294,8 +33109,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -33304,7 +33119,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -33619,7 +33434,10 @@ } ] }, - "model": "EtfHistorical" + "model": "EtfHistorical", + "openapi_extra": { + "model": "EtfHistorical" + } }, "/etf/info": { "deprecated": { @@ -33632,7 +33450,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, @@ -33647,7 +33465,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfInfo]", + "type": "list[EtfInfo]", "description": "Serializable results." }, { @@ -33657,8 +33475,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -33667,7 +33485,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -33873,7 +33691,7 @@ { "name": "sedol", "type": "str", - "description": "Stock Exchange Daily Official List (SEDOL).", + "description": "Stock Exchange Daily Official list (SEDOL).", "default": null, "optional": true, "choices": null @@ -34681,7 +34499,7 @@ { "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.", + "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, "choices": null @@ -34970,7 +34788,10 @@ } ] }, - "model": "EtfInfo" + "model": "EtfInfo", + "openapi_extra": { + "model": "EtfInfo" + } }, "/etf/sectors": { "deprecated": { @@ -34996,7 +34817,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfSectors]", + "type": "list[EtfSectors]", "description": "Serializable results." }, { @@ -35006,8 +34827,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -35016,7 +34837,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -35042,7 +34863,10 @@ ], "fmp": [] }, - "model": "EtfSectors" + "model": "EtfSectors", + "openapi_extra": { + "model": "EtfSectors" + } }, "/etf/countries": { "deprecated": { @@ -35055,7 +34879,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -35068,7 +34892,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfCountries]", + "type": "list[EtfCountries]", "description": "Serializable results." }, { @@ -35078,8 +34902,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -35088,7 +34912,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -35106,7 +34930,10 @@ ], "fmp": [] }, - "model": "EtfCountries" + "model": "EtfCountries", + "openapi_extra": { + "model": "EtfCountries" + } }, "/etf/price_performance": { "deprecated": { @@ -35119,7 +34946,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false, @@ -35150,7 +34977,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfPricePerformance]", + "type": "list[EtfPricePerformance]", "description": "Serializable results." }, { @@ -35160,8 +34987,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -35170,7 +34997,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -35447,7 +35274,10 @@ } ] }, - "model": "EtfPricePerformance" + "model": "EtfPricePerformance", + "openapi_extra": { + "model": "EtfPricePerformance" + } }, "/etf/holdings": { "deprecated": { @@ -35518,7 +35348,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldings]", + "type": "list[EtfHoldings]", "description": "Serializable results." }, { @@ -35528,8 +35358,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -35538,7 +35368,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -35768,7 +35598,7 @@ { "name": "sedol", "type": "str", - "description": "The Stock Exchange Daily Official List.", + "description": "The Stock Exchange Daily Official list.", "default": null, "optional": true, "choices": null @@ -36465,7 +36295,10 @@ } ] }, - "model": "EtfHoldings" + "model": "EtfHoldings", + "openapi_extra": { + "model": "EtfHoldings" + } }, "/etf/holdings_date": { "deprecated": { @@ -36500,7 +36333,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfHoldingsDate]", + "type": "list[EtfHoldingsDate]", "description": "Serializable results." }, { @@ -36510,8 +36343,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -36520,7 +36353,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -36538,7 +36371,10 @@ ], "fmp": [] }, - "model": "EtfHoldingsDate" + "model": "EtfHoldingsDate", + "openapi_extra": { + "model": "EtfHoldingsDate" + } }, "/etf/equity_exposure": { "deprecated": { @@ -36551,7 +36387,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, @@ -36564,7 +36400,7 @@ "OBBject": [ { "name": "results", - "type": "List[EtfEquityExposure]", + "type": "list[EtfEquityExposure]", "description": "Serializable results." }, { @@ -36574,8 +36410,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -36584,7 +36420,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -36634,7 +36470,10 @@ ], "fmp": [] }, - "model": "EtfEquityExposure" + "model": "EtfEquityExposure", + "openapi_extra": { + "model": "EtfEquityExposure" + } }, "/fixedincome/rate/ameribor": { "deprecated": { @@ -36665,7 +36504,7 @@ "fred": [ { "name": "maturity", - "type": "Union[Union[Literal['all', 'overnight', 'average_30d', 'average_90d', 'term_30d', 'term_90d'], str], List[Union[Literal['all', 'overnight', 'average_30d', 'average_90d', 'term_30d', 'term_90d'], str]]]", + "type": "Union[Union[Literal['all', 'overnight', 'average_30d', 'average_90d', 'term_30d', 'term_90d'], str], list[Union[Literal['all', 'overnight', 'average_30d', 'average_90d', 'term_30d', 'term_90d'], str]]]", "description": "Period of AMERIBOR rate. Multiple items allowed for provider(s): fred.", "default": "all", "optional": true, @@ -36735,7 +36574,7 @@ "OBBject": [ { "name": "results", - "type": "List[Ameribor]", + "type": "list[Ameribor]", "description": "Serializable results." }, { @@ -36745,8 +36584,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -36755,7 +36594,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -36805,7 +36644,10 @@ ], "fred": [] }, - "model": "Ameribor" + "model": "Ameribor", + "openapi_extra": { + "model": "Ameribor" + } }, "/fixedincome/rate/sonia": { "deprecated": { @@ -36848,7 +36690,7 @@ "OBBject": [ { "name": "results", - "type": "List[SONIA]", + "type": "list[SONIA]", "description": "Serializable results." }, { @@ -36858,8 +36700,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -36868,7 +36710,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -36894,7 +36736,10 @@ ], "fred": [] }, - "model": "SONIA" + "model": "SONIA", + "openapi_extra": { + "model": "SONIA" + } }, "/fixedincome/rate/sofr": { "deprecated": { @@ -36981,7 +36826,7 @@ "OBBject": [ { "name": "results", - "type": "List[SOFR]", + "type": "list[SOFR]", "description": "Serializable results." }, { @@ -36991,8 +36836,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37001,7 +36846,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37101,7 +36946,10 @@ } ] }, - "model": "SOFR" + "model": "SOFR", + "openapi_extra": { + "model": "SOFR" + } }, "/fixedincome/rate/iorb": { "deprecated": { @@ -37135,7 +36983,7 @@ "OBBject": [ { "name": "results", - "type": "List[IORB]", + "type": "list[IORB]", "description": "Serializable results." }, { @@ -37145,8 +36993,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37155,7 +37003,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37181,7 +37029,10 @@ ], "fred": [] }, - "model": "IORB" + "model": "IORB", + "openapi_extra": { + "model": "IORB" + } }, "/fixedincome/rate/effr": { "deprecated": { @@ -37276,7 +37127,7 @@ "OBBject": [ { "name": "results", - "type": "List[FederalFundsRate]", + "type": "list[FederalFundsRate]", "description": "Serializable results." }, { @@ -37286,8 +37137,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37296,7 +37147,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37412,7 +37263,10 @@ ], "fred": [] }, - "model": "FederalFundsRate" + "model": "FederalFundsRate", + "openapi_extra": { + "model": "FederalFundsRate" + } }, "/fixedincome/rate/effr_forecast": { "deprecated": { @@ -37438,7 +37292,7 @@ "OBBject": [ { "name": "results", - "type": "List[PROJECTIONS]", + "type": "list[PROJECTIONS]", "description": "Serializable results." }, { @@ -37448,8 +37302,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37458,7 +37312,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37532,7 +37386,10 @@ ], "fred": [] }, - "model": "PROJECTIONS" + "model": "PROJECTIONS", + "openapi_extra": { + "model": "PROJECTIONS" + } }, "/fixedincome/rate/estr": { "deprecated": { @@ -37618,7 +37475,7 @@ "OBBject": [ { "name": "results", - "type": "List[EuroShortTermRate]", + "type": "list[EuroShortTermRate]", "description": "Serializable results." }, { @@ -37628,8 +37485,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37638,7 +37495,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37712,7 +37569,10 @@ ], "fred": [] }, - "model": "EuroShortTermRate" + "model": "EuroShortTermRate", + "openapi_extra": { + "model": "EuroShortTermRate" + } }, "/fixedincome/rate/ecb": { "deprecated": { @@ -37754,7 +37614,7 @@ "OBBject": [ { "name": "results", - "type": "List[EuropeanCentralBankInterestRates]", + "type": "list[EuropeanCentralBankInterestRates]", "description": "Serializable results." }, { @@ -37764,8 +37624,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37774,7 +37634,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37800,7 +37660,10 @@ ], "fred": [] }, - "model": "EuropeanCentralBankInterestRates" + "model": "EuropeanCentralBankInterestRates", + "openapi_extra": { + "model": "EuropeanCentralBankInterestRates" + } }, "/fixedincome/rate/dpcredit": { "deprecated": { @@ -37843,7 +37706,7 @@ "OBBject": [ { "name": "results", - "type": "List[DiscountWindowPrimaryCreditRate]", + "type": "list[DiscountWindowPrimaryCreditRate]", "description": "Serializable results." }, { @@ -37853,8 +37716,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37863,7 +37726,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -37889,7 +37752,10 @@ ], "fred": [] }, - "model": "DiscountWindowPrimaryCreditRate" + "model": "DiscountWindowPrimaryCreditRate", + "openapi_extra": { + "model": "DiscountWindowPrimaryCreditRate" + } }, "/fixedincome/rate/overnight_bank_funding": { "deprecated": { @@ -37976,7 +37842,7 @@ "OBBject": [ { "name": "results", - "type": "List[OvernightBankFundingRate]", + "type": "list[OvernightBankFundingRate]", "description": "Serializable results." }, { @@ -37986,8 +37852,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -37996,7 +37862,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38072,7 +37938,10 @@ ], "fred": [] }, - "model": "OvernightBankFundingRate" + "model": "OvernightBankFundingRate", + "openapi_extra": { + "model": "OvernightBankFundingRate" + } }, "/fixedincome/spreads/tcm": { "deprecated": { @@ -38114,7 +37983,7 @@ "OBBject": [ { "name": "results", - "type": "List[TreasuryConstantMaturity]", + "type": "list[TreasuryConstantMaturity]", "description": "Serializable results." }, { @@ -38124,8 +37993,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38134,7 +38003,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38160,7 +38029,10 @@ ], "fred": [] }, - "model": "TreasuryConstantMaturity" + "model": "TreasuryConstantMaturity", + "openapi_extra": { + "model": "TreasuryConstantMaturity" + } }, "/fixedincome/spreads/tcm_effr": { "deprecated": { @@ -38202,7 +38074,7 @@ "OBBject": [ { "name": "results", - "type": "List[SelectedTreasuryConstantMaturity]", + "type": "list[SelectedTreasuryConstantMaturity]", "description": "Serializable results." }, { @@ -38212,8 +38084,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38222,7 +38094,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38248,7 +38120,10 @@ ], "fred": [] }, - "model": "SelectedTreasuryConstantMaturity" + "model": "SelectedTreasuryConstantMaturity", + "openapi_extra": { + "model": "SelectedTreasuryConstantMaturity" + } }, "/fixedincome/spreads/treasury_effr": { "deprecated": { @@ -38290,7 +38165,7 @@ "OBBject": [ { "name": "results", - "type": "List[SelectedTreasuryBill]", + "type": "list[SelectedTreasuryBill]", "description": "Serializable results." }, { @@ -38300,8 +38175,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38310,7 +38185,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38336,7 +38211,10 @@ ], "fred": [] }, - "model": "SelectedTreasuryBill" + "model": "SelectedTreasuryBill", + "openapi_extra": { + "model": "SelectedTreasuryBill" + } }, "/fixedincome/government/yield_curve": { "deprecated": { @@ -38349,7 +38227,7 @@ "standard": [ { "name": "date", - "type": "Union[Union[date, str], List[Union[date, str]]]", + "type": "Union[Union[date, str], list[Union[date, str]]]", "description": "A specific date to get data for. By default is the current data. Multiple items allowed for provider(s): econdb, federal_reserve, fmp, fred.", "default": null, "optional": true, @@ -38359,7 +38237,7 @@ "econdb": [ { "name": "country", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. Multiple items allowed for provider(s): econdb.", "default": "united_states", "optional": true, @@ -38419,7 +38297,7 @@ "OBBject": [ { "name": "results", - "type": "List[YieldCurve]", + "type": "list[YieldCurve]", "description": "Serializable results." }, { @@ -38429,8 +38307,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38439,7 +38317,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38468,7 +38346,10 @@ "fmp": [], "fred": [] }, - "model": "YieldCurve" + "model": "YieldCurve", + "openapi_extra": { + "model": "YieldCurve" + } }, "/fixedincome/government/treasury_rates": { "deprecated": { @@ -38503,7 +38384,7 @@ "OBBject": [ { "name": "results", - "type": "List[TreasuryRates]", + "type": "list[TreasuryRates]", "description": "Serializable results." }, { @@ -38513,8 +38394,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38523,7 +38404,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38646,7 +38527,10 @@ "federal_reserve": [], "fmp": [] }, - "model": "TreasuryRates" + "model": "TreasuryRates", + "openapi_extra": { + "model": "TreasuryRates" + } }, "/fixedincome/government/tips_yields": { "deprecated": { @@ -38745,7 +38629,7 @@ "OBBject": [ { "name": "results", - "type": "List[TipsYields]", + "type": "list[TipsYields]", "description": "Serializable results." }, { @@ -38755,8 +38639,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38765,7 +38649,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38815,7 +38699,10 @@ ], "fred": [] }, - "model": "TipsYields" + "model": "TipsYields", + "openapi_extra": { + "model": "TipsYields" + } }, "/fixedincome/corporate/ice_bofa": { "deprecated": { @@ -38890,7 +38777,7 @@ "OBBject": [ { "name": "results", - "type": "List[ICEBofA]", + "type": "list[ICEBofA]", "description": "Serializable results." }, { @@ -38900,8 +38787,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -38910,7 +38797,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -38936,7 +38823,10 @@ ], "fred": [] }, - "model": "ICEBofA" + "model": "ICEBofA", + "openapi_extra": { + "model": "ICEBofA" + } }, "/fixedincome/corporate/moody": { "deprecated": { @@ -38987,7 +38877,7 @@ "OBBject": [ { "name": "results", - "type": "List[MoodyCorporateBondIndex]", + "type": "list[MoodyCorporateBondIndex]", "description": "Serializable results." }, { @@ -38997,8 +38887,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39007,7 +38897,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39033,7 +38923,10 @@ ], "fred": [] }, - "model": "MoodyCorporateBondIndex" + "model": "MoodyCorporateBondIndex", + "openapi_extra": { + "model": "MoodyCorporateBondIndex" + } }, "/fixedincome/corporate/hqm": { "deprecated": { @@ -39046,7 +38939,7 @@ "standard": [ { "name": "date", - "type": "Union[Union[date, str], List[Union[date, str]]]", + "type": "Union[Union[date, str], list[Union[date, str]]]", "description": "A specific date to get data for. Multiple items allowed for provider(s): fred.", "default": null, "optional": true, @@ -39071,7 +38964,7 @@ "OBBject": [ { "name": "results", - "type": "List[HighQualityMarketCorporateBond]", + "type": "list[HighQualityMarketCorporateBond]", "description": "Serializable results." }, { @@ -39081,8 +38974,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39091,7 +38984,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39125,7 +39018,10 @@ ], "fred": [] }, - "model": "HighQualityMarketCorporateBond" + "model": "HighQualityMarketCorporateBond", + "openapi_extra": { + "model": "HighQualityMarketCorporateBond" + } }, "/fixedincome/corporate/spot_rates": { "deprecated": { @@ -39154,7 +39050,7 @@ }, { "name": "maturity", - "type": "Union[Union[float, str], List[Union[float, str]]]", + "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, @@ -39162,7 +39058,7 @@ }, { "name": "category", - "type": "Union[str, List[str]]", + "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, @@ -39178,7 +39074,7 @@ "OBBject": [ { "name": "results", - "type": "List[SpotRate]", + "type": "list[SpotRate]", "description": "Serializable results." }, { @@ -39188,8 +39084,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39198,7 +39094,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39224,7 +39120,10 @@ ], "fred": [] }, - "model": "SpotRate" + "model": "SpotRate", + "openapi_extra": { + "model": "SpotRate" + } }, "/fixedincome/corporate/commercial_paper": { "deprecated": { @@ -39255,7 +39154,7 @@ "fred": [ { "name": "maturity", - "type": "Union[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']], List[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']]]]", + "type": "Union[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']], list[Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']]]]", "description": "A target maturity. Multiple items allowed for provider(s): fred.", "default": "all", "optional": true, @@ -39271,7 +39170,7 @@ }, { "name": "category", - "type": "Union[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']], List[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']]]]", + "type": "Union[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']], list[Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']]]]", "description": "The category of asset. Multiple items allowed for provider(s): fred.", "default": "all", "optional": true, @@ -39340,7 +39239,7 @@ "OBBject": [ { "name": "results", - "type": "List[CommercialPaper]", + "type": "list[CommercialPaper]", "description": "Serializable results." }, { @@ -39350,8 +39249,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39360,7 +39259,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39419,7 +39318,10 @@ } ] }, - "model": "CommercialPaper" + "model": "CommercialPaper", + "openapi_extra": { + "model": "CommercialPaper" + } }, "/fixedincome/sofr": { "deprecated": { @@ -39506,7 +39408,7 @@ "OBBject": [ { "name": "results", - "type": "List[SOFR]", + "type": "list[SOFR]", "description": "Serializable results." }, { @@ -39516,8 +39418,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39526,7 +39428,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39626,7 +39528,10 @@ } ] }, - "model": "SOFR" + "model": "SOFR", + "openapi_extra": { + "model": "SOFR" + } }, "/fixedincome/bond_indices": { "deprecated": { @@ -39678,7 +39583,7 @@ }, { "name": "index", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "The specific index to query. Used in conjunction with 'category' and 'index_type', default is 'yield_curve'.\n Possible values are:\n corporate\n seasoned_corporate\n liquid_corporate\n yield_curve\n crossover\n public_sector\n private_sector\n non_financial\n high_grade\n high_yield\n liquid_emea\n emea\n liquid_asia\n asia\n liquid_latam\n latam\n liquid_aaa\n liquid_bbb\n aaa\n aa\n a\n bbb\n bb\n b\n ccc Multiple items allowed for provider(s): fred.", "default": "yield_curve", "optional": true, @@ -39768,7 +39673,7 @@ "OBBject": [ { "name": "results", - "type": "List[BondIndices]", + "type": "list[BondIndices]", "description": "Serializable results." }, { @@ -39778,8 +39683,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39788,7 +39693,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -39839,7 +39744,10 @@ } ] }, - "model": "BondIndices" + "model": "BondIndices", + "openapi_extra": { + "model": "BondIndices" + } }, "/fixedincome/mortgage_indices": { "deprecated": { @@ -39870,7 +39778,7 @@ "fred": [ { "name": "index", - "type": "Union[Union[Literal['primary', 'ltv_lte_80', 'ltv_gt_80', 'conforming_30y', 'conforming_30y_na', 'jumbo_30y', 'fha_30y', 'va_30y', 'usda_30y', 'conforming_15y', 'ltv_lte80_fico_ge740', 'ltv_lte80_fico_a720b739', 'ltv_lte80_fico_a700b719', 'ltv_lte80_fico_a680b699', 'ltv_lte80_fico_lt680', 'ltv_gt80_fico_ge740', 'ltv_gt80_fico_a720b739', 'ltv_gt80_fico_a700b719', 'ltv_gt80_fico_a680b699', 'ltv_gt80_fico_lt680'], str], List[Union[Literal['primary', 'ltv_lte_80', 'ltv_gt_80', 'conforming_30y', 'conforming_30y_na', 'jumbo_30y', 'fha_30y', 'va_30y', 'usda_30y', 'conforming_15y', 'ltv_lte80_fico_ge740', 'ltv_lte80_fico_a720b739', 'ltv_lte80_fico_a700b719', 'ltv_lte80_fico_a680b699', 'ltv_lte80_fico_lt680', 'ltv_gt80_fico_ge740', 'ltv_gt80_fico_a720b739', 'ltv_gt80_fico_a700b719', 'ltv_gt80_fico_a680b699', 'ltv_gt80_fico_lt680'], str]]]", + "type": "Union[Union[Literal['primary', 'ltv_lte_80', 'ltv_gt_80', 'conforming_30y', 'conforming_30y_na', 'jumbo_30y', 'fha_30y', 'va_30y', 'usda_30y', 'conforming_15y', 'ltv_lte80_fico_ge740', 'ltv_lte80_fico_a720b739', 'ltv_lte80_fico_a700b719', 'ltv_lte80_fico_a680b699', 'ltv_lte80_fico_lt680', 'ltv_gt80_fico_ge740', 'ltv_gt80_fico_a720b739', 'ltv_gt80_fico_a700b719', 'ltv_gt80_fico_a680b699', 'ltv_gt80_fico_lt680'], str], list[Union[Literal['primary', 'ltv_lte_80', 'ltv_gt_80', 'conforming_30y', 'conforming_30y_na', 'jumbo_30y', 'fha_30y', 'va_30y', 'usda_30y', 'conforming_15y', 'ltv_lte80_fico_ge740', 'ltv_lte80_fico_a720b739', 'ltv_lte80_fico_a700b719', 'ltv_lte80_fico_a680b699', 'ltv_lte80_fico_lt680', 'ltv_gt80_fico_ge740', 'ltv_gt80_fico_a720b739', 'ltv_gt80_fico_a700b719', 'ltv_gt80_fico_a680b699', 'ltv_gt80_fico_lt680'], str]]]", "description": "The specific index, or index group, to query. Default is the 'primary' group. Multiple items allowed for provider(s): fred.", "default": "primary", "optional": true, @@ -39955,7 +39863,7 @@ "OBBject": [ { "name": "results", - "type": "List[MortgageIndices]", + "type": "list[MortgageIndices]", "description": "Serializable results." }, { @@ -39965,8 +39873,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -39975,7 +39883,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -40017,7 +39925,10 @@ ], "fred": [] }, - "model": "MortgageIndices" + "model": "MortgageIndices", + "openapi_extra": { + "model": "MortgageIndices" + } }, "/index/price/historical": { "deprecated": { @@ -40030,7 +39941,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", "optional": false, @@ -40136,7 +40047,7 @@ "OBBject": [ { "name": "results", - "type": "List[IndexHistorical]", + "type": "list[IndexHistorical]", "description": "Serializable results." }, { @@ -40146,8 +40057,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -40156,7 +40067,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -40251,7 +40162,10 @@ ], "yfinance": [] }, - "model": "IndexHistorical" + "model": "IndexHistorical", + "openapi_extra": { + "model": "IndexHistorical" + } }, "/index/constituents": { "deprecated": { @@ -40286,7 +40200,7 @@ "OBBject": [ { "name": "results", - "type": "List[IndexConstituents]", + "type": "list[IndexConstituents]", "description": "Serializable results." }, { @@ -40296,8 +40210,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -40306,7 +40220,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -40381,7 +40295,10 @@ } ] }, - "model": "IndexConstituents" + "model": "IndexConstituents", + "openapi_extra": { + "model": "IndexConstituents" + } }, "/index/available": { "deprecated": { @@ -40399,7 +40316,7 @@ "OBBject": [ { "name": "results", - "type": "List[AvailableIndices]", + "type": "list[AvailableIndices]", "description": "Serializable results." }, { @@ -40409,8 +40326,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -40419,7 +40336,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -40480,7 +40397,10 @@ } ] }, - "model": "AvailableIndices" + "model": "AvailableIndices", + "openapi_extra": { + "model": "AvailableIndices" + } }, "/news/world": { "deprecated": { @@ -40700,7 +40620,7 @@ }, { "name": "source", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "A comma-separated list of the domains requested. Multiple items allowed for provider(s): tiingo.", "default": null, "optional": true, @@ -40712,7 +40632,7 @@ "OBBject": [ { "name": "results", - "type": "List[WorldNews]", + "type": "list[WorldNews]", "description": "Serializable results." }, { @@ -40722,8 +40642,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -40732,7 +40652,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -40757,7 +40677,7 @@ }, { "name": "images", - "type": "List[Dict[str, str]]", + "type": "list[Dict[str, str]]", "description": "Images associated with the article.", "default": null, "optional": true, @@ -40997,7 +40917,10 @@ } ] }, - "model": "WorldNews" + "model": "WorldNews", + "openapi_extra": { + "model": "WorldNews" + } }, "/news/company": { "deprecated": { @@ -41010,7 +40933,7 @@ "standard": [ { "name": "symbol", - "type": "Union[str, List[str]]", + "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, @@ -41256,7 +41179,7 @@ }, { "name": "source", - "type": "Union[str, List[str]]", + "type": "Union[str, list[str]]", "description": "A comma-separated list of the domains requested. Multiple items allowed for provider(s): tiingo.", "default": null, "optional": true, @@ -41269,7 +41192,7 @@ "OBBject": [ { "name": "results", - "type": "List[CompanyNews]", + "type": "list[CompanyNews]", "description": "Serializable results." }, { @@ -41279,8 +41202,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -41289,7 +41212,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -41322,7 +41245,7 @@ }, { "name": "images", - "type": "List[Dict[str, str]]", + "type": "list[Dict[str, str]]", "description": "Images associated with the article.", "default": null, "optional": true, @@ -41348,7 +41271,7 @@ "benzinga": [ { "name": "images", - "type": "List[Dict[str, str]]", + "type": "list[Dict[str, str]]", "description": "URL to the images of the news.", "default": null, "optional": true, @@ -41606,7 +41529,10 @@ } ] }, - "model": "CompanyNews" + "model": "CompanyNews", + "openapi_extra": { + "model": "CompanyNews" + } }, "/regulators/sec/filing_headers": { "deprecated": { @@ -41640,7 +41566,7 @@ "OBBject": [ { "name": "results", - "type": "List[SecFiling]", + "type": "list[SecFiling]", "description": "Serializable results." }, { @@ -41650,8 +41576,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -41660,7 +41586,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -41775,14 +41701,28 @@ { "name": "document_urls", "type": "list", - "description": "List of files associated with the filing.", + "description": "list of files associated with the filing.", "default": "", "optional": false, "choices": null } ] }, - "model": "SecFiling" + "model": "SecFiling", + "openapi_extra": { + "widget_config": { + "description": "Get a list of all the documents associated with a filing, and their direct URLs.", + "gridData": { + "w": 30, + "h": 10 + }, + "refetchInterval": false, + "data": { + "dataKey": "results.document_urls" + } + }, + "model": "SecFiling" + } }, "/regulators/sec/htm_file": { "deprecated": { @@ -41816,7 +41756,7 @@ "OBBject": [ { "name": "results", - "type": "List[SecHtmFile]", + "type": "list[SecHtmFile]", "description": "Serializable results." }, { @@ -41826,8 +41766,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -41836,7 +41776,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -41862,7 +41802,23 @@ } ] }, - "model": "SecHtmFile" + "model": "SecHtmFile", + "openapi_extra": { + "widget_config": { + "name": "Open HTML", + "description": "Open a HTM/HTML document from the SEC website.", + "gridData": { + "w": 40, + "h": 25 + }, + "refetchInterval": false, + "type": "markdown", + "data": { + "dataKey": "results.content" + } + }, + "model": "SecHtmFile" + } }, "/regulators/sec/cik_map": { "deprecated": { @@ -41897,7 +41853,7 @@ "OBBject": [ { "name": "results", - "type": "List[CikMap]", + "type": "list[CikMap]", "description": "Serializable results." }, { @@ -41907,8 +41863,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -41917,7 +41873,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -41935,7 +41891,10 @@ ], "sec": [] }, - "model": "CikMap" + "model": "CikMap", + "openapi_extra": { + "model": "CikMap" + } }, "/regulators/sec/institutions_search": { "deprecated": { @@ -41970,7 +41929,7 @@ "OBBject": [ { "name": "results", - "type": "List[InstitutionsSearch]", + "type": "list[InstitutionsSearch]", "description": "Serializable results." }, { @@ -41980,8 +41939,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -41990,7 +41949,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42016,7 +41975,10 @@ } ] }, - "model": "InstitutionsSearch" + "model": "InstitutionsSearch", + "openapi_extra": { + "model": "InstitutionsSearch" + } }, "/regulators/sec/schema_files": { "deprecated": { @@ -42024,7 +41986,7 @@ "message": null }, "description": "Use tool for navigating the directory of SEC XML schema files by year.", - "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024FileList.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", + "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.schema_files(provider='sec')\n# Get a list of schema files.\ndata = obb.regulators.sec.schema_files().results\ndata.files[0]\n'https://xbrl.fasb.org/us-gaap/'\n# The directory structure can be navigated by constructing a URL from the 'results' list.\nurl = data.files[0]+data.files[-1]\n# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.\nobb.regulators.sec.schema_files(url=url).results.files\n['https://xbrl.fasb.org/us-gaap/2024/'\n'USGAAP2024Filelist.xml'\n'dis/'\n'dqcrules/'\n'ebp/'\n'elts/'\n'entire/'\n'meta/'\n'stm/'\n'us-gaap-2024.zip']\n```\n\n", "parameters": { "standard": [ { @@ -42059,7 +42021,7 @@ "OBBject": [ { "name": "results", - "type": "List[SchemaFiles]", + "type": "list[SchemaFiles]", "description": "Serializable results." }, { @@ -42069,8 +42031,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42079,7 +42041,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42089,7 +42051,7 @@ "sec": [ { "name": "files", - "type": "List[str]", + "type": "list[str]", "description": "Dictionary of URLs to SEC Schema Files", "default": "", "optional": false, @@ -42097,7 +42059,10 @@ } ] }, - "model": "SchemaFiles" + "model": "SchemaFiles", + "openapi_extra": { + "model": "SchemaFiles" + } }, "/regulators/sec/symbol_map": { "deprecated": { @@ -42131,7 +42096,7 @@ "OBBject": [ { "name": "results", - "type": "List[SymbolMap]", + "type": "list[SymbolMap]", "description": "Serializable results." }, { @@ -42141,8 +42106,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42151,7 +42116,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42169,7 +42134,10 @@ } ] }, - "model": "SymbolMap" + "model": "SymbolMap", + "openapi_extra": { + "model": "SymbolMap" + } }, "/regulators/sec/rss_litigation": { "deprecated": { @@ -42186,7 +42154,7 @@ "OBBject": [ { "name": "results", - "type": "List[RssLitigation]", + "type": "list[RssLitigation]", "description": "Serializable results." }, { @@ -42196,8 +42164,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42206,7 +42174,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42256,7 +42224,10 @@ } ] }, - "model": "RssLitigation" + "model": "RssLitigation", + "openapi_extra": { + "model": "RssLitigation" + } }, "/regulators/sec/sic_search": { "deprecated": { @@ -42291,7 +42262,7 @@ "OBBject": [ { "name": "results", - "type": "List[SicSearch]", + "type": "list[SicSearch]", "description": "Serializable results." }, { @@ -42301,8 +42272,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42311,7 +42282,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42345,7 +42316,10 @@ } ] }, - "model": "SicSearch" + "model": "SicSearch", + "openapi_extra": { + "model": "SicSearch" + } }, "/regulators/cftc/cot_search": { "deprecated": { @@ -42371,7 +42345,7 @@ "OBBject": [ { "name": "results", - "type": "List[COTSearch]", + "type": "list[COTSearch]", "description": "Serializable results." }, { @@ -42381,8 +42355,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42391,7 +42365,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42458,7 +42432,10 @@ } ] }, - "model": "COTSearch" + "model": "COTSearch", + "openapi_extra": { + "model": "COTSearch" + } }, "/regulators/cftc/cot": { "deprecated": { @@ -42522,7 +42499,7 @@ "OBBject": [ { "name": "results", - "type": "List[COT]", + "type": "list[COT]", "description": "Serializable results." }, { @@ -42532,8 +42509,8 @@ }, { "name": "warnings", - "type": "Optional[List[Warning_]]", - "description": "List of warnings." + "type": "Optional[list[Warning_]]", + "description": "list of warnings." }, { "name": "chart", @@ -42542,7 +42519,7 @@ }, { "name": "extra", - "type": "Dict[str, Any]", + "type": "dict[str, Any]", "description": "Extra info." } ] @@ -42680,7 +42657,10 @@ ], "cftc": [] }, - "model": "COT" + "model": "COT", + "openapi_extra": { + "model": "COT" + } } }, "routers": { diff --git a/openbb_platform/openbb/package/__extensions__.py b/openbb_platform/openbb/package/__extensions__.py index d99f33e1861..a17adb65d59 100644 --- a/openbb_platform/openbb/package/__extensions__.py +++ b/openbb_platform/openbb/package/__extensions__.py @@ -25,7 +25,7 @@ Extensions: - crypto@1.4.0 - currency@1.4.0 - derivatives@1.4.0 - - economy@1.4.0 + - economy@1.4.1 - equity@1.4.0 - etf@1.4.0 - fixedincome@1.4.2 @@ -34,21 +34,21 @@ Extensions: - regulators@1.4.1 - benzinga@1.4.0 - - bls@1.1.0 + - bls@1.1.1 - cftc@1.1.0 - econdb@1.3.0 - - federal_reserve@1.4.0 + - federal_reserve@1.4.1 - fmp@1.4.1 - fred@1.4.1 - imf@1.1.0 - intrinio@1.4.0 - oecd@1.4.0 - polygon@1.4.0 - - sec@1.4.1 + - sec@1.4.2 - tiingo@1.4.0 - tradingeconomics@1.4.0 - us_eia@1.1.0 - - yfinance@1.4.1 """ + - yfinance@1.4.2 """ # fmt: on def __repr__(self) -> str: diff --git a/openbb_platform/openbb/package/commodity.py b/openbb_platform/openbb/package/commodity.py index e6c6e7ab790..abd49b589ae 100644 --- a/openbb_platform/openbb/package/commodity.py +++ b/openbb_platform/openbb/package/commodity.py @@ -45,71 +45,71 @@ class ROUTER_commodity(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: eia. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['eia']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: eia. category : Literal['balance_sheet', 'inputs_and_production', 'refiner_blender_net_production', 'crude_petroleum_stocks', 'gasoline_fuel_stocks', 'total_gasoline_by_sub_padd', 'distillate_fuel_oil_stocks', 'imports', 'imports_by_country', 'weekly_estimates', 'spot_prices_crude_gas_heating', 'spot_prices_diesel_jet_fuel_propane', 'retail_prices'] The group of data to be returned. The default is the balance sheet. (provider: eia) table : Optional[str] The specific table element within the category to be returned, default is 'stocks', if the category is 'weekly_estimates', else 'all'. - Note: Choices represent all available tables from the entire collection and are not all available for every category. - Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category. - Choices are: - all - conventional_gas - crude - crude_production - crude_production_avg - diesel - ethanol_plant_production - ethanol_plant_production_avg - exports - exports_avg - heating_oil - imports - imports_avg - imports_by_country - imports_by_country_avg - inputs_and_utilization - inputs_and_utilization_avg - jet_fuel - monthly - net_imports_inc_spr_avg - net_imports_incl_spr - net_production - net_production_avg - net_production_by_product - net_production_by_production_avg - product_by_region - product_by_region_avg - product_supplied - product_supplied_avg - propane - rbob - refiner_blender_net_production - refiner_blender_net_production_avg - stocks - supply - supply_avg - ulta_low_sulfur_distillate_reclassification - ulta_low_sulfur_distillate_reclassification_avg - weekly - Multiple comma separated items allowed. (provider: eia) + Note: Choices represent all available tables from the entire collection and are not all available for every category. + Invalid choices will raise a ValidationError with a message indicating the valid choices for the selected category. + Choices are: + all + conventional_gas + crude + crude_production + crude_production_avg + diesel + ethanol_plant_production + ethanol_plant_production_avg + exports + exports_avg + heating_oil + imports + imports_avg + imports_by_country + imports_by_country_avg + inputs_and_utilization + inputs_and_utilization_avg + jet_fuel + monthly + net_imports_inc_spr_avg + net_imports_incl_spr + net_production + net_production_avg + net_production_by_product + net_production_by_production_avg + product_by_region + product_by_region_avg + product_supplied + product_supplied_avg + propane + rbob + refiner_blender_net_production + refiner_blender_net_production_avg + stocks + supply + supply_avg + ulta_low_sulfur_distillate_reclassification + ulta_low_sulfur_distillate_reclassification_avg + weekly + Multiple comma separated items allowed. (provider: eia) use_cache : bool Subsequent requests for the same source data are cached for the session using ALRU cache. (provider: eia) Returns ------- OBBject - results : List[PetroleumStatusReport] + results : list[PetroleumStatusReport] Serializable results. - provider : Optional[Literal['eia']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -263,54 +263,54 @@ class ROUTER_commodity(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: eia. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['eia']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: eia. symbol : Optional[str] Symbol to get data for. If provided, overrides the 'table' parameter to return only the specified symbol from the STEO API. Multiple comma separated items allowed. (provider: eia) table : Literal['01', '02', '03a', '03b', '03c', '03d', '03e', '04a', '04b', '04c', '04d', '05a', '05b', '06', '07a', '07b', '07c', '07d1', '07d2', '07e', '08', '09a', '09b', '09c', '10a', '10b'] The specific table within the STEO dataset. Default is '01'. When 'symbol' is provided, this parameter is ignored. - 01: US Energy Markets Summary - 02: Nominal Energy Prices - 03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories - 03b: Non-OPEC Petroleum and Other Liquid Fuels Production - 03c: World Petroleum and Other Liquid Fuels Production - 03d: World Crude Oil Production - 03e: World Petroleum and Other Liquid Fuels Consumption - 04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories - 04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances - 04c: US Regional Motor Gasoline Prices and Inventories - 04d: US Biofuel Supply, Consumption, and Inventories - 05a: US Natural Gas Supply, Consumption, and Inventories - 05b: US Regional Natural Gas Prices - 06: US Coal Supply, Consumption, and Inventories - 07a: US Electricity Industry Overview - 07b: US Regional Electricity Retail Sales - 07c: US Regional Electricity Prices - 07d1: US Regional Electricity Generation, Electric Power Sector - 07d2: US Regional Electricity Generation, Electric Power Sector, continued - 07e: US Electricity Generating Capacity - 08: US Renewable Energy Consumption - 09a: US Macroeconomic Indicators and CO2 Emissions - 09b: US Regional Macroeconomic Data - 09c: US Regional Weather Data - 10a: Drilling Productivity Metrics - 10b: Crude Oil and Natural Gas Production from Shale and Tight Formations (provider: eia) + 01: US Energy Markets Summary + 02: Nominal Energy Prices + 03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories + 03b: Non-OPEC Petroleum and Other Liquid Fuels Production + 03c: World Petroleum and Other Liquid Fuels Production + 03d: World Crude Oil Production + 03e: World Petroleum and Other Liquid Fuels Consumption + 04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories + 04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances + 04c: US Regional Motor Gasoline Prices and Inventories + 04d: US Biofuel Supply, Consumption, and Inventories + 05a: US Natural Gas Supply, Consumption, and Inventories + 05b: US Regional Natural Gas Prices + 06: US Coal Supply, Consumption, and Inventories + 07a: US Electricity Industry Overview + 07b: US Regional Electricity Retail Sales + 07c: US Regional Electricity Prices + 07d1: US Regional Electricity Generation, Electric Power Sector + 07d2: US Regional Electricity Generation, Electric Power Sector, continued + 07e: US Electricity Generating Capacity + 08: US Renewable Energy Consumption + 09a: US Macroeconomic Indicators and CO2 Emissions + 09b: US Regional Macroeconomic Data + 09c: US Regional Weather Data + 10a: Drilling Productivity Metrics + 10b: Crude Oil and Natural Gas Production from Shale and Tight Formations (provider: eia) frequency : Literal['month', 'quarter', 'annual'] The frequency of the data. Default is 'month'. (provider: eia) Returns ------- OBBject - results : List[ShortTermEnergyOutlook] + results : list[ShortTermEnergyOutlook] Serializable results. - provider : Optional[Literal['eia']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/commodity_price.py b/openbb_platform/openbb/package/commodity_price.py index 09d87f7041b..23e4a7ebdd4 100644 --- a/openbb_platform/openbb/package/commodity_price.py +++ b/openbb_platform/openbb/package/commodity_price.py @@ -43,61 +43,61 @@ class ROUTER_commodity_price(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. commodity : Literal['wti', 'brent', 'natural_gas', 'jet_fuel', 'propane', 'heating_oil', 'diesel_gulf_coast', 'diesel_ny_harbor', 'diesel_la', 'gasoline_ny_harbor', 'gasoline_gulf_coast', 'rbob', 'all'] Commodity name associated with the EIA spot price commodity data, default is 'all'. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] 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 - (provider: fred) + 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 + (provider: fred) aggregation_method : Literal['avg', 'sum', 'eop'] 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 - (provider: fred) + This parameter has no affect if the frequency parameter is not set. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[CommoditySpotPrices] + results : list[CommoditySpotPrices] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/crypto.py b/openbb_platform/openbb/package/crypto.py index be006b8c7ab..fa7de9197ea 100644 --- a/openbb_platform/openbb/package/crypto.py +++ b/openbb_platform/openbb/package/crypto.py @@ -45,20 +45,20 @@ class ROUTER_crypto(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. query : Optional[str] Search query. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[CryptoSearch] + results : list[CryptoSearch] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/crypto_price.py b/openbb_platform/openbb/package/crypto_price.py index 135b4efda9f..e18cfb1c4b8 100644 --- a/openbb_platform/openbb/package/crypto_price.py +++ b/openbb_platform/openbb/package/crypto_price.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -24,7 +24,7 @@ class ROUTER_crypto_price(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), @@ -49,32 +49,34 @@ class ROUTER_crypto_price(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon, tiingo, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon, tiingo, yfinance. - interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], str, Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '7d', '30d'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']] + interval : str Time interval of the data to return. (provider: fmp, polygon, tiingo, yfinance) + Choices for fmp: '1m', '5m', '15m', '30m', '1h', '4h', '1d' + Choices for yfinance: '1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q' sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int The number of data entries to return. (provider: polygon) - exchanges : Optional[Union[list[str], str]] + exchanges : Union[list[str], str, None] To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple comma separated items allowed. (provider: tiingo) Returns ------- OBBject - results : List[CryptoHistorical] + results : list[CryptoHistorical] Serializable results. - provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py index fbeb693a2b8..f2ab64a0f5a 100644 --- a/openbb_platform/openbb/package/currency.py +++ b/openbb_platform/openbb/package/currency.py @@ -1,6 +1,6 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -56,20 +56,20 @@ class ROUTER_currency(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon. query : Optional[str] Query to search for currency pairs. - provider : Optional[Literal['fmp', 'intrinio', 'polygon']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon. Returns ------- OBBject - results : List[CurrencyPairs] + results : list[CurrencyPairs] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -138,7 +138,7 @@ class ROUTER_currency(Container): def snapshots( self, base: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon." ), @@ -150,7 +150,7 @@ class ROUTER_currency(Container): ), ] = "indirect", counter_currencies: Annotated[ - Union[str, List[str], None], + Union[str, list[str], None], OpenBBField( description="An optional list of counter currency symbols to filter for. None returns all." ), @@ -167,24 +167,24 @@ class ROUTER_currency(Container): Parameters ---------- - base : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon. + base : Union[str, list[str]] The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon. quote_type : Literal['direct', 'indirect'] 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. - counter_currencies : Union[str, List[str], None] + counter_currencies : Union[str, list[str], None] An optional list of counter currency symbols to filter for. None returns all. - provider : Optional[Literal['fmp', 'polygon']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon. Returns ------- OBBject - results : List[CurrencySnapshots] + results : list[CurrencySnapshots] Serializable results. - provider : Optional[Literal['fmp', 'polygon']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/currency_price.py b/openbb_platform/openbb/package/currency_price.py index 93495aeb4f3..ce1e9c83095 100644 --- a/openbb_platform/openbb/package/currency_price.py +++ b/openbb_platform/openbb/package/currency_price.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -24,7 +24,7 @@ class ROUTER_currency_price(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), @@ -56,16 +56,18 @@ class ROUTER_currency_price(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon, tiingo, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon, tiingo, yfinance. - interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], str, Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '5d', '21d'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']] + interval : str Time interval of the data to return. (provider: fmp, polygon, tiingo, yfinance) + Choices for fmp: '1m', '5m', '15m', '30m', '1h', '4h', '1d' + Choices for yfinance: '1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q' sort : Literal['asc', 'desc'] 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. (provider: polygon) limit : int @@ -74,12 +76,12 @@ class ROUTER_currency_price(Container): Returns ------- OBBject - results : List[CurrencyHistorical] + results : list[CurrencyHistorical] Serializable results. - provider : Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/derivatives_futures.py b/openbb_platform/openbb/package/derivatives_futures.py index 632cdfff8b5..b82b66b6627 100644 --- a/openbb_platform/openbb/package/derivatives_futures.py +++ b/openbb_platform/openbb/package/derivatives_futures.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -26,7 +26,7 @@ class ROUTER_derivatives_futures(Container): self, symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")], date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. Multiple comma separated items allowed for provider(s): yfinance." ), @@ -43,22 +43,22 @@ class ROUTER_derivatives_futures(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. symbol : str Symbol to get data for. - date : Union[date, str, None, List[Union[date, str, None]]] + date : Union[date, str, None, list[Union[date, str, None]]] A specific date to get data for. Multiple comma separated items allowed for provider(s): yfinance. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. Returns ------- OBBject - results : List[FuturesCurve] + results : list[FuturesCurve] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -107,7 +107,7 @@ class ROUTER_derivatives_futures(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance." ), @@ -136,7 +136,9 @@ class ROUTER_derivatives_futures(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. @@ -144,20 +146,18 @@ class ROUTER_derivatives_futures(Container): End date of the data, in YYYY-MM-DD format. expiration : Optional[str] Future expiry date with format YYYY-MM - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. interval : Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] Time interval of the data to return. (provider: yfinance) Returns ------- OBBject - results : List[FuturesHistorical] + results : list[FuturesHistorical] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py index e60cc1aa6a1..416ba769937 100644 --- a/openbb_platform/openbb/package/derivatives_options.py +++ b/openbb_platform/openbb/package/derivatives_options.py @@ -37,13 +37,13 @@ class ROUTER_derivatives_options(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, yfinance. symbol : str Symbol to get data for. - provider : Optional[Literal['intrinio', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, yfinance. delay : Literal['eod', 'realtime', 'delayed'] Whether to return delayed, realtime, or eod data. (provider: intrinio) - date : Optional[datetime.date] + date : Optional[date] The end-of-day date for options chains data. (provider: intrinio) option_type : Optional[Literal['call', 'put']] The option type, call or put, 'None' is both (default). (provider: intrinio) @@ -73,10 +73,10 @@ class ROUTER_derivatives_options(Container): OBBject results : OptionsChains Serializable results. - provider : Optional[Literal['intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -84,113 +84,113 @@ class ROUTER_derivatives_options(Container): OptionsChains ------------- - underlying_symbol : List[Optional[str]] + underlying_symbol : list[Optional[str]] Underlying symbol for the option. - underlying_price : List[Optional[float]] + underlying_price : list[Optional[float]] Price of the underlying stock. - contract_symbol : List[str] + contract_symbol : list[str] Contract symbol for the option. - eod_date : List[Optional[date]] + eod_date : list[Optional[date]] Date for which the options chains are returned. - expiration : List[date] + expiration : list[date] Expiration date of the contract. - dte : List[Optional[int]] + dte : list[Optional[int]] Days to expiration of the contract. - strike : List[float] + strike : list[float] Strike price of the contract. - option_type : List[str] + option_type : list[str] Call or Put. - contract_size : List[Union[int, float]] + contract_size : list[Union[int, float]] Number of underlying units per contract. - open_interest : List[Union[int, float]] + open_interest : list[Union[int, float]] Open interest on the contract. - volume : List[Union[int, float]] + volume : list[Union[int, float]] The trading volume. - theoretical_price : List[Optional[float]] + theoretical_price : list[Optional[float]] Theoretical value of the option. - last_trade_price : List[Optional[float]] + last_trade_price : list[Optional[float]] Last trade price of the option. - last_trade_size : List[Union[int, float]] + last_trade_size : list[Union[int, float]] Last trade size of the option. - last_trade_time : List[Optional[datetime]] + last_trade_time : list[Optional[datetime]] The timestamp of the last trade. - tick : List[Optional[str]] + tick : list[Optional[str]] Whether the last tick was up or down in price. - bid : List[Optional[float]] + bid : list[Optional[float]] Current bid price for the option. - bid_size : List[Union[int, float]] + bid_size : list[Union[int, float]] Bid size for the option. - bid_time : List[Optional[datetime]] + bid_time : list[Optional[datetime]] The timestamp of the bid price. - bid_exchange : List[Optional[str]] + bid_exchange : list[Optional[str]] The exchange of the bid price. - ask : List[Optional[float]] + ask : list[Optional[float]] Current ask price for the option. - ask_size : List[Union[int, float]] + ask_size : list[Union[int, float]] Ask size for the option. - ask_time : List[Optional[datetime]] + ask_time : list[Optional[datetime]] The timestamp of the ask price. - ask_exchange : List[Optional[str]] + ask_exchange : list[Optional[str]] The exchange of the ask price. - mark : List[Optional[float]] + mark : list[Optional[float]] The mid-price between the latest bid and ask. - open : List[Optional[float]] + open : list[Optional[float]] The open price. - open_bid : List[Optional[float]] + open_bid : list[Optional[float]] The opening bid price for the option that day. - open_ask : List[Optional[float]] + open_ask : list[Optional[float]] The opening ask price for the option that day. - high : List[Optional[float]] + high : list[Optional[float]] The high price. - bid_high : List[Optional[float]] + bid_high : list[Optional[float]] The highest bid price for the option that day. - ask_high : List[Optional[float]] + ask_high : list[Optional[float]] The highest ask price for the option that day. - low : List[Optional[float]] + low : list[Optional[float]] The low price. - bid_low : List[Optional[float]] + bid_low : list[Optional[float]] The lowest bid price for the option that day. - ask_low : List[Optional[float]] + ask_low : list[Optional[float]] The lowest ask price for the option that day. - close : List[Optional[float]] + close : list[Optional[float]] The close price. - close_size : List[Union[int, float]] + close_size : list[Union[int, float]] The closing trade size for the option that day. - close_time : List[Optional[datetime]] + close_time : list[Optional[datetime]] The time of the closing price for the option that day. - close_bid : List[Optional[float]] + close_bid : list[Optional[float]] The closing bid price for the option that day. - close_bid_size : List[Union[int, float]] + close_bid_size : list[Union[int, float]] The closing bid size for the option that day. - close_bid_time : List[Optional[datetime]] + close_bid_time : list[Optional[datetime]] The time of the bid closing price for the option that day. - close_ask : List[Optional[float]] + close_ask : list[Optional[float]] The closing ask price for the option that day. - close_ask_size : List[Union[int, float]] + close_ask_size : list[Union[int, float]] The closing ask size for the option that day. - close_ask_time : List[Optional[datetime]] + close_ask_time : list[Optional[datetime]] The time of the ask closing price for the option that day. - prev_close : List[Optional[float]] + prev_close : list[Optional[float]] The previous close price. - change : List[Optional[float]] + change : list[Optional[float]] The change in the price of the option. - change_percent : List[Optional[float]] + change_percent : list[Optional[float]] Change, in normalized percentage points, of the option. - implied_volatility : List[Optional[float]] + implied_volatility : list[Optional[float]] Implied volatility of the option. - delta : List[Optional[float]] + delta : list[Optional[float]] Delta of the option. - gamma : List[Optional[float]] + gamma : list[Optional[float]] Gamma of the option. - theta : List[Optional[float]] + theta : list[Optional[float]] Theta of the option. - vega : List[Optional[float]] + vega : list[Optional[float]] Vega of the option. - rho : List[Optional[float]] + rho : list[Optional[float]] Rho of the option. - in_the_money : List[Optional[bool]] + in_the_money : list[Optional[bool]] Whether the option is in the money. (provider: yfinance) - currency : List[Optional[str]] + currency : list[Optional[str]] Currency of the option. (provider: yfinance) Examples @@ -260,9 +260,9 @@ class ROUTER_derivatives_options(Container): Parameters ---------- - provider : Optional[Literal['intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. - date : Optional[Union[datetime.date, datetime.datetime, str]] + date : Union[date, datetime, str, None] The date of the data. Can be a datetime or an ISO datetime string. Data appears to go back to around 2022-06-01 Example: '2024-03-08T12:15:00+0400' (provider: intrinio) only_traded : bool Only include options that have been traded during the session, default is True. Setting to false will dramatically increase the size of the response - use with caution. (provider: intrinio) @@ -270,12 +270,12 @@ class ROUTER_derivatives_options(Container): Returns ------- OBBject - results : List[OptionsSnapshots] + results : list[OptionsSnapshots] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -283,59 +283,59 @@ class ROUTER_derivatives_options(Container): OptionsSnapshots ---------------- - underlying_symbol : List[str] + underlying_symbol : list[str] Ticker symbol of the underlying asset. - contract_symbol : List[str] + contract_symbol : list[str] Symbol of the options contract. - expiration : List[date] + expiration : list[date] Expiration date of the options contract. - dte : List[Optional[int]] + dte : list[Optional[int]] Number of days to expiration of the options contract. - strike : List[float] + strike : list[float] Strike price of the options contract. - option_type : List[str] + option_type : list[str] The type of option. - volume : List[Optional[int]] + volume : list[Optional[int]] The trading volume. - open_interest : List[Optional[int]] + open_interest : list[Optional[int]] Open interest at the time. - last_price : List[Optional[float]] + last_price : list[Optional[float]] Last trade price at the time. - last_size : List[Optional[int]] + last_size : list[Optional[int]] Lot size of the last trade. - last_timestamp : List[Optional[datetime]] + last_timestamp : list[Optional[datetime]] Timestamp of the last price. - open : List[Optional[float]] + open : list[Optional[float]] The open price. - high : List[Optional[float]] + high : list[Optional[float]] The high price. - low : List[Optional[float]] + low : list[Optional[float]] The low price. - close : List[Optional[float]] + close : list[Optional[float]] The close price. - bid : List[Optional[float]] + bid : list[Optional[float]] The last bid price at the time. (provider: intrinio) - bid_size : List[Optional[int]] + bid_size : list[Optional[int]] The size of the last bid price. (provider: intrinio) - bid_timestamp : List[Optional[datetime]] + bid_timestamp : list[Optional[datetime]] The timestamp of the last bid price. (provider: intrinio) - ask : List[Optional[float]] + ask : list[Optional[float]] The last ask price at the time. (provider: intrinio) - ask_size : List[Optional[int]] + ask_size : list[Optional[int]] The size of the last ask price. (provider: intrinio) - ask_timestamp : List[Optional[datetime]] + ask_timestamp : list[Optional[datetime]] The timestamp of the last ask price. (provider: intrinio) - total_bid_volume : List[Optional[int]] + total_bid_volume : list[Optional[int]] Total volume of bids. (provider: intrinio) - bid_high : List[Optional[float]] + bid_high : list[Optional[float]] The highest bid price. (provider: intrinio) - bid_low : List[Optional[float]] + bid_low : list[Optional[float]] The lowest bid price. (provider: intrinio) - total_ask_volume : List[Optional[int]] + total_ask_volume : list[Optional[int]] Total volume of asks. (provider: intrinio) - ask_high : List[Optional[float]] + ask_high : list[Optional[float]] The highest ask price. (provider: intrinio) - ask_low : List[Optional[float]] + ask_low : list[Optional[float]] The lowest ask price. (provider: intrinio) Examples @@ -379,21 +379,21 @@ class ROUTER_derivatives_options(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. symbol : Optional[str] Symbol to get data for. (the underlying symbol) - provider : Optional[Literal['intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. - start_date : Optional[datetime.date] + start_date : Optional[date] 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. (provider: intrinio) - end_date : Optional[datetime.date] + end_date : Optional[date] End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio) trade_type : Optional[Literal['block', 'sweep', 'large']] The type of unusual activity to query for. (provider: intrinio) sentiment : Optional[Literal['bullish', 'bearish', 'neutral']] The sentiment type to query for. (provider: intrinio) - min_value : Optional[Union[int, float]] + min_value : Union[int, float, None] The inclusive minimum total value for the unusual activity. (provider: intrinio) - max_value : Optional[Union[int, float]] + max_value : Union[int, float, None] The inclusive maximum total value for the unusual activity. (provider: intrinio) limit : int 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. (provider: intrinio) @@ -403,12 +403,12 @@ class ROUTER_derivatives_options(Container): Returns ------- OBBject - results : List[OptionsUnusual] + results : list[OptionsUnusual] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index cdf811d614a..54f8312402d 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from warnings import simplefilter, warn from openbb_core.app.deprecation import OpenBBDeprecationWarning @@ -67,7 +67,7 @@ class ROUTER_economy(Container): Parameters ---------- - provider : Optional[Literal['econdb', 'imf']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, imf. use_cache : bool Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. (provider: econdb) @@ -77,12 +77,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[AvailableIndicators] + results : list[AvailableIndicators] Serializable results. - provider : Optional[Literal['econdb', 'imf']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -171,24 +171,24 @@ class ROUTER_economy(Container): Parameters ---------- - provider : Optional[Literal['fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. country : Literal['argentina', 'australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'czechia', 'denmark', 'estonia', 'finland', 'france', 'germany', 'greece', 'hungary', 'iceland', 'india', 'indonesia', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'poland', 'portugal', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'g7', 'g20'] The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred) - start_date : Optional[datetime.date] + start_date : Optional[date] Start date of the data, in YYYY-MM-DD format. (provider: fred) - end_date : Optional[datetime.date] + end_date : Optional[date] End date of the data, in YYYY-MM-DD format. (provider: fred) Returns ------- OBBject - results : List[BalanceOfPayments] + results : list[BalanceOfPayments] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -342,30 +342,30 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, tradingeconomics. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'tradingeconomics']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, tradingeconomics. country : Optional[str] Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics) importance : Optional[Literal['low', 'medium', 'high']] Importance of the event. (provider: tradingeconomics) group : Optional[Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']] Grouping of events. (provider: tradingeconomics) - calendar_id : Optional[Union[NoneType, int, str]] + calendar_id : Union[None, int, str] Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics) Returns ------- OBBject - results : List[EconomicCalendar] + results : list[EconomicCalendar] Serializable results. - provider : Optional[Literal['fmp', 'tradingeconomics']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -709,10 +709,10 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. date : Union[date, None, str] A specific date to get data for. - provider : Optional[Literal['federal_reserve']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. holding_type : Literal['all_agency', 'agency_debts', 'mbs', 'cmbs', 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips'] Type of holdings to return. (provider: federal_reserve) summary : bool @@ -727,12 +727,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[CentralBankHoldings] + results : list[CentralBankHoldings] Serializable results. - provider : Optional[Literal['federal_reserve']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -857,12 +857,12 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. country : Union[Literal['g20', 'g7', 'asia5', 'north_america', 'europe4', 'australia', 'brazil', 'canada', 'china', 'france', 'germany', 'india', 'indonesia', 'italy', 'japan', 'mexico', 'south_africa', 'south_korea', 'spain', 'turkey', 'united_kingdom', 'united_states', 'all'], str] Country to get the CLI for, default is G20. Multiple comma separated items allowed. (provider: oecd) adjustment : Literal['amplitude', 'normalized'] @@ -873,12 +873,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[CompositeLeadingIndicator] + results : list[CompositeLeadingIndicator] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -955,7 +955,7 @@ class ROUTER_economy(Container): def country_profile( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="The country to get data. Multiple comma separated items allowed for provider(s): econdb." ), @@ -972,10 +972,10 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed for provider(s): econdb. - provider : Optional[Literal['econdb']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. + country : Union[str, list[str]] + The country to get data. Multiple comma separated items allowed for provider(s): econdb. latest : bool If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb) use_cache : bool @@ -984,12 +984,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[CountryProfile] + results : list[CountryProfile] Serializable results. - provider : Optional[Literal['econdb']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1061,9 +1061,9 @@ class ROUTER_economy(Container): def cpi( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): fred, oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): fred, oecd.\nChoices for fred: 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'croatia', 'cyprus', 'czech_republic', 'denmark', 'estonia', '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'\nChoices for oecd: 'G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area_20', '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', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all'" ), ] = "united_states", transform: Annotated[ @@ -1102,8 +1102,12 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred, oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): fred, oecd. + Choices for fred: 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'croatia', 'cyprus', 'czech_republic', 'denmark', 'estonia', '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' + Choices for oecd: 'G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area_20', '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', 'russia', 'saudi_arabia', 'slovak_republic', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states', 'all' transform : Literal['index', 'yoy', 'period'] Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy). frequency : Literal['annual', 'quarter', 'monthly'] @@ -1114,20 +1118,18 @@ class ROUTER_economy(Container): Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred', 'oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred, oecd. expenditure : Literal['total', 'all', 'actual_rentals', 'alcoholic_beverages_tobacco_narcotics', 'all_non_food_non_energy', 'clothing_footwear', 'communication', 'education', 'electricity_gas_other_fuels', 'energy', 'overall_excl_energy_food_alcohol_tobacco', 'food_non_alcoholic_beverages', 'fuels_lubricants_personal', 'furniture_household_equipment', 'goods', 'housing', 'housing_excluding_rentals', 'housing_water_electricity_gas', 'health', 'imputed_rentals', 'maintenance_repair_dwelling', 'miscellaneous_goods_services', 'recreation_culture', 'residuals', 'restaurants_hotels', 'services_less_housing', 'services_less_house_excl_rentals', 'services', 'transport', 'water_supply_other_services'] Expenditure component of CPI. (provider: oecd) Returns ------- OBBject - results : List[ConsumerPriceIndex] + results : list[ConsumerPriceIndex] Serializable results. - provider : Optional[Literal['fred', 'oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1294,15 +1296,15 @@ class ROUTER_economy(Container): def direction_of_trade( self, country: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( - description="The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf." + description="The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf.\nChoices for imf: 'all', 'advanced_economies', 'afghanistan', 'africa', 'africa_not_allocated', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'antilles', 'argentina', 'armenia', 'aruba', 'asia_not_allocated', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belgo-luxembourg_economic_union', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'china', 'colombia', 'community_of_independent_states', 'comoros', 'congo', 'costa_rica', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'democratic_republic_of_the_congo', 'denmark', 'developing_asia', 'djibouti', 'dominica', 'dominican_republic', 'east_germany', 'eastern_caribbean_currency_union', 'ecuador', 'egypt', 'el_salvador', 'emerging_and_developing_countries', 'emerging_and_developing_europe', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'euro_area', 'europe', 'europe_not_allocated', 'european_union', 'export_earnings_fuel', 'export_earnings_nonfuel', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'former_czechoslovakia', 'former_ussr', 'former_yugoslavia', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'honduras', 'hong_kong', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'ivory_coast', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'macao', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'middle_east', 'middle_east_and_central_asia', 'middle_east_and_central_asia_not_specified', 'middle_east_north_africa_afghanistan_and_pakistan', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_korea', 'north_macedonia', 'north_vietnam', 'norway', 'oman', 'other_countries_nie', 'pakistan', 'palau', 'palestine', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia', 'serbia_and_montenegro', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_african_common_customs_area', 'south_korea', 'south_sudan', 'spain', 'special_categories_and_economic_zones', 'sri_lanka', 'sub-saharan_africa', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'vatican_city_state', 'venezuela', 'viet_nam', 'west_malaysia', 'western_hemisphere', 'western_hemisphere_not_allocated', 'world', 'yemen', 'yemen_arab_rep', 'yemen_pd_rep', 'zambia', 'zimbabwe'" ), ] = None, counterpart: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( - description="Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf." + description="Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf.\nChoices for imf: 'all', 'advanced_economies', 'afghanistan', 'africa', 'africa_not_allocated', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'antilles', 'argentina', 'armenia', 'aruba', 'asia_not_allocated', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belgo-luxembourg_economic_union', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'china', 'colombia', 'community_of_independent_states', 'comoros', 'congo', 'costa_rica', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'democratic_republic_of_the_congo', 'denmark', 'developing_asia', 'djibouti', 'dominica', 'dominican_republic', 'east_germany', 'eastern_caribbean_currency_union', 'ecuador', 'egypt', 'el_salvador', 'emerging_and_developing_countries', 'emerging_and_developing_europe', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'euro_area', 'europe', 'europe_not_allocated', 'european_union', 'export_earnings_fuel', 'export_earnings_nonfuel', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'former_czechoslovakia', 'former_ussr', 'former_yugoslavia', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'honduras', 'hong_kong', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'ivory_coast', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'macao', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'middle_east', 'middle_east_and_central_asia', 'middle_east_and_central_asia_not_specified', 'middle_east_north_africa_afghanistan_and_pakistan', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_korea', 'north_macedonia', 'north_vietnam', 'norway', 'oman', 'other_countries_nie', 'pakistan', 'palau', 'palestine', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia', 'serbia_and_montenegro', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_african_common_customs_area', 'south_korea', 'south_sudan', 'spain', 'special_categories_and_economic_zones', 'sri_lanka', 'sub-saharan_africa', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'vatican_city_state', 'venezuela', 'viet_nam', 'west_malaysia', 'western_hemisphere', 'western_hemisphere_not_allocated', 'world', 'yemen', 'yemen_arab_rep', 'yemen_pd_rep', 'zambia', 'zimbabwe'" ), ] = None, direction: Annotated[ @@ -1345,10 +1347,14 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: imf. + country : Union[str, None, list[Optional[str]]] The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf. - counterpart : Union[str, None, List[Optional[str]]] + Choices for imf: 'all', 'advanced_economies', 'afghanistan', 'africa', 'africa_not_allocated', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'antilles', 'argentina', 'armenia', 'aruba', 'asia_not_allocated', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belgo-luxembourg_economic_union', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'china', 'colombia', 'community_of_independent_states', 'comoros', 'congo', 'costa_rica', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'democratic_republic_of_the_congo', 'denmark', 'developing_asia', 'djibouti', 'dominica', 'dominican_republic', 'east_germany', 'eastern_caribbean_currency_union', 'ecuador', 'egypt', 'el_salvador', 'emerging_and_developing_countries', 'emerging_and_developing_europe', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'euro_area', 'europe', 'europe_not_allocated', 'european_union', 'export_earnings_fuel', 'export_earnings_nonfuel', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'former_czechoslovakia', 'former_ussr', 'former_yugoslavia', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'honduras', 'hong_kong', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'ivory_coast', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'macao', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'middle_east', 'middle_east_and_central_asia', 'middle_east_and_central_asia_not_specified', 'middle_east_north_africa_afghanistan_and_pakistan', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_korea', 'north_macedonia', 'north_vietnam', 'norway', 'oman', 'other_countries_nie', 'pakistan', 'palau', 'palestine', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia', 'serbia_and_montenegro', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_african_common_customs_area', 'south_korea', 'south_sudan', 'spain', 'special_categories_and_economic_zones', 'sri_lanka', 'sub-saharan_africa', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'vatican_city_state', 'venezuela', 'viet_nam', 'west_malaysia', 'western_hemisphere', 'western_hemisphere_not_allocated', 'world', 'yemen', 'yemen_arab_rep', 'yemen_pd_rep', 'zambia', 'zimbabwe' + counterpart : Union[str, None, list[Optional[str]]] Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple comma separated items allowed for provider(s): imf. + Choices for imf: 'all', 'advanced_economies', 'afghanistan', 'africa', 'africa_not_allocated', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'antilles', 'argentina', 'armenia', 'aruba', 'asia_not_allocated', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belgo-luxembourg_economic_union', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'china', 'colombia', 'community_of_independent_states', 'comoros', 'congo', 'costa_rica', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'democratic_republic_of_the_congo', 'denmark', 'developing_asia', 'djibouti', 'dominica', 'dominican_republic', 'east_germany', 'eastern_caribbean_currency_union', 'ecuador', 'egypt', 'el_salvador', 'emerging_and_developing_countries', 'emerging_and_developing_europe', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'euro_area', 'europe', 'europe_not_allocated', 'european_union', 'export_earnings_fuel', 'export_earnings_nonfuel', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'former_czechoslovakia', 'former_ussr', 'former_yugoslavia', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'honduras', 'hong_kong', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'ivory_coast', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'macao', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'middle_east', 'middle_east_and_central_asia', 'middle_east_and_central_asia_not_specified', 'middle_east_north_africa_afghanistan_and_pakistan', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_korea', 'north_macedonia', 'north_vietnam', 'norway', 'oman', 'other_countries_nie', 'pakistan', 'palau', 'palestine', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia', 'serbia_and_montenegro', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_african_common_customs_area', 'south_korea', 'south_sudan', 'spain', 'special_categories_and_economic_zones', 'sri_lanka', 'sub-saharan_africa', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'vatican_city_state', 'venezuela', 'viet_nam', 'west_malaysia', 'western_hemisphere', 'western_hemisphere_not_allocated', 'world', 'yemen', 'yemen_arab_rep', 'yemen_pd_rep', 'zambia', 'zimbabwe' direction : Literal['exports', 'imports', 'balance', 'all'] Trade direction. Use 'all' to get all data for this dimension. start_date : Union[date, None, str] @@ -1357,18 +1363,16 @@ class ROUTER_economy(Container): End date of the data, in YYYY-MM-DD format. frequency : Literal['month', 'quarter', 'annual'] The frequency of the data. - provider : Optional[Literal['imf']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: imf. Returns ------- OBBject - results : List[DirectionOfTrade] + results : list[DirectionOfTrade] Serializable results. - provider : Optional[Literal['imf']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1936,7 +1940,7 @@ class ROUTER_economy(Container): def export_destinations( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="The country to get data. Multiple comma separated items allowed for provider(s): econdb." ), @@ -1953,20 +1957,20 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] - The country to get data. Multiple comma separated items allowed for provider(s): econdb. - provider : Optional[Literal['econdb']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. + country : Union[str, list[str]] + The country to get data. Multiple comma separated items allowed for provider(s): econdb. Returns ------- OBBject - results : List[ExportDestinations] + results : list[ExportDestinations] Serializable results. - provider : Optional[Literal['econdb']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2047,7 +2051,7 @@ class ROUTER_economy(Container): Parameters ---------- - provider : Optional[Literal['federal_reserve']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. year : Optional[int] The year of FOMC documents to retrieve. If None, all years since 1959 are returned. (provider: federal_reserve) @@ -2065,10 +2069,10 @@ class ROUTER_economy(Container): OBBject results : FomcDocuments Serializable results. - provider : Optional[Literal['federal_reserve']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2291,6 +2295,8 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. symbol : str Symbol to get data for. start_date : Union[date, None, str] @@ -2299,8 +2305,6 @@ class ROUTER_economy(Container): End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. is_series_group : bool When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred) region_type : Optional[Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']] @@ -2312,77 +2316,77 @@ class ROUTER_economy(Container): frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] Frequency aggregation to convert high frequency data to lower frequency. - None = No change + None = No change - a = Annual + a = Annual - q = Quarterly + q = Quarterly - m = Monthly + m = Monthly - w = Weekly + w = Weekly - d = Daily + d = Daily - wef = Weekly, Ending Friday + wef = Weekly, Ending Friday - weth = Weekly, Ending Thursday + weth = Weekly, Ending Thursday - wew = Weekly, Ending Wednesday + wew = Weekly, Ending Wednesday - wetu = Weekly, Ending Tuesday + wetu = Weekly, Ending Tuesday - wem = Weekly, Ending Monday + wem = Weekly, Ending Monday - wesu = Weekly, Ending Sunday + wesu = Weekly, Ending Sunday - wesa = Weekly, Ending Saturday + wesa = Weekly, Ending Saturday - bwew = Biweekly, Ending Wednesday + bwew = Biweekly, Ending Wednesday - bwem = Biweekly, Ending Monday - (provider: fred) + bwem = Biweekly, Ending Monday + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] A key that indicates the aggregation method used for frequency aggregation. - This parameter has no affect if the frequency parameter is not set. + This parameter has no affect if the frequency parameter is not set. - avg = Average + avg = Average - sum = Sum + sum = Sum - eop = End of Period - (provider: fred) + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] Transformation type - None = No transformation + None = No transformation - chg = Change + chg = Change - ch1 = Change from Year Ago + ch1 = Change from Year Ago - pch = Percent Change + pch = Percent Change - pc1 = Percent Change from Year Ago + pc1 = Percent Change from Year Ago - pca = Compounded Annual Rate of Change + pca = Compounded Annual Rate of Change - cch = Continuously Compounded Rate of Change + cch = Continuously Compounded Rate of Change - cca = Continuously Compounded Annual Rate of Change + cca = Continuously Compounded Annual Rate of Change - log = Natural Log - (provider: fred) + log = Natural Log + (provider: fred) Returns ------- OBBject - results : List[FredRegional] + results : list[FredRegional] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2446,7 +2450,7 @@ class ROUTER_economy(Container): ), ] = None, date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. Multiple comma separated items allowed for provider(s): fred." ), @@ -2463,24 +2467,24 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. release_id : str The ID of the release. Use `fred_search` to find releases. element_id : Optional[str] The element ID of a specific table in the release. - date : Union[date, str, None, List[Union[date, str, None]]] + date : Union[date, str, None, list[Union[date, str, None]]] A specific date to get data for. Multiple comma separated items allowed for provider(s): fred. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[FredReleaseTable] + results : list[FredReleaseTable] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2565,10 +2569,10 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. query : Optional[str] The search word(s). - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. search_type : Literal['full_text', 'series_id', 'release'] The type of search to perform. Automatically set to 'release' when a 'release_id' is provided. (provider: fred) release_id : Optional[Annotated[int, Ge(ge=0)]] @@ -2586,21 +2590,21 @@ class ROUTER_economy(Container): filter_value : Optional[str] String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'. (provider: fred) tag_names : Optional[str] - A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed. (provider: fred) + A semicolon delimited list of tag names that series match all of. Example: 'japan exclude_tag_names : Optional[str] - 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. This parameter is ignored when search_type is 'release'. Multiple comma separated items allowed. (provider: fred) + A semicolon delimited list of tag names that series match none of. Example: 'imports series_id : Optional[str] 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. (provider: fred) Returns ------- OBBject - results : List[FredSearch] + results : list[FredSearch] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2715,7 +2719,7 @@ class ROUTER_economy(Container): def fred_series( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." ), @@ -2744,7 +2748,9 @@ class ROUTER_economy(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred, intrinio. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. @@ -2752,45 +2758,43 @@ class ROUTER_economy(Container): End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fred', 'intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred, intrinio. frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] 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 - (provider: fred) + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] 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 - (provider: fred) + This parameter has no affect if the frequency parameter is not set. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] 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 - (provider: fred) + 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 + (provider: fred) all_pages : Optional[bool] Returns all pages of data from the API call at once. (provider: intrinio) sleep : Optional[float] @@ -2799,12 +2803,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[FredSeries] + results : list[FredSeries] Serializable results. - provider : Optional[Literal['fred', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2906,9 +2910,9 @@ class ROUTER_economy(Container): def house_price_index( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): oecd.\nChoices for oecd: 'G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_20', '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'" ), ] = "united_states", frequency: Annotated[ @@ -2941,8 +2945,11 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): oecd. + Choices for oecd: 'G20', 'G7', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_20', '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' frequency : Literal['monthly', 'quarter', 'annual'] The frequency of the data. transform : Literal['index', 'yoy', 'period'] @@ -2951,18 +2958,16 @@ class ROUTER_economy(Container): Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. Returns ------- OBBject - results : List[HousePriceIndex] + results : list[HousePriceIndex] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3081,9 +3086,9 @@ class ROUTER_economy(Container): def immediate_interest_rate( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): oecd.\nChoices for oecd: 'belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'" ), ] = "united_states", start_date: Annotated[ @@ -3106,26 +3111,27 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): oecd. + Choices for oecd: 'belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all' start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. frequency : Literal['monthly', 'quarter', 'annual'] The frequency of the data. (provider: oecd) Returns ------- OBBject - results : List[ImmediateInterestRate] + results : list[ImmediateInterestRate] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3237,9 +3243,9 @@ class ROUTER_economy(Container): def indicators( self, country: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( - description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb, imf." + description="The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb, imf.\nChoices for imf: 'all', 'afghanistan', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'argentina', 'armenia', 'aruba', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'hong_kong', 'macao', 'china', 'colombia', 'comoros', 'democratic_republic_of_the_congo', 'congo', 'costa_rica', 'ivory_coast', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'denmark', 'djibouti', 'dominica', 'dominican_republic', 'ecuador', 'egypt', 'el_salvador', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'vatican_city_state', 'honduras', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'north_korea', 'south_korea', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'antilles', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_macedonia', 'norway', 'oman', 'pakistan', 'palau', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia_and_montenegro', 'serbia', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_sudan', 'spain', 'sri_lanka', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'venezuela', 'viet_nam', 'palestine', 'yemen', 'zambia', 'zimbabwe', 'euro_area', 'europe', 'european_union', 'unspecified'" ), ] = None, start_date: Annotated[ @@ -3262,59 +3268,42 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, imf. + country : Union[str, None, list[Optional[str]]] The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb, imf. + Choices for imf: 'all', 'afghanistan', 'albania', 'algeria', 'american_samoa', 'angola', 'anguilla', 'antigua_and_barbuda', 'argentina', 'armenia', 'aruba', 'australia', 'austria', 'azerbaijan', 'bahamas', 'bahrain', 'bangladesh', 'barbados', 'belarus', 'belgium', 'belize', 'benin', 'bermuda', 'bhutan', 'bolivia', 'bosnia_and_herzegovina', 'botswana', 'brazil', 'brunei_darussalam', 'bulgaria', 'burkina_faso', 'burundi', 'cabo_verde', 'cambodia', 'cameroon', 'canada', 'central_african_republic', 'chad', 'chile', 'hong_kong', 'macao', 'china', 'colombia', 'comoros', 'democratic_republic_of_the_congo', 'congo', 'costa_rica', 'ivory_coast', 'croatia', 'cuba', 'curacao', 'cyprus', 'czech_republic', 'denmark', 'djibouti', 'dominica', 'dominican_republic', 'ecuador', 'egypt', 'el_salvador', 'equatorial_guinea', 'eritrea', 'estonia', 'eswatini', 'ethiopia', 'falkland_islands', 'faroe_islands', 'fiji', 'finland', 'france', 'french_polynesia', 'gabon', 'gambia', 'georgia', 'germany', 'ghana', 'gibraltar', 'greece', 'greenland', 'grenada', 'guam', 'guatemala', 'guinea', 'guyana', 'haiti', 'vatican_city_state', 'honduras', 'hungary', 'iceland', 'india', 'indonesia', 'iran', 'iraq', 'ireland', 'israel', 'italy', 'jamaica', 'japan', 'jordan', 'kazakhstan', 'kenya', 'kiribati', 'north_korea', 'south_korea', 'kosovo', 'kuwait', 'kyrgyzstan', 'lao', 'latvia', 'lebanon', 'lesotho', 'liberia', 'libya', 'lithuania', 'luxembourg', 'madagascar', 'malawi', 'malaysia', 'maldives', 'mali', 'malta', 'marshall_islands', 'mauritania', 'mauritius', 'mexico', 'micronesia', 'moldova', 'mongolia', 'montenegro', 'montserrat', 'morocco', 'mozambique', 'myanmar', 'namibia', 'nauru', 'nepal', 'antilles', 'netherlands', 'new_caledonia', 'new_zealand', 'nicaragua', 'niger', 'nigeria', 'north_macedonia', 'norway', 'oman', 'pakistan', 'palau', 'panama', 'papua_new_guinea', 'paraguay', 'peru', 'philippines', 'poland', 'portugal', 'qatar', 'romania', 'russia', 'rwanda', 'samoa', 'san_marino', 'sao_tome_and_principe', 'saudi_arabia', 'senegal', 'serbia_and_montenegro', 'serbia', 'seychelles', 'sierra_leone', 'singapore', 'sint_maarten', 'slovakia', 'slovenia', 'solomon_islands', 'somalia', 'south_africa', 'south_sudan', 'spain', 'sri_lanka', 'saint_kitts_and_nevis', 'saint_lucia', 'saint_vincent_and_the_grenadines', 'sudan', 'suriname', 'sweden', 'switzerland', 'syria', 'taiwan', 'tajikistan', 'tanzania', 'thailand', 'timor-leste', 'togo', 'tonga', 'trinidad_and_tobago', 'tunisia', 'turkey', 'turkmenistan', 'tuvalu', 'uganda', 'ukraine', 'united_arab_emirates', 'united_kingdom', 'united_states', 'uruguay', 'uzbekistan', 'vanuatu', 'venezuela', 'viet_nam', 'palestine', 'yemen', 'zambia', 'zimbabwe', 'euro_area', 'europe', 'european_union', 'unspecified' start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['econdb', 'imf']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, imf. symbol : Optional[str] - Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Use `available_indicators()` to get a list of available symbols. Multiple comma separated items allowed. (provider: econdb); - Symbol to get data for. Use `available_indicators()` to get the list of available symbols. Use 'IRFCL' to get all the data from International Reserves & Foreign Currency Liquidity indicators. Use 'core_fsi' to get the core Financial Soundness Indicators. Use 'core_fsi_underlying' to include underlying data for the core Financial Soundness Indicators. Complete tables are available only by single country, and are keyed as described below. The default is 'irfcl_top_lines'. Available presets not listed in `available_indicators()` are: - - 'IRFCL': All the data from the set of indicators. Not compatible with multiple countries. - 'irfcl_top_lines': The default, top line items from the IRFCL data. Compatible with multiple countries. - 'reserve_assets_and_other_fx_assets': Table I of the IRFCL data. Not compatible with multiple countries. - 'predetermined_drains_on_fx_assets': Table II of the IRFCL data. Not compatible with multiple countries. - 'contingent_drains_fx_assets': Table III of the IRFCL data. Not compatible with multiple countries. - 'memorandum_items': The memorandum items table of the IRFCL data. Not compatible with multiple countries. - 'gold_reserves': Gold reserves as value in USD and Fine Troy Ounces. Compatible with multiple countries. - 'derivative_assets': Net derivative assets as value in USD. Compatible with multipile countries. - 'fsi_core': The core Financial Soundness Indicators. Compatible with multiple countries. - 'fsi_core_underlying': The core FSIs underlying series data. Not compatible with country='all'. - 'fsi_encouraged_set': The encouraged set of Financial Soundness Indicators. Not compatible with country='all'. - 'fsi_other': The other Financial Soundness Indicators. Not compatible with country='all'. - 'fsi_balance_sheets': Data categorized as Balance Sheets and Income Statements. Not compatible with country='all'. - 'fsi_all': All the Financial Soundness Indicators. Not compatible with multiple countries. - Multiple comma separated items allowed. (provider: imf) + Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Use `available_indicators()` to get a list of available symbols. Multiple comma separated items allowed. (provider: econdb) transform : Optional[Literal['toya', 'tpop', 'tusd', 'tpgp']] 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 + 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. (provider: econdb) + 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. (provider: econdb) frequency : Literal['annual', 'quarter', 'month'] - The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb); - Frequency of the data, default is 'quarter'. (provider: imf) + The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb) use_cache : bool If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb) Returns ------- OBBject - results : List[EconomicIndicators] + results : list[EconomicIndicators] Serializable results. - provider : Optional[Literal['econdb', 'imf']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3630,9 +3619,9 @@ class ROUTER_economy(Container): def interest_rates( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): oecd.\nChoices for oecd: 'belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'" ), ] = "united_states", start_date: Annotated[ @@ -3657,14 +3646,15 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): oecd. + Choices for oecd: 'belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all' start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. duration : Literal['immediate', 'short', 'long'] Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate. (provider: oecd) frequency : Literal['monthly', 'quarter', 'annual'] @@ -3673,12 +3663,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[CountryInterestRates] + results : list[CountryInterestRates] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3830,12 +3820,12 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. country : Literal['belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] Country to get interest rate for. (provider: oecd) frequency : Literal['monthly', 'quarterly', 'annual'] @@ -3844,12 +3834,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[LTIR] + results : list[LTIR] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3927,24 +3917,24 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. adjusted : Optional[bool] Whether to return seasonally adjusted data. - provider : Optional[Literal['federal_reserve']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. Returns ------- OBBject - results : List[MoneyMeasures] + results : list[MoneyMeasures] Serializable results. - provider : Optional[Literal['federal_reserve']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4000,7 +3990,7 @@ class ROUTER_economy(Container): def pce( self, date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred." ), @@ -4017,22 +4007,22 @@ class ROUTER_economy(Container): Parameters ---------- - date : Union[date, str, None, List[Union[date, str, None]]] - A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred. - provider : Optional[Literal['fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. + date : Union[date, str, None, list[Union[date, str, None]]] + A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred. category : Literal['personal_income', 'wages_by_industry', 'real_pce_percent_change', 'real_pce_quantity_index', 'pce_price_index', 'pce_dollars', 'real_pce_chained_dollars', 'pce_price_percent_change'] The category to query. (provider: fred) Returns ------- OBBject - results : List[PersonalConsumptionExpenditures] + results : list[PersonalConsumptionExpenditures] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4111,22 +4101,22 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['econdb']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb. Returns ------- OBBject - results : List[PortVolume] + results : list[PortVolume] Serializable results. - provider : Optional[Literal['econdb']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4212,12 +4202,12 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. asset_class : Literal['all', 'treasuries', 'tips', 'agency', 'mbs', 'corporate'] Asset class to return, default is 'all'. (provider: federal_reserve) unit : Literal['value', 'percent'] @@ -4226,12 +4216,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[PrimaryDealerFails] + results : list[PrimaryDealerFails] Serializable results. - provider : Optional[Literal['federal_reserve']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4319,24 +4309,24 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve. category : Literal['treasuries', 'bills', 'coupons', 'notes', 'tips', 'mbs', 'cmbs', 'municipal', 'corporate', 'commercial_paper', 'corporate_ig', 'corporate_junk', 'abs'] The category of asset to return, defaults to 'treasuries'. (provider: federal_reserve) Returns ------- OBBject - results : List[PrimaryDealerPositioning] + results : list[PrimaryDealerPositioning] Serializable results. - provider : Optional[Literal['federal_reserve']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4386,10 +4376,15 @@ class ROUTER_economy(Container): self, item: Annotated[ Optional[str], - OpenBBField(description="The item or basket of items to query."), + OpenBBField( + description="The item or basket of items to query.\nChoices for fred: 'beverages', 'cereals', 'dairy', 'fuel', 'meats', 'produce', 'bacon', 'bananas', 'beans', 'beef', 'beer', 'bread', 'butter', 'cheese', 'chicken', 'chops', 'coffee', 'cookies', 'corn', 'diesel', 'eggs', 'electricity', 'flour', 'gas', 'gasoline', 'grapefruit', 'groud_beef', 'ham', 'ice_cream', 'lemons', 'lettuce', 'malt_beverages', 'milk', 'oil', 'orange_juice', 'oranges', 'potato_chips', 'potatoes', 'pork', 'rice', 'soft_drinks', 'spaghetti', 'steak', 'strawberries', 'sugar', 'tomatoes', 'unleaded', 'usda', 'vodka', 'wine', 'yogurt'" + ), ] = None, country: Annotated[ - str, OpenBBField(description="The country to get data.") + str, + OpenBBField( + description="The country to get data.\nChoices for fred: 'united_states'" + ), ] = "united_states", start_date: Annotated[ Union[datetime.date, None, str], @@ -4411,43 +4406,45 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. item : Optional[str] The item or basket of items to query. + Choices for fred: 'beverages', 'cereals', 'dairy', 'fuel', 'meats', 'produce', 'bacon', 'bananas', 'beans', 'beef', 'beer', 'bread', 'butter', 'cheese', 'chicken', 'chops', 'coffee', 'cookies', 'corn', 'diesel', 'eggs', 'electricity', 'flour', 'gas', 'gasoline', 'grapefruit', 'groud_beef', 'ham', 'ice_cream', 'lemons', 'lettuce', 'malt_beverages', 'milk', 'oil', 'orange_juice', 'oranges', 'potato_chips', 'potatoes', 'pork', 'rice', 'soft_drinks', 'spaghetti', 'steak', 'strawberries', 'sugar', 'tomatoes', 'unleaded', 'usda', 'vodka', 'wine', 'yogurt' country : str The country to get data. + Choices for fred: 'united_states' start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. region : Literal['all_city', 'northeast', 'midwest', 'south', 'west'] The region to get average price levels for. (provider: fred) frequency : Literal['annual', 'quarter', 'monthly'] The frequency of the data. (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[RetailPrices] + results : list[RetailPrices] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4578,18 +4575,18 @@ class ROUTER_economy(Container): Parameters ---------- - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[RiskPremium] + results : list[RiskPremium] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4632,9 +4629,9 @@ class ROUTER_economy(Container): def share_price_index( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): oecd.\nChoices for oecd: 'G20', 'G7', 'all', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'euro_area_20', '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'" ), ] = "united_states", frequency: Annotated[ @@ -4661,26 +4658,27 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): oecd. + Choices for oecd: 'G20', 'G7', 'all', 'argentina', 'australia', 'austria', 'belgium', 'brazil', 'bulgaria', 'canada', 'chile', 'china', 'colombia', 'costa_rica', 'croatia', 'czech_republic', 'denmark', 'estonia', 'euro_area_19', 'euro_area_20', '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' frequency : Literal['monthly', 'quarter', 'annual'] The frequency of the data. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. Returns ------- OBBject - results : List[SharePriceIndex] + results : list[SharePriceIndex] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4825,12 +4823,12 @@ class ROUTER_economy(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. country : Literal['belgium', 'bulgaria', 'brazil', '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', 'romania', 'russia', 'euro_area19', 'colombia', 'italy', 'india', 'china', 'croatia', 'all'] Country to get interest rate for. (provider: oecd) frequency : Literal['monthly', 'quarterly', 'annual'] @@ -4839,12 +4837,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[STIR] + results : list[STIR] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4903,9 +4901,9 @@ class ROUTER_economy(Container): def unemployment( self, country: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="The country to get data. Multiple comma separated items allowed for provider(s): oecd." + description="The country to get data. Multiple comma separated items allowed for provider(s): oecd.\nChoices for oecd: 'all', 'australia', 'austria', 'belgium', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area20', 'european_union27_2020', 'finland', 'france', 'g7', 'germany', 'greece', 'hungary', 'iceland', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd', 'poland', 'portugal', 'russia', 'slovakia', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states'" ), ] = "united_states", frequency: Annotated[ @@ -4932,16 +4930,17 @@ class ROUTER_economy(Container): Parameters ---------- - country : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + country : Union[str, list[str]] The country to get data. Multiple comma separated items allowed for provider(s): oecd. + Choices for oecd: 'all', 'australia', 'austria', 'belgium', 'canada', 'chile', 'colombia', 'costa_rica', 'czech_republic', 'denmark', 'estonia', 'euro_area20', 'european_union27_2020', 'finland', 'france', 'g7', 'germany', 'greece', 'hungary', 'iceland', 'ireland', 'israel', 'italy', 'japan', 'korea', 'latvia', 'lithuania', 'luxembourg', 'mexico', 'netherlands', 'new_zealand', 'norway', 'oecd', 'poland', 'portugal', 'russia', 'slovakia', 'slovenia', 'south_africa', 'spain', 'sweden', 'switzerland', 'turkey', 'united_kingdom', 'united_states' frequency : Literal['monthly', 'quarter', 'annual'] The frequency of the data. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. sex : Literal['total', 'male', 'female'] Sex to get unemployment for. (provider: oecd) age : Literal['total', '15-24', '25+'] @@ -4952,12 +4951,12 @@ class ROUTER_economy(Container): Returns ------- OBBject - results : List[Unemployment] + results : list[Unemployment] Serializable results. - provider : Optional[Literal['oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/economy_gdp.py b/openbb_platform/openbb/package/economy_gdp.py index d0092c89563..2a1b2684e66 100644 --- a/openbb_platform/openbb/package/economy_gdp.py +++ b/openbb_platform/openbb/package/economy_gdp.py @@ -43,50 +43,51 @@ class ROUTER_economy_gdp(Container): ) -> OBBject: """Get Forecasted GDP Data. - Parameters - ---------- - start_date : Union[date, None, str] - Start date of the data, in YYYY-MM-DD format. - end_date : Union[date, None, str] - End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. - country : str - Country, or countries, to get forward GDP projections for. Default is all. Multiple comma separated items allowed. (provider: oecd) - frequency : Literal['annual', 'quarter'] - Frequency of the data, default is annual. (provider: oecd) - units : Literal['current_prices', 'volume', 'capita', 'growth', 'deflator'] - Units of the data, default is volume (chain linked volume, 2015). - 'current_prices', 'volume', and 'capita' are expressed in USD; 'growth' as a percent; 'deflator' as an index. (provider: oecd) + Parameters + ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd. + start_date : Union[date, None, str] + Start date of the data, in YYYY-MM-DD format. + end_date : Union[date, None, str] + End date of the data, in YYYY-MM-DD format. + country : str + Country, or countries, to get forward GDP projections for. Default is all. Multiple comma separated items allowed. (provider: oecd) + frequency : Literal['annual', 'quarter'] + Frequency of the data, default is annual. (provider: oecd) + units : Literal['current_prices', 'volume', 'capita', 'growth', 'deflator'] + Units of the data, default is volume (chain linked volume, 2015). + 'current_prices', 'volume', and 'capita' are expressed in USD; + 'deflator' as an index. (provider: oecd) - Returns - ------- - OBBject - results : List[GdpForecast] - Serializable results. - provider : Optional[Literal['oecd']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. + Returns + ------- + OBBject + results : list[GdpForecast] + Serializable results. + provider : Optional[str] + Provider name. + warnings : Optional[list[Warning_]] + list of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. - GdpForecast - ----------- - date : date - The date of the data. - country : str - None - value : Union[int, float] - Forecasted GDP value for the country and date. + GdpForecast + ----------- + date : date + The date of the data. + country : str + None + value : Union[int, float] + Forecasted GDP value for the country and date. - Examples - -------- - >>> from openbb import obb - >>> obb.economy.gdp.forecast(provider='oecd') - >>> obb.economy.gdp.forecast(country='united_states,germany,france', frequency='annual', units='capita', provider='oecd') + Examples + -------- + >>> from openbb import obb + >>> obb.economy.gdp.forecast(provider='oecd') + >>> obb.economy.gdp.forecast(country='united_states,germany,france', frequency='annual', units='capita', provider='oecd') """ # noqa: E501 return self._run( @@ -194,12 +195,12 @@ class ROUTER_economy_gdp(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, oecd. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['econdb', 'oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, oecd. country : str The country to get data.Use 'all' to get data for all available countries. Multiple comma separated items allowed. (provider: econdb, oecd) use_cache : bool @@ -214,12 +215,12 @@ class ROUTER_economy_gdp(Container): Returns ------- OBBject - results : List[GdpNominal] + results : list[GdpNominal] Serializable results. - provider : Optional[Literal['econdb', 'oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -355,12 +356,12 @@ class ROUTER_economy_gdp(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, oecd. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['econdb', 'oecd']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, oecd. country : str The country to get data.Use 'all' to get data for all available countries. Multiple comma separated items allowed. (provider: econdb, oecd) use_cache : bool @@ -371,12 +372,12 @@ class ROUTER_economy_gdp(Container): Returns ------- OBBject - results : List[GdpReal] + results : list[GdpReal] Serializable results. - provider : Optional[Literal['econdb', 'oecd']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/economy_survey.py b/openbb_platform/openbb/package/economy_survey.py index 5d8b06b09ff..ca90b1df6ee 100644 --- a/openbb_platform/openbb/package/economy_survey.py +++ b/openbb_platform/openbb/package/economy_survey.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -45,76 +45,77 @@ class ROUTER_economy_survey(Container): ) -> OBBject: """Search BLS surveys by category and keyword or phrase to identify BLS series IDs. - Parameters - ---------- - query : str - The search word(s). Use semi-colon to separate multiple queries as an & operator. - provider : Optional[Literal['bls']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: bls. - category : Optional[Literal['cpi', 'pce', 'ppi', 'ip', 'jolts', 'nfp', 'cps', 'lfs', 'wages', 'ec', 'sla', 'bed', 'tu']] - The category of BLS survey to search within. - An empty search query will return all series within the category. Options are: + Parameters + ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: bls. + query : str + The search word(s). Use semi-colon to separate multiple queries as an & operator. + category : Optional[Literal['cpi', 'pce', 'ppi', 'ip', 'jolts', 'nfp', 'cps', 'lfs', 'wages', 'ec', 'sla', 'bed', 'tu']] + The category of BLS survey to search within. + An empty search query will return all series within the category. Options are: - cpi - Consumer Price Index + cpi - Consumer Price Index - pce - Personal Consumption Expenditure + pce - Personal Consumption Expenditure - ppi - Producer Price Index + ppi - Producer Price Index - ip - Industry Productivity + ip - Industry Productivity - jolts - Job Openings and Labor Turnover Survey + jolts - Job Openings and Labor Turnover Survey - nfp - Nonfarm Payrolls + nfp - Nonfarm Payrolls - cps - Current Population Survey + cps - Current Population Survey - lfs - Labor Force Statistics + lfs - Labor Force Statistics - wages - Wages + wages - Wages - ec - Employer Costs + ec - Employer Costs - sla - State and Local Area Employment + sla - State and Local Area Employment - bed - Business Employment Dynamics + bed - Business Employment Dynamics - tu - Time Use - (provider: bls) - include_extras : bool - Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'. (provider: bls) - include_code_map : bool - When True, includes the complete code map for eaçh survey in the category, returned separately as a nested JSON to the `extras['results_metadata']` property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series. (provider: bls) + tu - Time Use + (provider: bls) + Choices for bls: 'cpi', 'pce', 'ppi', 'ip', 'jolts', 'nfp', 'cps', 'lfs', 'wages', 'ec', 'sla', 'bed', 'tu' + include_extras : bool + Include additional information in the search results. Extra fields returned are metadata and vary by survey. Fields are undefined strings that typically have names ending with '_code'. (provider: bls) + include_code_map : bool + When True, includes the complete code map for eaçh survey in the category, returned separately as a nested JSON to the `extras['results_metadata']` property of the response. Example content is the NAICS industry map for PPI surveys. Each code is a value within the 'symbol' of the time series. (provider: bls) - Returns - ------- - OBBject - results : List[BlsSearch] - Serializable results. - provider : Optional[Literal['bls']] - Provider name. - warnings : Optional[List[Warning_]] - List of warnings. - chart : Optional[Chart] - Chart object. - extra : Dict[str, Any] - Extra info. + Returns + ------- + OBBject + results : list[BlsSearch] + Serializable results. + provider : Optional[str] + Provider name. + warnings : Optional[list[Warning_]] + list of warnings. + chart : Optional[Chart] + Chart object. + extra : Dict[str, Any] + Extra info. - BlsSearch - --------- - symbol : str - Symbol representing the entity requested in the data. - title : Optional[str] - The title of the series. - survey_name : Optional[str] - The name of the survey. + BlsSearch + --------- + symbol : str + Symbol representing the entity requested in the data. + title : Optional[str] + The title of the series. + survey_name : Optional[str] + The name of the survey. - Examples - -------- - >>> from openbb import obb - >>> obb.economy.survey.bls_search(provider='bls', category='cpi') - >>> # Use semi-colon to separate multiple queries as an & operator. - >>> obb.economy.survey.bls_search(provider='bls', category='cpi', query='seattle;gasoline') + Examples + -------- + >>> from openbb import obb + >>> obb.economy.survey.bls_search(provider='bls', category='cpi') + >>> # Use semi-colon to separate multiple queries as an & operator. + >>> obb.economy.survey.bls_search(provider='bls', category='cpi', query='seattle;gasoline') """ # noqa: E501 return self._run( @@ -161,7 +162,7 @@ class ROUTER_economy_survey(Container): def bls_series( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): bls." ), @@ -186,14 +187,14 @@ class ROUTER_economy_survey(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: bls. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): bls. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['bls']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: bls. calculations : bool Include calculations in the response, if available. Default is True. (provider: bls) annual_average : bool @@ -204,12 +205,12 @@ class ROUTER_economy_survey(Container): Returns ------- OBBject - results : List[BlsSeries] + results : list[BlsSeries] Serializable results. - provider : Optional[Literal['bls']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -298,54 +299,54 @@ class ROUTER_economy_survey(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. frequency : Optional[Literal['annual', 'quarter']] Frequency aggregation to convert monthly data to lower frequency. None is monthly. (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] A key that indicates the aggregation method used for frequency aggregation. - avg = Average + avg = Average - sum = Sum + sum = Sum - eop = End of Period - (provider: fred) + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] Transformation type - None = No transformation + None = No transformation - chg = Change + chg = Change - ch1 = Change from Year Ago + ch1 = Change from Year Ago - pch = Percent Change + pch = Percent Change - pc1 = Percent Change from Year Ago + pc1 = Percent Change from Year Ago - pca = Compounded Annual Rate of Change + pca = Compounded Annual Rate of Change - cch = Continuously Compounded Rate of Change + cch = Continuously Compounded Rate of Change - cca = Continuously Compounded Annual Rate of Change + cca = Continuously Compounded Annual Rate of Change - log = Natural Log - (provider: fred) + log = Natural Log + (provider: fred) Returns ------- OBBject - results : List[SurveyOfEconomicConditionsChicago] + results : list[SurveyOfEconomicConditionsChicago] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -422,48 +423,48 @@ class ROUTER_economy_survey(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. topic : Union[Literal['business_activity', 'business_outlook', 'capex', 'prices_paid', 'production', 'inventory', 'new_orders', 'new_orders_growth', 'unfilled_orders', 'shipments', 'delivery_time', 'employment', 'wages', 'hours_worked'], str] The topic for the survey response. Multiple comma separated items allowed. (provider: fred) frequency : Optional[Literal['annual', 'quarter']] - Frequency aggregation to convert monthly data to lower frequency. None is monthly. - (provider: fred) + Frequency aggregation to convert monthly data to lower frequency. None is monthly. + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[ManufacturingOutlookTexas] + results : list[ManufacturingOutlookTexas] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -537,7 +538,7 @@ class ROUTER_economy_survey(Container): def nonfarm_payrolls( self, date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred." ), @@ -554,22 +555,22 @@ class ROUTER_economy_survey(Container): Parameters ---------- - date : Union[date, str, None, List[Union[date, str, None]]] - A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred. - provider : Optional[Literal['fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. + date : Union[date, str, None, list[Union[date, str, None]]] + A specific date to get data for. Default is the latest report. Multiple comma separated items allowed for provider(s): fred. category : Literal['employees_nsa', 'employees_sa', 'employees_production_and_nonsupervisory', 'employees_women', 'employees_women_percent', 'avg_hours', 'avg_hours_production_and_nonsupervisory', 'avg_hours_overtime', 'avg_hours_overtime_production_and_nonsupervisory', 'avg_earnings_hourly', 'avg_earnings_hourly_production_and_nonsupervisory', 'avg_earnings_weekly', 'avg_earnings_weekly_production_and_nonsupervisory', 'index_weekly_hours', 'index_weekly_hours_production_and_nonsupervisory', 'index_weekly_payrolls', 'index_weekly_payrolls_production_and_nonsupervisory'] The category to query. (provider: fred) Returns ------- OBBject - results : List[NonFarmPayrolls] + results : list[NonFarmPayrolls] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -645,37 +646,37 @@ class ROUTER_economy_survey(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. category : Literal['spreads', 'consumer', 'auto', 'credit_card', 'firms', 'mortgage', 'commercial_real_estate', 'standards', 'demand', 'foreign_banks'] Category of survey response. (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[SeniorLoanOfficerSurvey] + results : list[SeniorLoanOfficerSurvey] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -741,54 +742,54 @@ class ROUTER_economy_survey(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. frequency : Optional[Literal['annual', 'quarter']] Frequency aggregation to convert monthly data to lower frequency. None is monthly. (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] A key that indicates the aggregation method used for frequency aggregation. - avg = Average + avg = Average - sum = Sum + sum = Sum - eop = End of Period - (provider: fred) + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] Transformation type - None = No transformation + None = No transformation - chg = Change + chg = Change - ch1 = Change from Year Ago + ch1 = Change from Year Ago - pch = Percent Change + pch = Percent Change - pc1 = Percent Change from Year Ago + pc1 = Percent Change from Year Ago - pca = Compounded Annual Rate of Change + pca = Compounded Annual Rate of Change - cch = Continuously Compounded Rate of Change + cch = Continuously Compounded Rate of Change - cca = Continuously Compounded Annual Rate of Change + cca = Continuously Compounded Annual Rate of Change - log = Natural Log - (provider: fred) + log = Natural Log + (provider: fred) Returns ------- OBBject - results : List[UniversityOfMichigan] + results : list[UniversityOfMichigan] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity.py b/openbb_platform/openbb/package/equity.py index 54d65e90067..d57823c7503 100644 --- a/openbb_platform/openbb/package/equity.py +++ b/openbb_platform/openbb/package/equity.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -79,7 +79,7 @@ class ROUTER_equity(Container): def historical_market_cap( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." ), @@ -104,26 +104,26 @@ class ROUTER_equity(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. interval : Literal['day', 'week', 'month', 'quarter', 'year'] None Returns ------- OBBject - results : List[HistoricalMarketCap] + results : list[HistoricalMarketCap] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -191,22 +191,22 @@ class ROUTER_equity(Container): Parameters ---------- - provider : Optional[Literal['fmp', 'intrinio', 'polygon']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon. market : 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'] The market to fetch data for. (provider: fmp) - date : Optional[Union[datetime.date, datetime.datetime, str]] + date : Union[date, datetime, str, None] 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' (provider: intrinio) Returns ------- OBBject - results : List[MarketSnapshots] + results : list[MarketSnapshots] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -306,7 +306,7 @@ class ROUTER_equity(Container): The last trade price. (provider: polygon) last_trade_size : Optional[int] The last trade size. (provider: polygon) - last_trade_conditions : Optional[List[int]] + last_trade_conditions : Optional[list[int]] The last trade condition codes. (provider: polygon) last_trade_exchange : Optional[int] The last trade exchange ID code. (provider: polygon) @@ -418,7 +418,7 @@ class ROUTER_equity(Container): def profile( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), @@ -435,20 +435,20 @@ class ROUTER_equity(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. Returns ------- OBBject - results : List[EquityInfo] + results : list[EquityInfo] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -627,7 +627,7 @@ class ROUTER_equity(Container): Parameters ---------- - provider : Optional[Literal['fmp', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance. mktcap_min : Optional[int] Filter by market cap greater than this value. (provider: fmp, yfinance) @@ -653,28 +653,26 @@ class ROUTER_equity(Container): If true, returns only ETFs. (provider: fmp) is_active : Optional[bool] If false, returns only inactive tickers. (provider: fmp) - sector : Optional[Union[Literal['consumer_cyclical', 'energy', 'technology', 'industrials', 'financial_services', 'basic_materials', 'communication_services', 'consumer_defensive', 'healthcare', 'real_estate', 'utilities', 'industrial_goods', 'financial', 'services'], Literal['basic_materials', 'communication_services', 'consumer_cyclical', 'consumer_defensive', 'energy', 'financial_services', 'healthcare', 'industrials', 'real_estate', 'technology', 'utilities']]] + sector : str Filter by sector. (provider: fmp, yfinance) industry : Optional[str] Filter by industry. (provider: fmp, yfinance) country : Optional[str] - Filter by country, as a two-letter country code. (provider: fmp); - Filter by country, as a two-letter country code. Default is, 'us'. Use, 'all', for all countries. (provider: yfinance) - exchange : Optional[Union[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'], Literal['ams', 'aqs', 'ase', 'asx', 'ath', 'ber', 'bru', 'bse', 'bts', 'bud', 'bue', 'bvb', 'bvc', 'ccs', 'cnq', 'cph', 'cxe', 'dfm', 'doh', 'dus', 'ebs', 'fka', 'fra', 'ger', 'ham', 'han', 'hel', 'hkg', 'ice', 'iob', 'ise', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'kuw', 'lis', 'lit', 'lse', 'mce', 'mex', 'mil', 'mun', 'ncm', 'neo', 'ngm', 'nms', 'nsi', 'nyq', 'nze', 'oem', 'oqb', 'oqx', 'osl', 'par', 'pnk', 'pra', 'ris', 'sau', 'ses', 'set', 'sgo', 'shh', 'shz', 'sto', 'stu', 'tai', 'tal', 'tlv', 'tor', 'two', 'van', 'vie', 'vse', 'wse']]] + Filter by country, as a two-letter country code. (provider: fmp) + exchange : str Filter by exchange. (provider: fmp, yfinance) limit : Optional[int] - Limit the number of results to return. (provider: fmp); - Limit the number of results returned. Default is, 200. Set to, 0, for all results. (provider: yfinance) + Limit the number of results to return. (provider: fmp) Returns ------- OBBject - results : List[EquityScreener] + results : list[EquityScreener] Serializable results. - provider : Optional[Literal['fmp', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1188,12 +1186,12 @@ class ROUTER_equity(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, sec. query : str Search query. is_symbol : bool Whether to search by ticker symbol. - provider : Optional[Literal['intrinio', 'sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio, sec. active : bool 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. (provider: intrinio) limit : Optional[int] @@ -1206,12 +1204,12 @@ class ROUTER_equity(Container): Returns ------- OBBject - results : List[EquitySearch] + results : list[EquitySearch] Serializable results. - provider : Optional[Literal['intrinio', 'sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_calendar.py b/openbb_platform/openbb/package/equity_calendar.py index afba3f0425b..14e4e713f1c 100644 --- a/openbb_platform/openbb/package/equity_calendar.py +++ b/openbb_platform/openbb/package/equity_calendar.py @@ -47,22 +47,22 @@ class ROUTER_equity_calendar(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[CalendarDividend] + results : list[CalendarDividend] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -137,22 +137,22 @@ class ROUTER_equity_calendar(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[CalendarEarnings] + results : list[CalendarEarnings] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -233,22 +233,22 @@ class ROUTER_equity_calendar(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[CalendarEvents] + results : list[CalendarEvents] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -330,6 +330,8 @@ class ROUTER_equity_calendar(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. symbol : Optional[str] Symbol to get data for. start_date : Union[date, None, str] @@ -338,8 +340,6 @@ class ROUTER_equity_calendar(Container): End date of the data, in YYYY-MM-DD format. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. status : Optional[Literal['upcoming', 'priced', 'withdrawn']] Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio) min_value : Optional[int] @@ -350,12 +350,12 @@ class ROUTER_equity_calendar(Container): Returns ------- OBBject - results : List[CalendarIpo] + results : list[CalendarIpo] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -460,22 +460,22 @@ class ROUTER_equity_calendar(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[CalendarSplits] + results : list[CalendarSplits] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_compare.py b/openbb_platform/openbb/package/equity_compare.py index fd87c114157..5ab3c5a50ce 100644 --- a/openbb_platform/openbb/package/equity_compare.py +++ b/openbb_platform/openbb/package/equity_compare.py @@ -1,6 +1,6 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -24,7 +24,7 @@ class ROUTER_equity_compare(Container): def company_facts( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): sec." ), @@ -32,7 +32,7 @@ class ROUTER_equity_compare(Container): fact: Annotated[ str, OpenBBField( - description="The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider." + description="The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.\nChoices for sec: 'AccountsPayableCurrent', 'AccountsReceivableNet', 'AccountsReceivableNetCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent', 'AccruedIncomeTaxesCurrent', 'AccruedIncomeTaxesNoncurrent', 'AccruedInsuranceCurrent', 'AccruedLiabilitiesCurrent', 'AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 'AccumulatedOtherComprehensiveIncomeLossNetOfTax', 'AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets', 'AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue', 'AdvertisingExpense', 'AllocatedShareBasedCompensationExpense', 'AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount', 'AssetImpairmentCharges', 'Assets', 'AssetsCurrent', 'AssetsNoncurrent', 'BuildingsAndImprovementsGross', 'CapitalLeaseObligationsCurrent', 'CapitalLeaseObligationsNoncurrent', 'Cash', 'CashAndCashEquivalentsAtCarryingValue', 'CashCashEquivalentsAndShortTermInvestments', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect', 'CommercialPaper', 'CommitmentsAndContingencies', 'CommonStockDividendsPerShareCashPaid', 'CommonStockDividendsPerShareDeclared', 'CommonStocksIncludingAdditionalPaidInCapital', 'ComprehensiveIncomeNetOfTax', 'ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest', 'ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest', 'ConstructionInProgressGross', 'ContractWithCustomerAssetNet', 'ContractWithCustomerLiability', 'ContractWithCustomerLiabilityCurrent', 'ContractWithCustomerLiabilityNoncurrent', 'CostOfGoodsAndServicesSold', 'CostOfRevenue', 'CurrentFederalTaxExpenseBenefit', 'CurrentForeignTaxExpenseBenefit', 'CurrentIncomeTaxExpenseBenefit', 'CurrentStateAndLocalTaxExpenseBenefit', 'DebtInstrumentFaceAmount', 'DebtInstrumentFairValue', 'DebtLongtermAndShorttermCombinedAmount', 'DeferredFederalIncomeTaxExpenseBenefit', 'DeferredForeignIncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'DeferredIncomeTaxLiabilities', 'DeferredIncomeTaxLiabilitiesNet', 'DeferredIncomeTaxesAndTaxCredits', 'DeferredRevenue', 'DeferredTaxAssetsGross', 'DeferredTaxAssetsLiabilitiesNet', 'DeferredTaxAssetsNet', 'DeferredTaxLiabilities', 'DefinedContributionPlanCostRecognized', 'Depreciation', 'DepreciationAmortizationAndAccretionNet', 'DepreciationAmortizationAndOther', 'DepreciationAndAmortization', 'DepreciationDepletionAndAmortization', 'DerivativeCollateralObligationToReturnCash', 'DerivativeCollateralRightToReclaimCash', 'DerivativeFairValueOfDerivativeNet', 'DerivativeLiabilityCollateralRightToReclaimCashOffset', 'DerivativeNotionalAmount', 'DistributedEarnings', 'Dividends', 'DividendsCash', 'DividendsPayableAmountPerShare', 'DividendsPayableCurrent', 'EarningsPerShareBasic', 'EarningsPerShareDiluted', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'EmployeeRelatedLiabilitiesCurrent', 'EmployeeRelatedLiabilitiesCurrentAndNoncurrent', 'EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense', 'FinanceLeaseInterestExpense', 'FinanceLeaseInterestPaymentOnLiability', 'FinanceLeaseLiability', 'FinanceLeaseLiabilityCurrent', 'FinanceLeaseLiabilityNoncurrent', 'FinanceLeaseLiabilityPaymentsDue', 'FinanceLeaseLiabilityPaymentsDueAfterYearFive', 'FinanceLeaseLiabilityPaymentsDueNextTwelveMonths', 'FinanceLeaseLiabilityPaymentsDueYearFive', 'FinanceLeaseLiabilityPaymentsDueYearFour', 'FinanceLeaseLiabilityPaymentsDueYearThree', 'FinanceLeaseLiabilityPaymentsDueYearTwo', 'FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear', 'FinanceLeaseLiabilityUndiscountedExcessAmount', 'FinanceLeasePrincipalPayments', 'FinanceLeaseRightOfUseAsset', 'FinancingReceivableAllowanceForCreditLosses', 'FiniteLivedIntangibleAssetsNet', 'FixturesAndEquipmentGross', 'GainLossOnInvestments', 'GainLossOnInvestmentsAndDerivativeInstruments', 'GainLossOnSaleOfBusiness', 'GainsLossesOnExtinguishmentOfDebt', 'GeneralAndAdministrativeExpense', 'Goodwill', 'GrossProfit', 'ImpairmentOfIntangibleAssetsExcludingGoodwill', 'ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill', 'IncomeLossFromContinuingOperations', 'IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 'IncomeLossFromContinuingOperationsPerBasicShare', 'IncomeLossFromContinuingOperationsPerDilutedShare', 'IncomeTaxExpenseBenefit', 'IncomeTaxesPaid', 'IncomeTaxesPaidNet', 'IncreaseDecreaseInAccountsAndOtherReceivables', 'IncreaseDecreaseInAccountsPayable', 'IncreaseDecreaseInAccountsReceivable', 'IncreaseDecreaseInAccruedIncomeTaxesPayable', 'IncreaseDecreaseInAccruedLiabilities', 'IncreaseDecreaseInAccruedTaxesPayable', 'IncreaseDecreaseInContractWithCustomerLiability', 'IncreaseDecreaseInDeferredIncomeTaxes', 'IncreaseDecreaseInInventories', 'IncreaseDecreaseInOtherCurrentAssets', 'IncreaseDecreaseInOtherCurrentLiabilities', 'IncreaseDecreaseInOtherNoncurrentAssets', 'IncreaseDecreaseInOtherNoncurrentLiabilities', 'IncreaseDecreaseInPensionPlanObligations', 'IncrementalCommonSharesAttributableToShareBasedPaymentArrangements', 'InterestAndDebtExpense', 'InterestExpenseDebt', 'InterestIncomeExpenseNet', 'InterestPaid', 'InterestPaidNet', 'InventoryNet', 'InvestmentIncomeInterest', 'Land', 'LeaseAndRentalExpense', 'LesseeOperatingLeaseLiabilityPaymentsDue', 'LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFour', 'LesseeOperatingLeaseLiabilityPaymentsDueYearThree', 'LesseeOperatingLeaseLiabilityPaymentsDueYearTwo', 'LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear', 'LettersOfCreditOutstandingAmount', 'Liabilities', 'LiabilitiesAndStockholdersEquity', 'LiabilitiesCurrent', 'LineOfCredit', 'LineOfCreditFacilityMaximumBorrowingCapacity', 'LongTermDebt', 'LongTermDebtCurrent', 'LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo', 'LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear', 'LongTermDebtNoncurrent', 'LongTermInvestments', 'LossContingencyEstimateOfPossibleLoss', 'MachineryAndEquipmentGross', 'MarketableSecuritiesCurrent', 'MarketableSecuritiesNoncurrent', 'MinorityInterest', 'NetCashProvidedByUsedInFinancingActivities', 'NetCashProvidedByUsedInInvestingActivities', 'NetCashProvidedByUsedInOperatingActivities', 'NetIncomeLoss', 'NetIncomeLossAttributableToNoncontrollingInterest', 'NetIncomeLossAttributableToNonredeemableNoncontrollingInterest', 'NetIncomeLossAttributableToRedeemableNoncontrollingInterest', 'NoncurrentAssets', 'NoncurrentAssets', 'NoninterestIncome', 'NonoperatingIncomeExpense', 'NotesReceivableNet', 'OperatingExpenses', 'OperatingIncomeLoss', 'OperatingLeaseCost', 'OperatingLeaseLiability', 'OperatingLeaseLiabilityCurrent', 'OperatingLeaseLiabilityNoncurrent', 'OperatingLeaseRightOfUseAsset', 'OtherAccruedLiabilitiesCurrent', 'OtherAssetsCurrent', 'OtherAssetsNoncurrent', 'OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax', 'OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossNetOfTax', 'OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent', 'OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax', 'OtherIncome', 'OtherLiabilitiesCurrent', 'OtherLiabilitiesNoncurrent', 'OtherLongTermDebt', 'OtherNoncashIncomeExpense', 'PaymentsForCapitalImprovements', 'PaymentsForProceedsFromBusinessesAndInterestInAffiliates', 'PaymentsForProceedsFromOtherInvestingActivities', 'PaymentsForRent', 'PaymentsForRepurchaseOfCommonStock', 'PaymentsOfDebtExtinguishmentCosts', 'PaymentsOfDividends', 'PaymentsOfDividendsMinorityInterest', 'PaymentsToAcquireInvestments', 'PaymentsToAcquirePropertyPlantAndEquipment', 'PreferredStockSharesOutstanding', 'PreferredStockValue', 'PrepaidExpenseAndOtherAssetsCurrent', 'PrepaidExpenseCurrent', 'ProceedsFromDebtMaturingInMoreThanThreeMonths', 'ProceedsFromDebtNetOfIssuanceCosts', 'ProceedsFromDivestitureOfBusinesses', 'ProceedsFromInvestments', 'ProceedsFromIssuanceOfCommonStock', 'ProceedsFromIssuanceOfDebt', 'ProceedsFromIssuanceOfLongTermDebt', 'ProceedsFromIssuanceOfUnsecuredDebt', 'ProceedsFromIssuanceOrSaleOfEquity', 'ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities', 'ProceedsFromPaymentsForOtherFinancingActivities', 'ProceedsFromPaymentsToMinorityShareholders', 'ProceedsFromRepaymentsOfShortTermDebt', 'ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess', 'ProceedsFromSaleOfPropertyPlantAndEquipment', 'ProceedsFromStockOptionsExercised', 'ProfitLoss', 'PropertyPlantAndEquipmentGross', 'PropertyPlantAndEquipmentNet', 'ReceivablesNetCurrent', 'RedeemableNoncontrollingInterestEquityCarryingAmount', 'RepaymentsOfDebtMaturingInMoreThanThreeMonths', 'RepaymentsOfLongTermDebt', 'ResearchAndDevelopmentExpense', 'RestrictedCash', 'RestrictedCashAndCashEquivalents', 'RestrictedStockExpense', 'RestructuringCharges', 'RetainedEarningsAccumulatedDeficit', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'Revenues', 'SecuredLongTermDebt', 'SellingAndMarketingExpense', 'SellingGeneralAndAdministrativeExpense', 'ShareBasedCompensation', 'ShortTermBorrowings', 'ShortTermInvestments', 'StockIssuedDuringPeriodValueNewIssues', 'StockOptionPlanExpense', 'StockRedeemedOrCalledDuringPeriodValue', 'StockRepurchasedAndRetiredDuringPeriodValue', 'StockRepurchasedDuringPeriodValue', 'StockholdersEquity', 'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 'StockholdersEquityOther', 'TaxesPayableCurrent', 'TradingSecuritiesDebt', 'TreasuryStockAcquiredAverageCostPerShare', 'TreasuryStockSharesAcquired', 'UnrealizedGainLossOnInvestments', 'UnrecognizedTaxBenefits', 'UnsecuredDebt', 'VariableLeaseCost', 'WeightedAverageNumberDilutedSharesOutstandingAdjustment', 'WeightedAverageNumberOfDilutedSharesOutstanding', 'WeightedAverageNumberOfSharesOutstandingBasic'" ), ] = "", provider: Annotated[ @@ -47,31 +47,32 @@ class ROUTER_equity_compare(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. + symbol : Union[str, None, list[Optional[str]]] Symbol to get data for. Multiple comma separated items allowed for provider(s): sec. fact : str The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. + Choices for sec: 'AccountsPayableCurrent', 'AccountsReceivableNet', 'AccountsReceivableNetCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent', 'AccruedIncomeTaxesCurrent', 'AccruedIncomeTaxesNoncurrent', 'AccruedInsuranceCurrent', 'AccruedLiabilitiesCurrent', 'AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 'AccumulatedOtherComprehensiveIncomeLossNetOfTax', 'AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets', 'AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue', 'AdvertisingExpense', 'AllocatedShareBasedCompensationExpense', 'AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount', 'AssetImpairmentCharges', 'Assets', 'AssetsCurrent', 'AssetsNoncurrent', 'BuildingsAndImprovementsGross', 'CapitalLeaseObligationsCurrent', 'CapitalLeaseObligationsNoncurrent', 'Cash', 'CashAndCashEquivalentsAtCarryingValue', 'CashCashEquivalentsAndShortTermInvestments', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect', 'CommercialPaper', 'CommitmentsAndContingencies', 'CommonStockDividendsPerShareCashPaid', 'CommonStockDividendsPerShareDeclared', 'CommonStocksIncludingAdditionalPaidInCapital', 'ComprehensiveIncomeNetOfTax', 'ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest', 'ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest', 'ConstructionInProgressGross', 'ContractWithCustomerAssetNet', 'ContractWithCustomerLiability', 'ContractWithCustomerLiabilityCurrent', 'ContractWithCustomerLiabilityNoncurrent', 'CostOfGoodsAndServicesSold', 'CostOfRevenue', 'CurrentFederalTaxExpenseBenefit', 'CurrentForeignTaxExpenseBenefit', 'CurrentIncomeTaxExpenseBenefit', 'CurrentStateAndLocalTaxExpenseBenefit', 'DebtInstrumentFaceAmount', 'DebtInstrumentFairValue', 'DebtLongtermAndShorttermCombinedAmount', 'DeferredFederalIncomeTaxExpenseBenefit', 'DeferredForeignIncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'DeferredIncomeTaxLiabilities', 'DeferredIncomeTaxLiabilitiesNet', 'DeferredIncomeTaxesAndTaxCredits', 'DeferredRevenue', 'DeferredTaxAssetsGross', 'DeferredTaxAssetsLiabilitiesNet', 'DeferredTaxAssetsNet', 'DeferredTaxLiabilities', 'DefinedContributionPlanCostRecognized', 'Depreciation', 'DepreciationAmortizationAndAccretionNet', 'DepreciationAmortizationAndOther', 'DepreciationAndAmortization', 'DepreciationDepletionAndAmortization', 'DerivativeCollateralObligationToReturnCash', 'DerivativeCollateralRightToReclaimCash', 'DerivativeFairValueOfDerivativeNet', 'DerivativeLiabilityCollateralRightToReclaimCashOffset', 'DerivativeNotionalAmount', 'DistributedEarnings', 'Dividends', 'DividendsCash', 'DividendsPayableAmountPerShare', 'DividendsPayableCurrent', 'EarningsPerShareBasic', 'EarningsPerShareDiluted', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'EffectOfExchangeRateOnCashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'EmployeeRelatedLiabilitiesCurrent', 'EmployeeRelatedLiabilitiesCurrentAndNoncurrent', 'EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense', 'FinanceLeaseInterestExpense', 'FinanceLeaseInterestPaymentOnLiability', 'FinanceLeaseLiability', 'FinanceLeaseLiabilityCurrent', 'FinanceLeaseLiabilityNoncurrent', 'FinanceLeaseLiabilityPaymentsDue', 'FinanceLeaseLiabilityPaymentsDueAfterYearFive', 'FinanceLeaseLiabilityPaymentsDueNextTwelveMonths', 'FinanceLeaseLiabilityPaymentsDueYearFive', 'FinanceLeaseLiabilityPaymentsDueYearFour', 'FinanceLeaseLiabilityPaymentsDueYearThree', 'FinanceLeaseLiabilityPaymentsDueYearTwo', 'FinanceLeaseLiabilityPaymentsRemainderOfFiscalYear', 'FinanceLeaseLiabilityUndiscountedExcessAmount', 'FinanceLeasePrincipalPayments', 'FinanceLeaseRightOfUseAsset', 'FinancingReceivableAllowanceForCreditLosses', 'FiniteLivedIntangibleAssetsNet', 'FixturesAndEquipmentGross', 'GainLossOnInvestments', 'GainLossOnInvestmentsAndDerivativeInstruments', 'GainLossOnSaleOfBusiness', 'GainsLossesOnExtinguishmentOfDebt', 'GeneralAndAdministrativeExpense', 'Goodwill', 'GrossProfit', 'ImpairmentOfIntangibleAssetsExcludingGoodwill', 'ImpairmentOfIntangibleAssetsIndefinitelivedExcludingGoodwill', 'IncomeLossFromContinuingOperations', 'IncomeLossFromContinuingOperationsAttributableToNoncontrollingEntity', 'IncomeLossFromContinuingOperationsBeforeIncomeTaxesExtraordinaryItemsNoncontrollingInterest', 'IncomeLossFromContinuingOperationsPerBasicShare', 'IncomeLossFromContinuingOperationsPerDilutedShare', 'IncomeTaxExpenseBenefit', 'IncomeTaxesPaid', 'IncomeTaxesPaidNet', 'IncreaseDecreaseInAccountsAndOtherReceivables', 'IncreaseDecreaseInAccountsPayable', 'IncreaseDecreaseInAccountsReceivable', 'IncreaseDecreaseInAccruedIncomeTaxesPayable', 'IncreaseDecreaseInAccruedLiabilities', 'IncreaseDecreaseInAccruedTaxesPayable', 'IncreaseDecreaseInContractWithCustomerLiability', 'IncreaseDecreaseInDeferredIncomeTaxes', 'IncreaseDecreaseInInventories', 'IncreaseDecreaseInOtherCurrentAssets', 'IncreaseDecreaseInOtherCurrentLiabilities', 'IncreaseDecreaseInOtherNoncurrentAssets', 'IncreaseDecreaseInOtherNoncurrentLiabilities', 'IncreaseDecreaseInPensionPlanObligations', 'IncrementalCommonSharesAttributableToShareBasedPaymentArrangements', 'InterestAndDebtExpense', 'InterestExpenseDebt', 'InterestIncomeExpenseNet', 'InterestPaid', 'InterestPaidNet', 'InventoryNet', 'InvestmentIncomeInterest', 'Land', 'LeaseAndRentalExpense', 'LesseeOperatingLeaseLiabilityPaymentsDue', 'LesseeOperatingLeaseLiabilityPaymentsDueAfterYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueNextTwelveMonths', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFive', 'LesseeOperatingLeaseLiabilityPaymentsDueYearFour', 'LesseeOperatingLeaseLiabilityPaymentsDueYearThree', 'LesseeOperatingLeaseLiabilityPaymentsDueYearTwo', 'LesseeOperatingLeaseLiabilityPaymentsRemainderOfFiscalYear', 'LettersOfCreditOutstandingAmount', 'Liabilities', 'LiabilitiesAndStockholdersEquity', 'LiabilitiesCurrent', 'LineOfCredit', 'LineOfCreditFacilityMaximumBorrowingCapacity', 'LongTermDebt', 'LongTermDebtCurrent', 'LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree', 'LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo', 'LongTermDebtMaturitiesRepaymentsOfPrincipalRemainderOfFiscalYear', 'LongTermDebtNoncurrent', 'LongTermInvestments', 'LossContingencyEstimateOfPossibleLoss', 'MachineryAndEquipmentGross', 'MarketableSecuritiesCurrent', 'MarketableSecuritiesNoncurrent', 'MinorityInterest', 'NetCashProvidedByUsedInFinancingActivities', 'NetCashProvidedByUsedInInvestingActivities', 'NetCashProvidedByUsedInOperatingActivities', 'NetIncomeLoss', 'NetIncomeLossAttributableToNoncontrollingInterest', 'NetIncomeLossAttributableToNonredeemableNoncontrollingInterest', 'NetIncomeLossAttributableToRedeemableNoncontrollingInterest', 'NoncurrentAssets', 'NoncurrentAssets', 'NoninterestIncome', 'NonoperatingIncomeExpense', 'NotesReceivableNet', 'OperatingExpenses', 'OperatingIncomeLoss', 'OperatingLeaseCost', 'OperatingLeaseLiability', 'OperatingLeaseLiabilityCurrent', 'OperatingLeaseLiabilityNoncurrent', 'OperatingLeaseRightOfUseAsset', 'OtherAccruedLiabilitiesCurrent', 'OtherAssetsCurrent', 'OtherAssetsNoncurrent', 'OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossafterReclassificationandTax', 'OtherComprehensiveIncomeLossDerivativeInstrumentGainLossbeforeReclassificationafterTax', 'OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax', 'OtherComprehensiveIncomeLossNetOfTax', 'OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent', 'OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax', 'OtherIncome', 'OtherLiabilitiesCurrent', 'OtherLiabilitiesNoncurrent', 'OtherLongTermDebt', 'OtherNoncashIncomeExpense', 'PaymentsForCapitalImprovements', 'PaymentsForProceedsFromBusinessesAndInterestInAffiliates', 'PaymentsForProceedsFromOtherInvestingActivities', 'PaymentsForRent', 'PaymentsForRepurchaseOfCommonStock', 'PaymentsOfDebtExtinguishmentCosts', 'PaymentsOfDividends', 'PaymentsOfDividendsMinorityInterest', 'PaymentsToAcquireInvestments', 'PaymentsToAcquirePropertyPlantAndEquipment', 'PreferredStockSharesOutstanding', 'PreferredStockValue', 'PrepaidExpenseAndOtherAssetsCurrent', 'PrepaidExpenseCurrent', 'ProceedsFromDebtMaturingInMoreThanThreeMonths', 'ProceedsFromDebtNetOfIssuanceCosts', 'ProceedsFromDivestitureOfBusinesses', 'ProceedsFromInvestments', 'ProceedsFromIssuanceOfCommonStock', 'ProceedsFromIssuanceOfDebt', 'ProceedsFromIssuanceOfLongTermDebt', 'ProceedsFromIssuanceOfUnsecuredDebt', 'ProceedsFromIssuanceOrSaleOfEquity', 'ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities', 'ProceedsFromPaymentsForOtherFinancingActivities', 'ProceedsFromPaymentsToMinorityShareholders', 'ProceedsFromRepaymentsOfShortTermDebt', 'ProceedsFromRepaymentsOfShortTermDebtMaturingInThreeMonthsOrLess', 'ProceedsFromSaleOfPropertyPlantAndEquipment', 'ProceedsFromStockOptionsExercised', 'ProfitLoss', 'PropertyPlantAndEquipmentGross', 'PropertyPlantAndEquipmentNet', 'ReceivablesNetCurrent', 'RedeemableNoncontrollingInterestEquityCarryingAmount', 'RepaymentsOfDebtMaturingInMoreThanThreeMonths', 'RepaymentsOfLongTermDebt', 'ResearchAndDevelopmentExpense', 'RestrictedCash', 'RestrictedCashAndCashEquivalents', 'RestrictedStockExpense', 'RestructuringCharges', 'RetainedEarningsAccumulatedDeficit', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'Revenues', 'SecuredLongTermDebt', 'SellingAndMarketingExpense', 'SellingGeneralAndAdministrativeExpense', 'ShareBasedCompensation', 'ShortTermBorrowings', 'ShortTermInvestments', 'StockIssuedDuringPeriodValueNewIssues', 'StockOptionPlanExpense', 'StockRedeemedOrCalledDuringPeriodValue', 'StockRepurchasedAndRetiredDuringPeriodValue', 'StockRepurchasedDuringPeriodValue', 'StockholdersEquity', 'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 'StockholdersEquityOther', 'TaxesPayableCurrent', 'TradingSecuritiesDebt', 'TreasuryStockAcquiredAverageCostPerShare', 'TreasuryStockSharesAcquired', 'UnrealizedGainLossOnInvestments', 'UnrecognizedTaxBenefits', 'UnsecuredDebt', 'VariableLeaseCost', 'WeightedAverageNumberDilutedSharesOutstandingAdjustment', 'WeightedAverageNumberOfDilutedSharesOutstanding', 'WeightedAverageNumberOfSharesOutstandingBasic' year : Optional[int] The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec) fiscal_period : Optional[Literal['fy', 'q1', 'q2', 'q3', 'q4']] The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec) instantaneous : bool Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data. - The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec) + The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec) use_cache : bool Whether to use cache for the request. Defaults to True. (provider: sec) Returns ------- OBBject - results : List[CompareCompanyFacts] + results : list[CompareCompanyFacts] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -455,20 +456,20 @@ class ROUTER_equity_compare(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject results : EquityPeers Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -476,7 +477,7 @@ class ROUTER_equity_compare(Container): EquityPeers ----------- - peers_list : List[str] + peers_list : list[str] A list of equity peers based on sector, exchange and market cap. Examples diff --git a/openbb_platform/openbb/package/equity_discovery.py b/openbb_platform/openbb/package/equity_discovery.py index 0527c40a82d..87f57f60b8f 100644 --- a/openbb_platform/openbb/package/equity_discovery.py +++ b/openbb_platform/openbb/package/equity_discovery.py @@ -49,22 +49,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[EquityActive] + results : list[EquityActive] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -171,22 +171,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. Default is all. (provider: yfinance) Returns ------- OBBject - results : List[EquityAggressiveSmallCaps] + results : list[EquityAggressiveSmallCaps] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -310,6 +310,8 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] @@ -318,20 +320,18 @@ class ROUTER_equity_discovery(Container): Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. limit : int The number of data entries to return. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. is_done : Optional[bool] Flag for whether or not the filing is done. (provider: fmp) Returns ------- OBBject - results : List[DiscoveryFilings] + results : list[DiscoveryFilings] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -402,22 +402,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[EquityGainers] + results : list[EquityGainers] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -524,22 +524,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[GrowthTechEquities] + results : list[GrowthTechEquities] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -640,9 +640,9 @@ class ROUTER_equity_discovery(Container): Parameters ---------- - provider : Optional[Literal['sec']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. - date : Optional[datetime.date] + date : Optional[date] A specific date to get data for. Defaults to today. (provider: sec) report_type : Optional[str] Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple comma separated items allowed. (provider: sec) @@ -650,12 +650,12 @@ class ROUTER_equity_discovery(Container): Returns ------- OBBject - results : List[LatestFinancialReports] + results : list[LatestFinancialReports] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -757,22 +757,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[EquityLosers] + results : list[EquityLosers] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -879,22 +879,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[EquityUndervaluedGrowth] + results : list[EquityUndervaluedGrowth] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1001,22 +1001,22 @@ class ROUTER_equity_discovery(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. sort : Literal['asc', 'desc'] Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. - provider : Optional[Literal['yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance. limit : Optional[int] Limit the number of results. (provider: yfinance) Returns ------- OBBject - results : List[EquityUndervaluedLargeCaps] + results : list[EquityUndervaluedLargeCaps] Serializable results. - provider : Optional[Literal['yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_estimates.py b/openbb_platform/openbb/package/equity_estimates.py index 55cd94383bc..ebded681c8c 100644 --- a/openbb_platform/openbb/package/equity_estimates.py +++ b/openbb_platform/openbb/package/equity_estimates.py @@ -1,6 +1,6 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -30,13 +30,13 @@ class ROUTER_equity_estimates(Container): def analyst_search( self, analyst_name: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga." ), ] = None, firm_name: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga." ), @@ -53,14 +53,14 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - analyst_name : Union[str, None, List[Optional[str]]] - Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. - firm_name : Union[str, None, List[Optional[str]]] - Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. - provider : Optional[Literal['benzinga']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga. + analyst_name : Union[str, None, list[Optional[str]]] + Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. + firm_name : Union[str, None, list[Optional[str]]] + Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. analyst_ids : Optional[str] - List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) + list of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) firm_ids : Optional[str] Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga) limit : Optional[int] @@ -73,12 +73,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[AnalystSearch] + results : list[AnalystSearch] Serializable results. - provider : Optional[Literal['benzinga']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -246,7 +246,7 @@ class ROUTER_equity_estimates(Container): def consensus( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), @@ -263,22 +263,22 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, None, list[Optional[str]]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. industry_group_number : Optional[int] The Zacks industry group number. (provider: intrinio) Returns ------- OBBject - results : List[PriceTargetConsensus] + results : list[PriceTargetConsensus] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -357,7 +357,7 @@ class ROUTER_equity_estimates(Container): def forward_ebitda( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." ), @@ -374,13 +374,12 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. - provider : Optional[Literal['fmp', 'intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. + symbol : Union[str, None, list[Optional[str]]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. fiscal_period : Optional[Literal['annual', 'quarter']] - The future fiscal period to retrieve estimates for. (provider: fmp); - Filter for only full-year or quarterly estimates. (provider: intrinio) + The future fiscal period to retrieve estimates for. (provider: fmp) limit : Optional[int] The number of data entries to return. (provider: fmp) include_historical : bool @@ -391,12 +390,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[ForwardEbitdaEstimates] + results : list[ForwardEbitdaEstimates] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -471,7 +470,7 @@ class ROUTER_equity_estimates(Container): def forward_eps( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." ), @@ -488,12 +487,13 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. - provider : Optional[Literal['fmp', 'intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. - fiscal_period : Optional[Union[Literal['annual', 'quarter'], Literal['fy', 'q1', 'q2', 'q3', 'q4']]] + symbol : Union[str, None, list[Optional[str]]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. + fiscal_period : str The future fiscal period to retrieve estimates for. (provider: fmp, intrinio) + Choices for fmp: 'annual', 'quarter' limit : Optional[int] The number of data entries to return. (provider: fmp) include_historical : bool @@ -508,12 +508,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[ForwardEpsEstimates] + results : list[ForwardEpsEstimates] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -593,7 +593,7 @@ class ROUTER_equity_estimates(Container): def forward_pe( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), @@ -610,20 +610,20 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. - provider : Optional[Literal['intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. + symbol : Union[str, None, list[Optional[str]]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. Returns ------- OBBject - results : List[ForwardPeEstimates] + results : list[ForwardPeEstimates] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -686,7 +686,7 @@ class ROUTER_equity_estimates(Container): def forward_sales( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), @@ -703,10 +703,10 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. - provider : Optional[Literal['intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. + symbol : Union[str, None, list[Optional[str]]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. fiscal_year : Optional[int] The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) fiscal_period : Optional[Literal['fy', 'q1', 'q2', 'q3', 'q4']] @@ -719,12 +719,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[ForwardSalesEstimates] + results : list[ForwardSalesEstimates] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -811,7 +811,7 @@ class ROUTER_equity_estimates(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), @@ -828,10 +828,10 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. period : Literal['quarter', 'annual'] Time period of the data to return. (provider: fmp) limit : Optional[int] @@ -840,12 +840,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[AnalystEstimates] + results : list[AnalystEstimates] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -929,7 +929,7 @@ class ROUTER_equity_estimates(Container): def price_target( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." ), @@ -949,31 +949,31 @@ class ROUTER_equity_estimates(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp. + symbol : Union[str, None, list[Optional[str]]] Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp. limit : int The number of data entries to return. - provider : Optional[Literal['benzinga', 'fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp. page : Optional[int] 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. (provider: benzinga) - date : Optional[datetime.date] + date : Optional[date] Date for calendar data, shorthand for date_from and date_to. (provider: benzinga) - start_date : Optional[datetime.date] + start_date : Optional[date] Start date of the data, in YYYY-MM-DD format. (provider: benzinga) - end_date : Optional[datetime.date] + end_date : Optional[date] End date of the data, in YYYY-MM-DD format. (provider: benzinga) - updated : Optional[Union[datetime.date, int]] + updated : Union[date, int, None] 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. (provider: benzinga) importance : Optional[int] Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga) action : Optional[Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']] Filter by a specific action_company. (provider: benzinga) - analyst_ids : Optional[Union[str, List[str]]] + analyst_ids : Union[str, list[str], None] Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga) - firm_ids : Optional[Union[str, List[str]]] + firm_ids : Union[str, list[str], None] Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga) - fields : Optional[Union[str, List[str]]] + fields : Union[str, list[str], None] 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. Multiple comma separated items allowed. (provider: benzinga) with_grade : bool Include upgrades and downgrades in the response. (provider: fmp) @@ -981,12 +981,12 @@ class ROUTER_equity_estimates(Container): Returns ------- OBBject - results : List[PriceTarget] + results : list[PriceTarget] Serializable results. - provider : Optional[Literal['benzinga', 'fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_fundamental.py b/openbb_platform/openbb/package/equity_fundamental.py index 9b7ffe14846..68fa81bc770 100644 --- a/openbb_platform/openbb/package/equity_fundamental.py +++ b/openbb_platform/openbb/package/equity_fundamental.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from annotated_types import Ge from openbb_core.app.model.field import OpenBBField @@ -65,35 +65,35 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. symbol : str Symbol to get data for. limit : Optional[Annotated[int, Ge(ge=0)]] The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. period : Literal['annual', 'quarter'] Time period of the data to return. (provider: fmp, intrinio, polygon, yfinance) fiscal_year : Optional[int] The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) - filing_date : Optional[datetime.date] + filing_date : Optional[date] Filing date of the financial statement. (provider: polygon) - filing_date_lt : Optional[datetime.date] + filing_date_lt : Optional[date] Filing date less than the given date. (provider: polygon) - filing_date_lte : Optional[datetime.date] + filing_date_lte : Optional[date] Filing date less than or equal to the given date. (provider: polygon) - filing_date_gt : Optional[datetime.date] + filing_date_gt : Optional[date] Filing date greater than the given date. (provider: polygon) - filing_date_gte : Optional[datetime.date] + filing_date_gte : Optional[date] Filing date greater than or equal to the given date. (provider: polygon) - period_of_report_date : Optional[datetime.date] + period_of_report_date : Optional[date] Period of report date of the financial statement. (provider: polygon) - period_of_report_date_lt : Optional[datetime.date] + period_of_report_date_lt : Optional[date] Period of report date less than the given date. (provider: polygon) - period_of_report_date_lte : Optional[datetime.date] + period_of_report_date_lte : Optional[date] Period of report date less than or equal to the given date. (provider: polygon) - period_of_report_date_gt : Optional[datetime.date] + period_of_report_date_gt : Optional[date] Period of report date greater than the given date. (provider: polygon) - period_of_report_date_gte : Optional[datetime.date] + period_of_report_date_gte : Optional[date] Period of report date greater than or equal to the given date. (provider: polygon) include_sources : bool Whether to include the sources of the financial statement. (provider: polygon) @@ -105,12 +105,12 @@ class ROUTER_equity_fundamental(Container): Returns ------- OBBject - results : List[BalanceSheet] + results : list[BalanceSheet] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -437,24 +437,24 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. period : Literal['annual', 'quarter'] Time period of the data to return. (provider: fmp) Returns ------- OBBject - results : List[BalanceSheetGrowth] + results : list[BalanceSheetGrowth] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -603,35 +603,39 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. symbol : str Symbol to get data for. limit : Optional[Annotated[int, Ge(ge=0)]] The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. - period : Union[Literal['annual', 'quarter'], Literal['annual', 'quarter', 'ttm', 'ytd'], Literal['annual', 'quarter', 'ttm']] + period : str Time period of the data to return. (provider: fmp, intrinio, polygon, yfinance) + Choices for fmp: 'annual', 'quarter' + Choices for intrinio: 'annual', 'quarter', 'ttm', 'ytd' + Choices for polygon: 'annual', 'quarter', 'ttm' + Choices for yfinance: 'annual', 'quarter' fiscal_year : Optional[int] The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) - filing_date : Optional[datetime.date] + filing_date : Optional[date] Filing date of the financial statement. (provider: polygon) - filing_date_lt : Optional[datetime.date] + filing_date_lt : Optional[date] Filing date less than the given date. (provider: polygon) - filing_date_lte : Optional[datetime.date] + filing_date_lte : Optional[date] Filing date less than or equal to the given date. (provider: polygon) - filing_date_gt : Optional[datetime.date] + filing_date_gt : Optional[date] Filing date greater than the given date. (provider: polygon) - filing_date_gte : Optional[datetime.date] + filing_date_gte : Optional[date] Filing date greater than or equal to the given date. (provider: polygon) - period_of_report_date : Optional[datetime.date] + period_of_report_date : Optional[date] Period of report date of the financial statement. (provider: polygon) - period_of_report_date_lt : Optional[datetime.date] + period_of_report_date_lt : Optional[date] Period of report date less than the given date. (provider: polygon) - period_of_report_date_lte : Optional[datetime.date] + period_of_report_date_lte : Optional[date] Period of report date less than or equal to the given date. (provider: polygon) - period_of_report_date_gt : Optional[datetime.date] + period_of_report_date_gt : Optional[date] Period of report date greater than the given date. (provider: polygon) - period_of_report_date_gte : Optional[datetime.date] + period_of_report_date_gte : Optional[date] Period of report date greater than or equal to the given date. (provider: polygon) include_sources : bool Whether to include the sources of the financial statement. (provider: polygon) @@ -643,12 +647,12 @@ class ROUTER_equity_fundamental(Container): Returns ------- OBBject - results : List[CashFlowStatement] + results : list[CashFlowStatement] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -885,24 +889,24 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. period : Literal['annual', 'quarter'] Time period of the data to return. (provider: fmp) Returns ------- OBBject - results : List[CashFlowStatementGrowth] + results : list[CashFlowStatementGrowth] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1037,26 +1041,26 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. symbol : str Symbol to get data for. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. limit : Optional[int] The number of data entries to return. (provider: intrinio) Returns ------- OBBject - results : List[HistoricalDividends] + results : list[HistoricalDividends] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1127,20 +1131,20 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[HistoricalEmployees] + results : list[HistoricalEmployees] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1197,15 +1201,6 @@ class ROUTER_equity_fundamental(Container): symbol: Annotated[ Optional[str], OpenBBField(description="Symbol to get data for.") ] = None, - form_type: Annotated[ - Union[str, None, List[Optional[str]]], - OpenBBField( - description="Filter by form type. Check the data provider for available types. Multiple comma separated items allowed for provider(s): sec." - ), - ] = None, - limit: Annotated[ - int, OpenBBField(description="The number of data entries to return.") - ] = 100, provider: Annotated[ Optional[Literal["fmp", "intrinio", "sec"]], OpenBBField( @@ -1214,31 +1209,26 @@ class ROUTER_equity_fundamental(Container): ] = None, **kwargs ) -> OBBject: - """Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. - - SEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114, - Foreign Investment Disclosures and others. The annual 10-K report is required to be - filed annually and includes the company's financial statements, management discussion and analysis, - and audited financial statements. - + """Get public company filings. Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. symbol : Optional[str] Symbol to get data for. - form_type : Union[str, None, List[Optional[str]]] - Filter by form type. Check the data provider for available types. Multiple comma separated items allowed for provider(s): sec. - limit : int - The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. - start_date : Optional[datetime.date] + form_type : Optional[str] + SEC form type to filter by. (provider: fmp, intrinio) + limit : Optional[int] + Number of results to return. (provider: fmp); + The number of data entries to return. (provider: sec) + start_date : Optional[date] Start date of the data, in YYYY-MM-DD format. (provider: intrinio, sec) - end_date : Optional[datetime.date] + end_date : Optional[date] End date of the data, in YYYY-MM-DD format. (provider: intrinio, sec) thea_enabled : Optional[bool] Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) - cik : Optional[Union[int, str]] + cik : Union[int, str, None] Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) use_cache : bool Whether or not to use cache. If True, cache will store for one day. (provider: sec) @@ -1246,12 +1236,12 @@ class ROUTER_equity_fundamental(Container): Returns ------- OBBject - results : List[CompanyFilings] + results : list[CompanyFilings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1261,18 +1251,18 @@ class ROUTER_equity_fundamental(Container): -------------- filing_date : date The date of the filing. - accepted_date : Optional[datetime] - Accepted date of the filing. - symbol : Optional[str] - Symbol representing the entity requested in the data. - cik : Optional[str] - Central Index Key (CIK) for the requested entity. report_type : Optional[str] Type of filing. - filing_url : Optional[str] - URL to the filing page. report_url : str URL to the actual report. + filing_url : Optional[str] + URL to the filing page. (provider: fmp, intrinio) + symbol : Optional[str] + Symbol representing the entity requested in the data. (provider: fmp) + cik : Optional[str] + Central Index Key (CIK) for the requested entity. (provider: fmp) + accepted_date : Optional[datetime] + Accepted date of the filing. (provider: fmp, intrinio) id : Optional[str] Intrinio ID of the filing. (provider: intrinio) period_end_date : Optional[date] @@ -1285,6 +1275,8 @@ class ROUTER_equity_fundamental(Container): Industry group of the company. (provider: intrinio) industry_category : Optional[str] Industry category of the company. (provider: intrinio) + word_count : Optional[int] + Number of words in the filing, if available. (provider: intrinio) report_date : Optional[date] The date of the filing. (provider: sec) act : Optional[Union[int, str]] @@ -1331,8 +1323,6 @@ class ROUTER_equity_fundamental(Container): }, standard_params={ "symbol": symbol, - "form_type": form_type, - "limit": limit, }, extra_params=kwargs, info={ @@ -1714,13 +1704,13 @@ class ROUTER_equity_fundamental(Container): def historical_attributes( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), ], tag: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." ), @@ -1759,9 +1749,11 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. - tag : Union[str, List[str]] + tag : Union[str, list[str]] Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. @@ -1775,18 +1767,16 @@ class ROUTER_equity_fundamental(Container): Filter by type, when applicable. sort : Optional[Literal['asc', 'desc']] Sort order. - provider : Optional[Literal['intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. Returns ------- OBBject - results : List[HistoricalAttributes] + results : list[HistoricalAttributes] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1858,22 +1848,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. limit : Optional[int] The number of data entries to return. (provider: fmp) Returns ------- OBBject - results : List[HistoricalEps] + results : list[HistoricalEps] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1942,20 +1932,20 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[HistoricalSplits] + results : list[HistoricalSplits] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2016,35 +2006,39 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. symbol : str Symbol to get data for. limit : Optional[Annotated[int, Ge(ge=0)]] The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. - period : Union[Literal['annual', 'quarter'], Literal['annual', 'quarter', 'ttm', 'ytd'], Literal['annual', 'quarter', 'ttm']] + period : str Time period of the data to return. (provider: fmp, intrinio, polygon, yfinance) + Choices for fmp: 'annual', 'quarter' + Choices for intrinio: 'annual', 'quarter', 'ttm', 'ytd' + Choices for polygon: 'annual', 'quarter', 'ttm' + Choices for yfinance: 'annual', 'quarter' fiscal_year : Optional[int] The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) - filing_date : Optional[datetime.date] + filing_date : Optional[date] Filing date of the financial statement. (provider: polygon) - filing_date_lt : Optional[datetime.date] + filing_date_lt : Optional[date] Filing date less than the given date. (provider: polygon) - filing_date_lte : Optional[datetime.date] + filing_date_lte : Optional[date] Filing date less than or equal to the given date. (provider: polygon) - filing_date_gt : Optional[datetime.date] + filing_date_gt : Optional[date] Filing date greater than the given date. (provider: polygon) - filing_date_gte : Optional[datetime.date] + filing_date_gte : Optional[date] Filing date greater than or equal to the given date. (provider: polygon) - period_of_report_date : Optional[datetime.date] + period_of_report_date : Optional[date] Period of report date of the financial statement. (provider: polygon) - period_of_report_date_lt : Optional[datetime.date] + period_of_report_date_lt : Optional[date] Period of report date less than the given date. (provider: polygon) - period_of_report_date_lte : Optional[datetime.date] + period_of_report_date_lte : Optional[date] Period of report date less than or equal to the given date. (provider: polygon) - period_of_report_date_gt : Optional[datetime.date] + period_of_report_date_gt : Optional[date] Period of report date greater than the given date. (provider: polygon) - period_of_report_date_gte : Optional[datetime.date] + period_of_report_date_gte : Optional[date] Period of report date greater than or equal to the given date. (provider: polygon) include_sources : Optional[bool] Whether to include the sources of the financial statement. (provider: polygon) @@ -2056,12 +2050,12 @@ class ROUTER_equity_fundamental(Container): Returns ------- OBBject - results : List[IncomeStatement] + results : list[IncomeStatement] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2392,24 +2386,24 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. period : Literal['annual', 'quarter'] Time period of the data to return. (provider: fmp) Returns ------- OBBject - results : List[IncomeStatementGrowth] + results : list[IncomeStatementGrowth] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2516,13 +2510,13 @@ class ROUTER_equity_fundamental(Container): def latest_attributes( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." ), ], tag: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." ), @@ -2539,22 +2533,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. - tag : Union[str, List[str]] - Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. - provider : Optional[Literal['intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. + tag : Union[str, list[str]] + Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. Returns ------- OBBject - results : List[LatestAttributes] + results : list[LatestAttributes] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2618,20 +2612,20 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance. Returns ------- OBBject - results : List[KeyExecutives] + results : list[KeyExecutives] Serializable results. - provider : Optional[Literal['fmp', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2688,7 +2682,7 @@ class ROUTER_equity_fundamental(Container): def management_compensation( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), @@ -2705,22 +2699,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. year : Optional[int] Year of the compensation. (provider: fmp) Returns ------- OBBject - results : List[ExecutiveCompensation] + results : list[ExecutiveCompensation] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2814,14 +2808,14 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. symbol : str Symbol to get data for. calendar_year : Optional[int] Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report. calendar_period : Optional[Literal['Q1', 'Q2', 'Q3', 'Q4']] Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. strategy : Literal['inscriptis', 'trafilatura'] The strategy to use for extracting the text. Default is 'trafilatura'. (provider: sec) wrap_length : int @@ -2838,10 +2832,10 @@ class ROUTER_equity_fundamental(Container): OBBject results : ManagementDiscussionAnalysis Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -2898,7 +2892,7 @@ class ROUTER_equity_fundamental(Container): def metrics( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), @@ -2919,12 +2913,12 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. period : Literal['annual', 'quarter'] Time period of the data to return. (provider: fmp) with_ttm : bool @@ -2933,12 +2927,12 @@ class ROUTER_equity_fundamental(Container): Returns ------- OBBject - results : List[KeyMetrics] + results : list[KeyMetrics] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3217,7 +3211,7 @@ class ROUTER_equity_fundamental(Container): def multiples( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), @@ -3234,20 +3228,20 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. Returns ------- OBBject - results : List[EquityValuationMultiples] + results : list[EquityValuationMultiples] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3424,26 +3418,28 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. symbol : str Symbol to get data for. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. - period : Union[Literal['annual', 'quarter', 'ttm'], Literal['annual', 'quarter', 'ttm', 'ytd']] + period : str Time period of the data to return. (provider: fmp, intrinio) + Choices for fmp: 'annual', 'quarter', 'ttm' + Choices for intrinio: 'annual', 'quarter', 'ttm', 'ytd' fiscal_year : Optional[int] The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) Returns ------- OBBject - results : List[FinancialRatios] + results : list[FinancialRatios] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3639,6 +3635,8 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. symbol : str Symbol to get data for. period : str @@ -3647,20 +3645,18 @@ class ROUTER_equity_fundamental(Container): The type of financial statement - i.e, balance, income, cash. limit : Optional[int] 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. - provider : Optional[Literal['intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. fiscal_year : Optional[int] The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) Returns ------- OBBject - results : List[ReportedFinancials] + results : list[ReportedFinancials] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3724,22 +3720,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. period : Literal['quarter', 'annual'] Time period of the data to return. (provider: fmp) Returns ------- OBBject - results : List[RevenueGeographic] + results : list[RevenueGeographic] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3809,22 +3805,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. period : Literal['quarter', 'annual'] Time period of the data to return. (provider: fmp) Returns ------- OBBject - results : List[RevenueBusinessLine] + results : list[RevenueBusinessLine] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3898,22 +3894,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. query : str Query to search for. limit : Optional[int] The number of data entries to return. - provider : Optional[Literal['intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio. Returns ------- OBBject - results : List[SearchAttributes] + results : list[SearchAttributes] Serializable results. - provider : Optional[Literal['intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -3991,22 +3987,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: tiingo. symbol : str Symbol to get data for. limit : Optional[int] The number of data entries to return. Default is 252, the number of trading days in a year. - provider : Optional[Literal['tiingo']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: tiingo. Returns ------- OBBject - results : List[TrailingDividendYield] + results : list[TrailingDividendYield] Serializable results. - provider : Optional[Literal['tiingo']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -4049,13 +4045,13 @@ class ROUTER_equity_fundamental(Container): def transcript( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), ], year: Annotated[ - Union[int, str, List[Union[int, str]]], + Union[int, str, list[Union[int, str]]], OpenBBField( description="Year of the earnings call transcript. Multiple comma separated items allowed for provider(s): fmp." ), @@ -4072,22 +4068,22 @@ class ROUTER_equity_fundamental(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - year : Union[int, str, List[Union[int, str]]] - Year of the earnings call transcript. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. + year : Union[int, str, list[Union[int, str]]] + Year of the earnings call transcript. Multiple comma separated items allowed for provider(s): fmp. Returns ------- OBBject - results : List[EarningsCallTranscript] + results : list[EarningsCallTranscript] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_ownership.py b/openbb_platform/openbb/package/equity_ownership.py index f70abb43b54..8a41aec9a0a 100644 --- a/openbb_platform/openbb/package/equity_ownership.py +++ b/openbb_platform/openbb/package/equity_ownership.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from annotated_types import Ge from openbb_core.app.model.field import OpenBBField @@ -67,24 +67,24 @@ class ROUTER_equity_ownership(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. symbol : str Symbol to get data for. A CIK or Symbol can be used. date : Union[date, None, str] 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. limit : Optional[int] The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. Returns ------- OBBject - results : List[Form13FHR] + results : list[Form13FHR] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -155,7 +155,7 @@ class ROUTER_equity_ownership(Container): def government_trades( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), @@ -182,24 +182,24 @@ class ROUTER_equity_ownership(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, None, list[Optional[str]]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. chamber : Literal['house', 'senate', 'all'] Government Chamber. limit : Optional[Annotated[int, Ge(ge=0)]] The number of data entries to return. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[GovernmentTrades] + results : list[GovernmentTrades] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -281,18 +281,17 @@ class ROUTER_equity_ownership(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. symbol : str Symbol to get data for. limit : int The number of data entries to return. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. transaction_type : Optional[Literal['award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']] Type of the transaction. (provider: fmp) - start_date : Optional[datetime.date] - Start date of the data, in YYYY-MM-DD format. (provider: intrinio); - Start date of the data, in YYYY-MM-DD format. Wide date ranges can result in long download times. Recommended to use a smaller date range, default is 120 days ago. (provider: sec) - end_date : Optional[datetime.date] + start_date : Optional[date] + Start date of the data, in YYYY-MM-DD format. (provider: intrinio) + end_date : Optional[date] End date of the data, in YYYY-MM-DD format. (provider: intrinio, sec) ownership_type : Optional[Literal['D', 'I']] Type of ownership. (provider: intrinio) @@ -304,12 +303,12 @@ class ROUTER_equity_ownership(Container): Returns ------- OBBject - results : List[InsiderTrading] + results : list[InsiderTrading] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -471,24 +470,24 @@ class ROUTER_equity_ownership(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. include_current_quarter : Optional[bool] Include current quarter data. (provider: fmp) - date : Optional[datetime.date] + date : Optional[date] A specific date to get data for. (provider: fmp) Returns ------- OBBject - results : List[InstitutionalOwnership] + results : list[InstitutionalOwnership] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -616,24 +615,24 @@ class ROUTER_equity_ownership(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. date : Union[date, None, str] A specific date to get data for. page : Optional[int] Page number of the data to fetch. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[EquityOwnership] + results : list[EquityOwnership] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -751,7 +750,7 @@ class ROUTER_equity_ownership(Container): def share_statistics( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance." ), @@ -768,20 +767,20 @@ class ROUTER_equity_ownership(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance. Returns ------- OBBject - results : List[ShareStatistics] + results : list[ShareStatistics] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index 797e7789330..950c2f43f67 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -27,7 +27,7 @@ class ROUTER_equity_price(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), @@ -52,16 +52,19 @@ class ROUTER_equity_price(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, tiingo, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, tiingo, yfinance. - interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y'], str, Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '1W', '1M', '1Y'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']] + interval : str Time interval of the data to return. (provider: fmp, intrinio, polygon, tiingo, yfinance) + Choices for fmp: '1m', '5m', '15m', '30m', '1h', '4h', '1d' + Choices for intrinio: '1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y' + Choices for yfinance: '1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q' start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -70,8 +73,10 @@ class ROUTER_equity_price(Container): Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) - adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + adjustment : str The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) + Choices for polygon: 'splits_only', 'unadjusted' + Choices for yfinance: 'splits_only', 'splits_and_dividends' extended_hours : bool Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] @@ -84,12 +89,12 @@ class ROUTER_equity_price(Container): Returns ------- OBBject - results : List[EquityHistorical] + results : list[EquityHistorical] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -259,32 +264,32 @@ class ROUTER_equity_price(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: polygon. symbol : str Symbol to get data for. - provider : Optional[Literal['polygon']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: polygon. limit : int 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. (provider: polygon) - date : Optional[datetime.date] + date : Optional[date] A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon) - timestamp_lt : Optional[Union[datetime.datetime, str]] + timestamp_lt : Union[datetime, str, None] 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. (provider: polygon) - timestamp_gt : Optional[Union[datetime.datetime, str]] + timestamp_gt : Union[datetime, str, None] 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. (provider: polygon) - timestamp_lte : Optional[Union[datetime.datetime, str]] + timestamp_lte : Union[datetime, str, None] 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. (provider: polygon) - timestamp_gte : Optional[Union[datetime.datetime, str]] + timestamp_gte : Union[datetime, str, None] 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. (provider: polygon) Returns ------- OBBject - results : List[EquityNBBO] + results : list[EquityNBBO] Serializable results. - provider : Optional[Literal['polygon']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -297,11 +302,9 @@ class ROUTER_equity_price(Container): ask : float The last ask price. ask_size : int - - The ask size. This represents the number of round lot orders at the given ask price. + 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. - bid_size : int The bid size in round lots. bid : float @@ -310,9 +313,9 @@ class ROUTER_equity_price(Container): The exchange ID for the bid. tape : Optional[str] The exchange tape. (provider: polygon) - conditions : Optional[Union[str, List[int], List[str]]] + conditions : Optional[Union[str, list[int], list[str]]] A list of condition codes. (provider: polygon) - indicators : Optional[List[int]] + indicators : Optional[list[int]] A list of indicator codes. (provider: polygon) sequence_num : Optional[int] 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) (provider: polygon) @@ -351,7 +354,7 @@ class ROUTER_equity_price(Container): def performance( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." ), @@ -368,20 +371,20 @@ class ROUTER_equity_price(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. Returns ------- OBBject - results : List[PricePerformance] + results : list[PricePerformance] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -455,7 +458,7 @@ class ROUTER_equity_price(Container): def quote( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), @@ -472,22 +475,22 @@ class ROUTER_equity_price(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. source : Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] Source of the data. (provider: intrinio) Returns ------- OBBject - results : List[EquityQuote] + results : list[EquityQuote] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -515,11 +518,11 @@ class ROUTER_equity_price(Container): 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. ask_exchange : Optional[str] The specific trading venue where the sale order was placed. - quote_conditions : Optional[Union[str, int, List[str], List[int]]] + quote_conditions : Optional[Union[str, int, list[str], list[int]]] Conditions or condition codes applicable to the quote. - quote_indicators : Optional[Union[str, int, List[str], List[int]]] + quote_indicators : Optional[Union[str, int, list[str], list[int]]] 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. - sales_conditions : Optional[Union[str, int, List[str], List[int]]] + sales_conditions : Optional[Union[str, int, list[str], list[int]]] Conditions or condition codes applicable to the sale. sequence_number : Optional[int] 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). diff --git a/openbb_platform/openbb/package/equity_shorts.py b/openbb_platform/openbb/package/equity_shorts.py index 60ff1e40d36..c5c55640738 100644 --- a/openbb_platform/openbb/package/equity_shorts.py +++ b/openbb_platform/openbb/package/equity_shorts.py @@ -35,31 +35,31 @@ class ROUTER_equity_shorts(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. symbol : str Symbol to get data for. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. limit : Optional[int] - Limit the number of reports to parse, from most recent. - Approximately 24 reports per year, going back to 2009. - (provider: sec) + Limit the number of reports to parse, from most recent. + Approximately 24 reports per year, going back to 2009. + (provider: sec) skip_reports : Optional[int] - Skip N number of reports from current. A value of 1 will skip the most recent report. - (provider: sec) + Skip N number of reports from current. A value of 1 will skip the most recent report. + (provider: sec) use_cache : Optional[bool] 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. (provider: sec) Returns ------- OBBject - results : List[EquityFTD] + results : list[EquityFTD] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py index 9a419730a8f..11a1e615475 100644 --- a/openbb_platform/openbb/package/etf.py +++ b/openbb_platform/openbb/package/etf.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -32,7 +32,7 @@ class ROUTER_etf(Container): def countries( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." ), @@ -49,20 +49,20 @@ class ROUTER_etf(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp. Returns ------- OBBject - results : List[EtfCountries] + results : list[EtfCountries] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -104,7 +104,7 @@ class ROUTER_etf(Container): def equity_exposure( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." ), @@ -121,20 +121,20 @@ class ROUTER_etf(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp. - provider : Optional[Literal['fmp']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. + symbol : Union[str, list[str]] + Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp. Returns ------- OBBject - results : List[EtfEquityExposure] + results : list[EtfEquityExposure] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -186,7 +186,7 @@ class ROUTER_etf(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance." ), @@ -211,16 +211,19 @@ class ROUTER_etf(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, tiingo, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, tiingo, yfinance. - interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y'], str, Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '1W', '1M', '1Y'], Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']] + interval : str Time interval of the data to return. (provider: fmp, intrinio, polygon, tiingo, yfinance) + Choices for fmp: '1m', '5m', '15m', '30m', '1h', '4h', '1d' + Choices for intrinio: '1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y' + Choices for yfinance: '1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q' start_time : Optional[datetime.time] Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) end_time : Optional[datetime.time] @@ -229,8 +232,10 @@ class ROUTER_etf(Container): Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) source : Literal['realtime', 'delayed', 'nasdaq_basic'] The source of the data. (provider: intrinio) - adjustment : Union[Literal['splits_only', 'unadjusted'], Literal['splits_only', 'splits_and_dividends']] + adjustment : str The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) + Choices for polygon: 'splits_only', 'unadjusted' + Choices for yfinance: 'splits_only', 'splits_and_dividends' extended_hours : bool Include Pre and Post market data. (provider: polygon, yfinance) sort : Literal['asc', 'desc'] @@ -243,12 +248,12 @@ class ROUTER_etf(Container): Returns ------- OBBject - results : List[EtfHistorical] + results : list[EtfHistorical] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -422,14 +427,13 @@ class ROUTER_etf(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp', 'intrinio', 'sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec. - date : Optional[Union[datetime.date, str]] + date : Union[date, str, None] 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. (provider: fmp); - A specific date to get data for. (provider: intrinio); - A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec) + The date represents the period ending. The date entered will return the closest filing. (provider: sec) cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) use_cache : bool @@ -438,12 +442,12 @@ class ROUTER_etf(Container): Returns ------- OBBject - results : List[EtfHoldings] + results : list[EtfHoldings] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -507,7 +511,7 @@ class ROUTER_etf(Container): ric : Optional[str] The Reuters Instrument Code. (provider: intrinio) sedol : Optional[str] - The Stock Exchange Daily Official List. (provider: intrinio) + The Stock Exchange Daily Official list. (provider: intrinio) share_class_figi : Optional[str] The OpenFIGI symbol for the holding. (provider: intrinio) maturity_date : Optional[date] @@ -681,22 +685,22 @@ class ROUTER_etf(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) Returns ------- OBBject - results : List[EtfHoldingsDate] + results : list[EtfHoldingsDate] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -735,7 +739,7 @@ class ROUTER_etf(Container): def info( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance." ), @@ -752,20 +756,20 @@ class ROUTER_etf(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance. + symbol : Union[str, list[str]] + Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, yfinance. Returns ------- OBBject - results : List[EtfInfo] + results : list[EtfInfo] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -825,7 +829,7 @@ class ROUTER_etf(Container): ric : Optional[str] Reuters Instrument Code (RIC). (provider: intrinio) sedol : Optional[str] - Stock Exchange Daily Official List (SEDOL). (provider: intrinio) + Stock Exchange Daily Official list (SEDOL). (provider: intrinio) figi_symbol : Optional[str] Financial Instrument Global Identifier (FIGI) symbol. (provider: intrinio) share_class_figi : Optional[str] @@ -1022,7 +1026,7 @@ class ROUTER_etf(Container): base_currency : Optional[str] Base currency in which NAV is reported. (provider: intrinio) listing_currency : Optional[str] - Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code. (provider: intrinio) + listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code. (provider: intrinio) number_of_holdings : Optional[int] The number of holdings in the ETF. (provider: intrinio) month_end_assets : Optional[float] @@ -1127,7 +1131,7 @@ class ROUTER_etf(Container): def price_performance( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." ), @@ -1144,10 +1148,10 @@ class ROUTER_etf(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. - provider : Optional[Literal['fmp', 'intrinio']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. + symbol : Union[str, list[str]] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. return_type : Literal['trailing', 'calendar'] The type of returns to return, a trailing or calendar window. (provider: intrinio) adjustment : Literal['splits_only', 'splits_and_dividends'] @@ -1156,12 +1160,12 @@ class ROUTER_etf(Container): Returns ------- OBBject - results : List[EtfPricePerformance] + results : list[EtfPricePerformance] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1284,25 +1288,24 @@ class ROUTER_etf(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. query : Optional[str] Search query. - provider : Optional[Literal['fmp', 'intrinio']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio. - exchange : Optional[Union[Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT'], Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']]] - The exchange code the ETF trades on. (provider: fmp); - Target a specific exchange by providing the MIC code. (provider: intrinio) + exchange : str + The exchange code the ETF trades on. (provider: fmp) is_active : Optional[Literal[True, False]] Whether the ETF is actively trading. (provider: fmp) Returns ------- OBBject - results : List[EtfSearch] + results : list[EtfSearch] Serializable results. - provider : Optional[Literal['fmp', 'intrinio']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1344,7 +1347,7 @@ class ROUTER_etf(Container): isin : Optional[str] The International Securities Identification Number. (provider: intrinio) sedol : Optional[str] - The Stock Exchange Daily Official List. (provider: intrinio) + The Stock Exchange Daily Official list. (provider: intrinio) intrinio_id : Optional[str] The unique Intrinio ID for the security. (provider: intrinio) @@ -1408,20 +1411,20 @@ class ROUTER_etf(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. (ETF) - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[EtfSectors] + results : list[EtfSectors] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/fixedincome.py b/openbb_platform/openbb/package/fixedincome.py index f1a37996b1e..cc9985eef24 100644 --- a/openbb_platform/openbb/package/fixedincome.py +++ b/openbb_platform/openbb/package/fixedincome.py @@ -57,96 +57,96 @@ class ROUTER_fixedincome(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. index_type : Literal['yield', 'yield_to_worst', 'total_return', 'oas'] The type of series. OAS is the option-adjusted spread. Default is yield. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. category : Literal['high_yield', 'us', 'emerging_markets'] The type of index category. Used in conjunction with 'index', default is 'us'. (provider: fred) index : str The specific index to query. Used in conjunction with 'category' and 'index_type', default is 'yield_curve'. - Possible values are: - corporate - seasoned_corporate - liquid_corporate - yield_curve - crossover - public_sector - private_sector - non_financial - high_grade - high_yield - liquid_emea - emea - liquid_asia - asia - liquid_latam - latam - liquid_aaa - liquid_bbb - aaa - aa - a - bbb - bb - b - ccc + Possible values are: + corporate + seasoned_corporate + liquid_corporate + yield_curve + crossover + public_sector + private_sector + non_financial + high_grade + high_yield + liquid_emea + emea + liquid_asia + asia + liquid_latam + latam + liquid_aaa + liquid_bbb + aaa + aa + a + bbb + bb + b + ccc - Multiple comma separated items allowed. (provider: fred) + Multiple comma separated items allowed. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily 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 - (provider: fred) + Frequency aggregation to convert daily 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 + (provider: fred) aggregation_method : Literal['avg', 'sum', 'eop'] - A key that indicates the aggregation method used for frequency aggregation. - This parameter has no affect if the frequency parameter is not set, default is 'avg'. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + This parameter has no affect if the frequency parameter is not set, default is 'avg'. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[BondIndices] + results : list[BondIndices] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -271,64 +271,64 @@ class ROUTER_fixedincome(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. index : Union[Literal['primary', 'ltv_lte_80', 'ltv_gt_80', 'conforming_30y', 'conforming_30y_na', 'jumbo_30y', 'fha_30y', 'va_30y', 'usda_30y', 'conforming_15y', 'ltv_lte80_fico_ge740', 'ltv_lte80_fico_a720b739', 'ltv_lte80_fico_a700b719', 'ltv_lte80_fico_a680b699', 'ltv_lte80_fico_lt680', 'ltv_gt80_fico_ge740', 'ltv_gt80_fico_a720b739', 'ltv_gt80_fico_a700b719', 'ltv_gt80_fico_a680b699', 'ltv_gt80_fico_lt680'], str] The specific index, or index group, to query. Default is the 'primary' group. Multiple comma separated items allowed. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily 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 - (provider: fred) + Frequency aggregation to convert daily 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 + (provider: fred) aggregation_method : Literal['avg', 'sum', 'eop'] - A key that indicates the aggregation method used for frequency aggregation. - This parameter has no affect if the frequency parameter is not set, default is 'avg'. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + This parameter has no affect if the frequency parameter is not set, default is 'avg'. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[MortgageIndices] + results : list[MortgageIndices] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -442,59 +442,59 @@ class ROUTER_fixedincome(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve', 'fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[SOFR] + results : list[SOFR] Serializable results. - provider : Optional[Literal['federal_reserve', 'fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/fixedincome_corporate.py b/openbb_platform/openbb/package/fixedincome_corporate.py index 831738876cd..b956c5af2ee 100644 --- a/openbb_platform/openbb/package/fixedincome_corporate.py +++ b/openbb_platform/openbb/package/fixedincome_corporate.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from warnings import simplefilter, warn from openbb_core.app.deprecation import OpenBBDeprecationWarning @@ -55,63 +55,63 @@ class ROUTER_fixedincome_corporate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. maturity : Union[str, Literal['all', 'overnight', '7d', '15d', '30d', '60d', '90d']] A target maturity. Multiple comma separated items allowed. (provider: fred) category : Union[str, Literal['all', 'asset_backed', 'financial', 'nonfinancial', 'a2p2']] The category of asset. Multiple comma separated items allowed. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[CommercialPaper] + results : list[CommercialPaper] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -190,7 +190,7 @@ class ROUTER_fixedincome_corporate(Container): def hqm( self, date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. Multiple comma separated items allowed for provider(s): fred." ), @@ -213,22 +213,22 @@ class ROUTER_fixedincome_corporate(Container): Parameters ---------- - date : Union[date, str, None, List[Union[date, str, None]]] - A specific date to get data for. Multiple comma separated items allowed for provider(s): fred. - provider : Optional[Literal['fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. + date : Union[date, str, None, list[Union[date, str, None]]] + A specific date to get data for. Multiple comma separated items allowed for provider(s): fred. yield_curve : Literal['spot', 'par'] The yield curve type. (provider: fred) Returns ------- OBBject - results : List[HighQualityMarketCorporateBond] + results : list[HighQualityMarketCorporateBond] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -309,14 +309,14 @@ class ROUTER_fixedincome_corporate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. index_type : Literal['yield', 'yield_to_worst', 'total_return', 'spread'] The type of series. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. category : Literal['all', 'duration', 'eur', 'usd'] The type of category. (provider: fred) area : Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us'] @@ -329,12 +329,12 @@ class ROUTER_fixedincome_corporate(Container): Returns ------- OBBject - results : List[ICEBofA] + results : list[ICEBofA] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -417,26 +417,26 @@ class ROUTER_fixedincome_corporate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. index_type : Literal['aaa', 'baa'] The type of series. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. spread : Optional[Literal['treasury', 'fed_funds']] The type of spread. (provider: fred) Returns ------- OBBject - results : List[MoodyCorporateBondIndex] + results : list[MoodyCorporateBondIndex] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -495,15 +495,15 @@ class ROUTER_fixedincome_corporate(Container): OpenBBField(description="End date of the data, in YYYY-MM-DD format."), ] = None, maturity: Annotated[ - Union[float, str, List[Union[float, str]]], + Union[float, str, list[Union[float, str]]], OpenBBField( description="Maturities in years. Multiple comma separated items allowed for provider(s): fred." ), ] = 10.0, category: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( - description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred." + description="Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.\nChoices for fred: 'par_yield', 'spot_rate'" ), ] = "spot_rate", provider: Annotated[ @@ -524,26 +524,27 @@ class ROUTER_fixedincome_corporate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - maturity : Union[float, str, List[Union[float, str]]] + maturity : Union[float, str, list[Union[float, str]]] Maturities in years. Multiple comma separated items allowed for provider(s): fred. - category : Union[str, List[str]] + category : Union[str, list[str]] Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. + Choices for fred: 'par_yield', 'spot_rate' Returns ------- OBBject - results : List[SpotRate] + results : list[SpotRate] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/fixedincome_government.py b/openbb_platform/openbb/package/fixedincome_government.py index 02a2ccb04cd..9740764f8a3 100644 --- a/openbb_platform/openbb/package/fixedincome_government.py +++ b/openbb_platform/openbb/package/fixedincome_government.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -45,59 +45,59 @@ class ROUTER_fixedincome_government(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. maturity : Optional[Literal[5, 10, 20, 30]] The maturity of the security in years - 5, 10, 20, 30 - defaults to all. Note that the maturity is the tenor of the security, not the time to maturity. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] 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 - (provider: fred) + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca']] 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[TipsYields] + results : list[TipsYields] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -165,22 +165,22 @@ class ROUTER_fixedincome_government(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fmp. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve', 'fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fmp. Returns ------- OBBject - results : List[TreasuryRates] + results : list[TreasuryRates] Serializable results. - provider : Optional[Literal['federal_reserve', 'fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -246,7 +246,7 @@ class ROUTER_fixedincome_government(Container): def yield_curve( self, date: Annotated[ - Union[datetime.date, str, None, List[Union[datetime.date, str, None]]], + Union[datetime.date, str, None, list[Union[datetime.date, str, None]]], OpenBBField( description="A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): econdb, federal_reserve, fmp, fred." ), @@ -263,10 +263,10 @@ class ROUTER_fixedincome_government(Container): Parameters ---------- - date : Union[date, str, None, List[Union[date, str, None]]] - A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): econdb, federal_reserve, fmp, fred. - provider : Optional[Literal['econdb', 'federal_reserve', 'fmp', 'fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, federal_reserve, fmp, fred. + date : Union[date, str, None, list[Union[date, str, None]]] + A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): econdb, federal_reserve, fmp, fred. country : str The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. Multiple comma separated items allowed. (provider: econdb) use_cache : bool @@ -277,12 +277,12 @@ class ROUTER_fixedincome_government(Container): Returns ------- OBBject - results : List[YieldCurve] + results : list[YieldCurve] Serializable results. - provider : Optional[Literal['econdb', 'federal_reserve', 'fmp', 'fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/fixedincome_rate.py b/openbb_platform/openbb/package/fixedincome_rate.py index 83a83ff45c1..5449b1cd172 100644 --- a/openbb_platform/openbb/package/fixedincome_rate.py +++ b/openbb_platform/openbb/package/fixedincome_rate.py @@ -57,61 +57,61 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. maturity : Union[Literal['all', 'overnight', 'average_30d', 'average_90d', 'term_30d', 'term_90d'], str] Period of AMERIBOR rate. Multiple comma separated items allowed. (provider: fred) frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[Ameribor] + results : list[Ameribor] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -201,24 +201,24 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. parameter : Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual'] FRED series ID of DWPCR data. (provider: fred) Returns ------- OBBject - results : List[DiscountWindowPrimaryCreditRate] + results : list[DiscountWindowPrimaryCreditRate] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -292,24 +292,24 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. interest_rate_type : Literal['deposit', 'lending', 'refinancing'] The type of interest rate. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[EuropeanCentralBankInterestRates] + results : list[EuropeanCentralBankInterestRates] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -376,61 +376,61 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve', 'fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) effr_only : bool Return data without quantiles, target ranges, and volume. (provider: fred) Returns ------- OBBject - results : List[FederalFundsRate] + results : list[FederalFundsRate] Serializable results. - provider : Optional[Literal['federal_reserve', 'fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -512,7 +512,7 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- - provider : Optional[Literal['fred']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. long_run : bool Flag to show long run projections (provider: fred) @@ -520,12 +520,12 @@ class ROUTER_fixedincome_rate(Container): Returns ------- OBBject - results : List[PROJECTIONS] + results : list[PROJECTIONS] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -602,83 +602,83 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] Frequency aggregation to convert daily data to lower frequency. - a = Annual + a = Annual - q = Quarterly + q = Quarterly - m = Monthly + m = Monthly - w = Weekly + w = Weekly - d = Daily + d = Daily - wef = Weekly, Ending Friday + wef = Weekly, Ending Friday - weth = Weekly, Ending Thursday + weth = Weekly, Ending Thursday - wew = Weekly, Ending Wednesday + wew = Weekly, Ending Wednesday - wetu = Weekly, Ending Tuesday + wetu = Weekly, Ending Tuesday - wem = Weekly, Ending Monday + wem = Weekly, Ending Monday - wesu = Weekly, Ending Sunday + wesu = Weekly, Ending Sunday - wesa = Weekly, Ending Saturday + wesa = Weekly, Ending Saturday - bwew = Biweekly, Ending Wednesday + bwew = Biweekly, Ending Wednesday - bwem = Biweekly, Ending Monday - (provider: fred) + bwem = Biweekly, Ending Monday + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] A key that indicates the aggregation method used for frequency aggregation. - avg = Average + avg = Average - sum = Sum + sum = Sum - eop = End of Period - (provider: fred) + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] Transformation type - None = No transformation + None = No transformation - chg = Change + chg = Change - ch1 = Change from Year Ago + ch1 = Change from Year Ago - pch = Percent Change + pch = Percent Change - pc1 = Percent Change from Year Ago + pc1 = Percent Change from Year Ago - pca = Compounded Annual Rate of Change + pca = Compounded Annual Rate of Change - cch = Continuously Compounded Rate of Change + cch = Continuously Compounded Rate of Change - cca = Continuously Compounded Annual Rate of Change + cca = Continuously Compounded Annual Rate of Change - log = Natural Log - (provider: fred) + log = Natural Log + (provider: fred) Returns ------- OBBject - results : List[EuroShortTermRate] + results : list[EuroShortTermRate] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -757,22 +757,22 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[IORB] + results : list[IORB] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -838,59 +838,59 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve', 'fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[OvernightBankFundingRate] + results : list[OvernightBankFundingRate] Serializable results. - provider : Optional[Literal['federal_reserve', 'fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -967,59 +967,59 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['federal_reserve', 'fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fred. frequency : Optional[Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']] - Frequency aggregation to convert daily data to lower frequency. - a = Annual - q = Quarterly - m = Monthly - w = Weekly - 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 - (provider: fred) + Frequency aggregation to convert daily data to lower frequency. + a = Annual + q = Quarterly + m = Monthly + w = Weekly + 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 + (provider: fred) aggregation_method : Optional[Literal['avg', 'sum', 'eop']] - A key that indicates the aggregation method used for frequency aggregation. - avg = Average - sum = Sum - eop = End of Period - (provider: fred) + A key that indicates the aggregation method used for frequency aggregation. + avg = Average + sum = Sum + eop = End of Period + (provider: fred) transform : Optional[Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']] - 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 - (provider: fred) + 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 + (provider: fred) Returns ------- OBBject - results : List[SOFR] + results : list[SOFR] Serializable results. - provider : Optional[Literal['federal_reserve', 'fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -1103,24 +1103,24 @@ class ROUTER_fixedincome_rate(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. parameter : Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value'] Period of SONIA rate. (provider: fred) Returns ------- OBBject - results : List[SONIA] + results : list[SONIA] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/fixedincome_spreads.py b/openbb_platform/openbb/package/fixedincome_spreads.py index 85a2afd0e42..680c0eecc0b 100644 --- a/openbb_platform/openbb/package/fixedincome_spreads.py +++ b/openbb_platform/openbb/package/fixedincome_spreads.py @@ -54,24 +54,24 @@ class ROUTER_fixedincome_spreads(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. maturity : Optional[Literal['3m', '2y']] The maturity - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[TreasuryConstantMaturity] + results : list[TreasuryConstantMaturity] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -144,24 +144,24 @@ class ROUTER_fixedincome_spreads(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. maturity : Optional[Literal['10y', '5y', '1y', '6m', '3m']] The maturity - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[SelectedTreasuryConstantMaturity] + results : list[SelectedTreasuryConstantMaturity] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -234,24 +234,24 @@ class ROUTER_fixedincome_spreads(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. maturity : Optional[Literal['3m', '6m']] The maturity - provider : Optional[Literal['fred']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred. Returns ------- OBBject - results : List[SelectedTreasuryBill] + results : list[SelectedTreasuryBill] Serializable results. - provider : Optional[Literal['fred']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/index.py b/openbb_platform/openbb/package/index.py index 552ef56f7c4..5b269d73c50 100644 --- a/openbb_platform/openbb/package/index.py +++ b/openbb_platform/openbb/package/index.py @@ -36,18 +36,18 @@ class ROUTER_index(Container): Parameters ---------- - provider : Optional[Literal['fmp', 'yfinance']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, yfinance. Returns ------- OBBject - results : List[AvailableIndices] + results : list[AvailableIndices] Serializable results. - provider : Optional[Literal['fmp', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -107,20 +107,20 @@ class ROUTER_index(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. symbol : str Symbol to get data for. - provider : Optional[Literal['fmp']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. Returns ------- OBBject - results : List[IndexConstituents] + results : list[IndexConstituents] Serializable results. - provider : Optional[Literal['fmp']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/index_price.py b/openbb_platform/openbb/package/index_price.py index 00106a55368..50cd86035b4 100644 --- a/openbb_platform/openbb/package/index_price.py +++ b/openbb_platform/openbb/package/index_price.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from openbb_core.app.model.field import OpenBBField from openbb_core.app.model.obbject import OBBject @@ -24,7 +24,7 @@ class ROUTER_index_price(Container): def historical( self, symbol: Annotated[ - Union[str, List[str]], + Union[str, list[str]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance." ), @@ -49,16 +49,18 @@ class ROUTER_index_price(Container): Parameters ---------- - symbol : Union[str, List[str]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. + symbol : Union[str, list[str]] Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon, yfinance. - interval : Union[Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d'], str, Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']] + interval : str Time interval of the data to return. (provider: fmp, polygon, yfinance) + Choices for fmp: '1m', '5m', '15m', '30m', '1h', '4h', '1d' + Choices for yfinance: '1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q' limit : Optional[int] The number of data entries to return. (provider: intrinio, polygon) sort : Literal['asc', 'desc'] @@ -67,12 +69,12 @@ class ROUTER_index_price(Container): Returns ------- OBBject - results : List[IndexHistorical] + results : list[IndexHistorical] Serializable results. - provider : Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/news.py b/openbb_platform/openbb/package/news.py index 8946aa299c3..cf2fbf9dc6a 100644 --- a/openbb_platform/openbb/package/news.py +++ b/openbb_platform/openbb/package/news.py @@ -1,7 +1,7 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### import datetime -from typing import List, Literal, Optional, Union +from typing import Literal, Optional, Union from annotated_types import Ge from openbb_core.app.model.field import OpenBBField @@ -26,7 +26,7 @@ class ROUTER_news(Container): def company( self, symbol: Annotated[ - Union[str, None, List[Optional[str]]], + Union[str, None, list[Optional[str]]], OpenBBField( description="Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance." ), @@ -57,7 +57,9 @@ class ROUTER_news(Container): Parameters ---------- - symbol : Union[str, None, List[Optional[str]]] + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp, intrinio, polygon, tiingo, yfinance. + symbol : Union[str, None, list[Optional[str]]] Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. @@ -65,9 +67,7 @@ class ROUTER_news(Container): End date of the data, in YYYY-MM-DD format. limit : Optional[Annotated[int, Ge(ge=0)]] The number of data entries to return. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp, intrinio, polygon, tiingo, yfinance. - date : Optional[datetime.date] + date : Optional[date] A specific date to get data for. (provider: benzinga) display : Literal['headline', 'abstract', 'full'] Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) @@ -78,8 +78,7 @@ class ROUTER_news(Container): sort : Literal['id', 'created', 'updated'] Key to sort the news by. (provider: benzinga) order : Literal['asc', 'desc'] - Order to sort the news by. (provider: benzinga); - Sort order of the articles. (provider: polygon) + Order to sort the news by. (provider: benzinga) isin : Optional[str] The company's ISIN. (provider: benzinga) cusip : Optional[str] @@ -94,9 +93,8 @@ class ROUTER_news(Container): Content types of the news to retrieve. (provider: benzinga) page : Optional[int] Page number of the results. Use in combination with limit. (provider: fmp) - source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] - The source of the news article. (provider: intrinio); - A comma-separated list of the domains requested. Multiple comma separated items allowed. (provider: tiingo) + source : Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], None, str] + The source of the news article. (provider: intrinio) sentiment : Optional[Literal['positive', 'neutral', 'negative']] Return news only from this source. (provider: intrinio) language : Optional[str] @@ -119,12 +117,12 @@ class ROUTER_news(Container): Returns ------- OBBject - results : List[CompanyNews] + results : list[CompanyNews] Serializable results. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -138,7 +136,7 @@ class ROUTER_news(Container): Title of the article. text : Optional[str] Text/body of the article. - images : Optional[List[Dict[str, str]]] + images : Optional[list[Dict[str, str]]] Images associated with the article. url : str URL to the article. @@ -171,7 +169,7 @@ class ROUTER_news(Container): word_count : Optional[int] The word count of the news article. (provider: intrinio) business_relevance : Optional[float] - How strongly correlated the news article is to the business (provider: intrinio) + How strongly correlated the news article is to the business (provider: intrinio) sentiment : Optional[str] The sentiment of the news article - i.e, negative, positive. (provider: intrinio) sentiment_confidence : Optional[float] @@ -299,15 +297,15 @@ class ROUTER_news(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp, intrinio, tiingo. limit : int The number of data entries to return. The number of articles to return. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga, fmp, intrinio, tiingo. - date : Optional[datetime.date] + date : Optional[date] A specific date to get data for. (provider: benzinga) display : Literal['headline', 'abstract', 'full'] Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga) @@ -331,9 +329,8 @@ class ROUTER_news(Container): Authors of the news to retrieve. (provider: benzinga) content_types : Optional[str] Content types of the news to retrieve. (provider: benzinga) - source : Optional[Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], str]] - The source of the news article. (provider: intrinio); - A comma-separated list of the domains requested. Multiple comma separated items allowed. (provider: tiingo) + source : Union[Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases'], None, str] + The source of the news article. (provider: intrinio) sentiment : Optional[Literal['positive', 'neutral', 'negative']] Return news only from this source. (provider: intrinio) language : Optional[str] @@ -356,12 +353,12 @@ class ROUTER_news(Container): Returns ------- OBBject - results : List[WorldNews] + results : list[WorldNews] Serializable results. - provider : Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -373,7 +370,7 @@ class ROUTER_news(Container): The date of the data. The published date of the article. title : str Title of the article. - images : Optional[List[Dict[str, str]]] + images : Optional[list[Dict[str, str]]] Images associated with the article. text : Optional[str] Text/body of the article. @@ -404,7 +401,7 @@ class ROUTER_news(Container): word_count : Optional[int] The word count of the news article. (provider: intrinio) business_relevance : Optional[float] - How strongly correlated the news article is to the business (provider: intrinio) + How strongly correlated the news article is to the business (provider: intrinio) sentiment : Optional[str] The sentiment of the news article - i.e, negative, positive. (provider: intrinio) sentiment_confidence : Optional[float] diff --git a/openbb_platform/openbb/package/regulators_cftc.py b/openbb_platform/openbb/package/regulators_cftc.py index 16fa2371899..8136f0b82c8 100644 --- a/openbb_platform/openbb/package/regulators_cftc.py +++ b/openbb_platform/openbb/package/regulators_cftc.py @@ -52,36 +52,36 @@ class ROUTER_regulators_cftc(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cftc. id : str A string with the CFTC market code or other identifying string, such as the contract market name, commodity name, or commodity group - i.e, 'gold' or 'japanese yen'.Default report is Fed Funds Futures. Use the 'cftc_market_code' for an exact match. start_date : Union[date, None, str] Start date of the data, in YYYY-MM-DD format. Default is the most recent report. end_date : Union[date, None, str] End date of the data, in YYYY-MM-DD format. - provider : Optional[Literal['cftc']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cftc. report_type : Literal['legacy', 'disaggregated', 'financial', 'supplemental'] The type of report to retrieve. Set `id` as 'all' to return all items in the report - type (default date range returns the latest report). The Legacy report is broken down by exchange - with reported open interest further broken down into three trader classifications: commercial, - non-commercial and non-reportable. The Disaggregated reports are broken down by Agriculture and - Natural Resource contracts. The Disaggregated reports break down reportable open interest positions - into four classifications: Producer/Merchant, Swap Dealers, Managed Money and Other Reportables. - The Traders in Financial Futures (TFF) report includes financial contracts. The TFF report breaks - down the reported open interest into five classifications: Dealer, Asset Manager, Leveraged Money, - Other Reportables and Non-Reportables. (provider: cftc) + type (default date range returns the latest report). The Legacy report is broken down by exchange + with reported open interest further broken down into three trader classifications: commercial, + non-commercial and non-reportable. The Disaggregated reports are broken down by Agriculture and + Natural Resource contracts. The Disaggregated reports break down reportable open interest positions + into four classifications: Producer/Merchant, Swap Dealers, Managed Money and Other Reportables. + The Traders in Financial Futures (TFF) report includes financial contracts. The TFF report breaks + down the reported open interest into five classifications: Dealer, Asset Manager, Leveraged Money, + Other Reportables and Non-Reportables. (provider: cftc) futures_only : bool Returns the futures-only report. Default is False, for the combined report. (provider: cftc) Returns ------- OBBject - results : List[COT] + results : list[COT] Serializable results. - provider : Optional[Literal['cftc']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -187,20 +187,20 @@ class ROUTER_regulators_cftc(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cftc. query : str Search query. - provider : Optional[Literal['cftc']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cftc. Returns ------- OBBject - results : List[COTSearch] + results : list[COTSearch] Serializable results. - provider : Optional[Literal['cftc']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] diff --git a/openbb_platform/openbb/package/regulators_sec.py b/openbb_platform/openbb/package/regulators_sec.py index 12d13e47b36..f5bc7fba13a 100644 --- a/openbb_platform/openbb/package/regulators_sec.py +++ b/openbb_platform/openbb/package/regulators_sec.py @@ -42,10 +42,10 @@ class ROUTER_regulators_sec(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. symbol : str Symbol to get data for. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. use_cache : Optional[bool] Whether or not to use cache for the request, default is True. (provider: sec) @@ -54,10 +54,10 @@ class ROUTER_regulators_sec(Container): OBBject results : CikMap Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -107,7 +107,7 @@ class ROUTER_regulators_sec(Container): Parameters ---------- - provider : Optional[Literal['sec']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. url : str URL for the SEC filing. The specific URL is not directly used or downloaded, but is used to generate the base URL for the filing. e.g. https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/coke-20240731.htm and https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/ are both valid URLs for the same filing. (provider: sec) @@ -119,10 +119,10 @@ class ROUTER_regulators_sec(Container): OBBject results : SecFiling Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -157,7 +157,7 @@ class ROUTER_regulators_sec(Container): cover_page : Optional[dict] Cover page information, if available. (provider: sec) document_urls : Optional[list] - List of files associated with the filing. (provider: sec) + list of files associated with the filing. (provider: sec) Examples -------- @@ -197,7 +197,7 @@ class ROUTER_regulators_sec(Container): Parameters ---------- - provider : Optional[Literal['sec']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. url : str URL for the SEC filing. (provider: sec) @@ -209,10 +209,10 @@ class ROUTER_regulators_sec(Container): OBBject results : SecHtmFile Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -263,22 +263,22 @@ class ROUTER_regulators_sec(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. query : str Search query. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. use_cache : Optional[bool] Whether or not to use cache. (provider: sec) Returns ------- OBBject - results : List[InstitutionsSearch] + results : list[InstitutionsSearch] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -331,18 +331,18 @@ class ROUTER_regulators_sec(Container): Parameters ---------- - provider : Optional[Literal['sec']] + provider : str The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. Returns ------- OBBject - results : List[RssLitigation] + results : list[RssLitigation] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -399,10 +399,10 @@ class ROUTER_regulators_sec(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. query : str Search query. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. url : Optional[str] Enter an optional URL path to fetch the next level. (provider: sec) use_cache : Optional[bool] @@ -413,10 +413,10 @@ class ROUTER_regulators_sec(Container): OBBject results : SchemaFiles Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -424,7 +424,7 @@ class ROUTER_regulators_sec(Container): SchemaFiles ----------- - files : Optional[List[str]] + files : Optional[list[str]] Dictionary of URLs to SEC Schema Files (provider: sec) Examples @@ -440,7 +440,7 @@ class ROUTER_regulators_sec(Container): >>> # The URL base will always be the 0 position in the list, feed the URL back in as a parameter. >>> obb.regulators.sec.schema_files(url=url).results.files >>> ['https://xbrl.fasb.org/us-gaap/2024/' - >>> 'USGAAP2024FileList.xml' + >>> 'USGAAP2024Filelist.xml' >>> 'dis/' >>> 'dqcrules/' >>> 'ebp/' @@ -485,22 +485,22 @@ class ROUTER_regulators_sec(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. query : str Search query. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. use_cache : Optional[bool] Whether or not to use cache. (provider: sec) Returns ------- OBBject - results : List[SicSearch] + results : list[SicSearch] Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any] @@ -562,22 +562,22 @@ class ROUTER_regulators_sec(Container): Parameters ---------- + provider : str + The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. query : str Search query. use_cache : Optional[bool] Whether or not to use cache. If True, cache will store for seven days. - provider : Optional[Literal['sec']] - The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec. Returns ------- OBBject results : SymbolMap Serializable results. - provider : Optional[Literal['sec']] + provider : Optional[str] Provider name. - warnings : Optional[List[Warning_]] - List of warnings. + warnings : Optional[list[Warning_]] + list of warnings. chart : Optional[Chart] Chart object. extra : Dict[str, Any]