{ "openbb": "4.4.4", "info": { "title": "OpenBB Platform (Python)", "description": "Investment research for everyone, anywhere.", "core": "1.4.7", "extensions": { "openbb_core_extension": [ "commodity@1.3.1", "crypto@1.4.1", "currency@1.4.1", "derivatives@1.4.1", "economy@1.4.2", "equity@1.4.1", "etf@1.4.1", "fixedincome@1.4.3", "index@1.4.1", "news@1.4.1", "regulators@1.4.2" ], "openbb_provider_extension": [ "benzinga@1.4.1", "bls@1.1.2", "cftc@1.1.1", "econdb@1.3.1", "federal_reserve@1.4.2", "fmp@1.4.2", "fred@1.4.4", "imf@1.1.1", "intrinio@1.4.1", "oecd@1.4.1", "polygon@1.4.1", "sec@1.4.3", "tiingo@1.4.1", "tradingeconomics@1.4.1", "us_eia@1.1.1", "yfinance@1.4.6" ], "openbb_obbject_extension": [] } }, "paths": { "/commodity/price/spot": { "deprecated": { "flag": null, "message": null }, "description": "Commodity Spot Prices.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.commodity.price.spot(provider='fred')\nobb.commodity.price.spot(provider='fred', commodity=wti)\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "commodity", "type": "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']", "description": "Commodity name associated with the EIA spot price commodity data, default is 'all'.", "default": "all", "optional": true, "choices": [ "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" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period", "default": "eop", "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CommoditySpotPrices]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "commodity", "type": "str", "description": "Commodity name.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Price of the commodity.", "default": "", "optional": false, "choices": null }, { "name": "unit", "type": "str", "description": "Unit of the commodity price.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "CommoditySpotPrices", "openapi_extra": { "model": "CommoditySpotPrices" } }, "/commodity/petroleum_status_report": { "deprecated": { "flag": null, "message": null }, "description": "EIA Weekly Petroleum Status Report.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the EIA's Weekly Petroleum Status Report.\nobb.commodity.petroleum_status_report(provider='eia')\n# Select the category of data, and filter for a specific table within the report.\nobb.commodity.petroleum_status_report(category=weekly_estimates, table=imports, provider='eia')\n```\n\n", "parameters": { "standard": [ { "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 } ], "eia": [ { "name": "category", "type": "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']", "description": "The group of data to be returned. The default is the balance sheet.", "default": "balance_sheet", "optional": true, "choices": [ "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" ] }, { "name": "table", "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, "choices": [ "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" ] }, { "name": "use_cache", "type": "bool", "description": "Subsequent requests for the same source data are cached for the session using ALRU cache.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PetroleumStatusReport]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['eia']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "table", "type": "str", "description": "Table name for the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "order", "type": "int", "description": "Presented order of the data, relative to the table.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "Title of the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "Value of the data.", "default": "", "optional": false, "choices": null }, { "name": "unit", "type": "str", "description": "Unit or scale of the data.", "default": null, "optional": true, "choices": null } ], "eia": [] }, "model": "PetroleumStatusReport", "openapi_extra": { "model": "PetroleumStatusReport" } }, "/commodity/short_term_energy_outlook": { "deprecated": { "flag": null, "message": null }, "description": "Monthly short term (18 month) projections using EIA's STEO model.\n\nSource: www.eia.gov/steo/", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the EIA's Short Term Energy Outlook.\nobb.commodity.short_term_energy_outlook(provider='eia')\n# Select the specific table of data from the STEO. Table 03d is World Crude Oil Production.\nobb.commodity.short_term_energy_outlook(table=03d, provider='eia')\n```\n\n", "parameters": { "standard": [ { "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 } ], "eia": [ { "name": "symbol", "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, "choices": null }, { "name": "table", "type": "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']", "description": "The specific table within the STEO dataset. Default is '01'. When 'symbol' is provided, this parameter is ignored.\n 01: US Energy Markets Summary\n 02: Nominal Energy Prices\n 03a: World Petroleum and Other Liquid Fuels Production, Consumption, and Inventories\n 03b: Non-OPEC Petroleum and Other Liquid Fuels Production\n 03c: World Petroleum and Other Liquid Fuels Production\n 03d: World Crude Oil Production\n 03e: World Petroleum and Other Liquid Fuels Consumption\n 04a: US Petroleum and Other Liquid Fuels Supply, Consumption, and Inventories\n 04b: US Hydrocarbon Gas Liquids (HGL) and Petroleum Refinery Balances\n 04c: US Regional Motor Gasoline Prices and Inventories\n 04d: US Biofuel Supply, Consumption, and Inventories\n 05a: US Natural Gas Supply, Consumption, and Inventories\n 05b: US Regional Natural Gas Prices\n 06: US Coal Supply, Consumption, and Inventories\n 07a: US Electricity Industry Overview\n 07b: US Regional Electricity Retail Sales\n 07c: US Regional Electricity Prices\n 07d1: US Regional Electricity Generation, Electric Power Sector\n 07d2: US Regional Electricity Generation, Electric Power Sector, continued\n 07e: US Electricity Generating Capacity\n 08: US Renewable Energy Consumption\n 09a: US Macroeconomic Indicators and CO2 Emissions\n 09b: US Regional Macroeconomic Data\n 09c: US Regional Weather Data\n 10a: Drilling Productivity Metrics\n 10b: Crude Oil and Natural Gas Production from Shale and Tight Formations", "default": "01", "optional": true, "choices": [ "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" ] }, { "name": "frequency", "type": "Literal['month', 'quarter', 'annual']", "description": "The frequency of the data. Default is 'month'.", "default": "month", "optional": true, "choices": [ "month", "quarter", "annual" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ShortTermEnergyOutlook]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['eia']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "table", "type": "str", "description": "Table name for the data.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "order", "type": "int", "description": "Presented order of the data, relative to the table.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "Title of the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "Value of the data.", "default": "", "optional": false, "choices": null }, { "name": "unit", "type": "str", "description": "Unit or scale of the data.", "default": null, "optional": true, "choices": null } ], "eia": [] }, "model": "ShortTermEnergyOutlook", "openapi_extra": { "model": "ShortTermEnergyOutlook" } }, "/crypto/price/historical": { "deprecated": { "flag": null, "message": null }, "description": "Get historical price data for cryptocurrency pair(s) within a provider.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.price.historical(symbol='BTCUSD', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31', provider='fmp')\nobb.crypto.price.historical(symbol='BTCUSD,ETHUSD', start_date='2024-01-01', end_date='2024-01-31', provider='polygon')\n# Get monthly historical prices from Yahoo Finance for Ethereum.\nobb.crypto.price.historical(symbol='ETH-USD', interval=1m, start_date='2024-01-01', end_date='2024-12-31', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "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, "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 } ], "fmp": [ { "name": "interval", "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ] } ], "polygon": [ { "name": "interval", "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, "optional": true, "choices": null } ], "tiingo": [ { "name": "interval", "type": "Union[Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '7d', '30d'], str]", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "90m", "1h", "2h", "4h", "1d", "7d", "30d" ] }, { "name": "exchanges", "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, "choices": null } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1W", "1M", "1Q" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CryptoHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[Union[date, datetime], str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", "optional": false, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", "optional": false, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", "optional": false, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "transactions", "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null } ], "tiingo": [ { "name": "transactions", "type": "int", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null }, { "name": "volume_notional", "type": "float", "description": "The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "CryptoHistorical", "openapi_extra": { "model": "CryptoHistorical" } }, "/crypto/search": { "deprecated": { "flag": null, "message": null }, "description": "Search available cryptocurrency pairs within a provider.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.crypto.search(provider='fmp')\nobb.crypto.search(query='BTCUSD', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CryptoSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data. (Crypto)", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the crypto.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "currency", "type": "str", "description": "The currency the crypto trades for.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the crypto trades on.", "default": null, "optional": true, "choices": null }, { "name": "exchange_name", "type": "str", "description": "The short name of the exchange the crypto trades on.", "default": null, "optional": true, "choices": null } ] }, "model": "CryptoSearch", "openapi_extra": { "model": "CryptoSearch" } }, "/currency/price/historical": { "deprecated": { "flag": null, "message": null }, "description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.price.historical(symbol='EURUSD', provider='fmp')\n# Filter historical data with specific start and end date.\nobb.currency.price.historical(symbol='EURUSD', start_date='2023-01-01', end_date='2023-12-31', provider='fmp')\n# Get data with different granularity.\nobb.currency.price.historical(symbol='EURUSD', provider='polygon', interval=15m)\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "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, "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 } ], "fmp": [ { "name": "interval", "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ] } ], "polygon": [ { "name": "interval", "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, "optional": true, "choices": null } ], "tiingo": [ { "name": "interval", "type": "Union[Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '5d', '21d'], str]", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "90m", "1h", "2h", "4h", "1d", "5d", "21d" ] } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1W", "1M", "1Q" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CurrencyHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[Union[date, datetime], str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", "optional": false, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", "optional": false, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", "optional": false, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "vwap", "type": "Annotated[float, Gt(gt=0)]", "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "transactions", "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null } ], "tiingo": [], "yfinance": [] }, "model": "CurrencyHistorical", "openapi_extra": { "model": "CurrencyHistorical" } }, "/currency/search": { "deprecated": { "flag": null, "message": null }, "description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.search(provider='fmp')\n# Search for 'EUR' currency pair using 'intrinio' as provider.\nobb.currency.search(provider='intrinio', query='EUR')\n# Search for terms using 'polygon' as provider.\nobb.currency.search(provider='polygon', query='EUR')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Query to search for currency pairs.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [], "polygon": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CurrencyPairs]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the currency pair.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "Symbol of the currency pair.", "default": "", "optional": false, "choices": null }, { "name": "currency", "type": "str", "description": "Base currency of the currency pair.", "default": "", "optional": false, "choices": null }, { "name": "stock_exchange", "type": "str", "description": "Stock exchange of the currency pair.", "default": null, "optional": true, "choices": null }, { "name": "exchange_short_name", "type": "str", "description": "Short name of the stock exchange of the currency pair.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "base_currency", "type": "str", "description": "ISO 4217 currency code of the base currency.", "default": "", "optional": false, "choices": null }, { "name": "quote_currency", "type": "str", "description": "ISO 4217 currency code of the quote currency.", "default": "", "optional": false, "choices": null } ], "polygon": [ { "name": "currency_symbol", "type": "str", "description": "The symbol of the quote currency.", "default": null, "optional": true, "choices": null }, { "name": "base_currency_symbol", "type": "str", "description": "The symbol of the base currency.", "default": null, "optional": true, "choices": null }, { "name": "base_currency_name", "type": "str", "description": "Name of the base currency.", "default": null, "optional": true, "choices": null }, { "name": "market", "type": "str", "description": "Name of the trading market. Always 'fx'.", "default": "", "optional": false, "choices": null }, { "name": "locale", "type": "str", "description": "Locale of the currency pair.", "default": "", "optional": false, "choices": null }, { "name": "last_updated", "type": "date", "description": "The date the reference data was last updated.", "default": null, "optional": true, "choices": null }, { "name": "delisted", "type": "date", "description": "The date the item was delisted.", "default": null, "optional": true, "choices": null } ] }, "model": "CurrencyPairs", "openapi_extra": { "model": "CurrencyPairs" } }, "/currency/snapshots": { "deprecated": { "flag": null, "message": null }, "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.currency.snapshots(provider='fmp')\n# Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.\nobb.currency.snapshots(provider='fmp', base='USD,XAU', counter_currencies='EUR,JPY,GBP', quote_type='indirect')\n```\n\n", "parameters": { "standard": [ { "name": "base", "type": "Union[str, list[str]]", "description": "The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.", "default": "usd", "optional": true, "choices": null }, { "name": "quote_type", "type": "Literal['direct', 'indirect']", "description": "Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.", "default": "indirect", "optional": true, "choices": null }, { "name": "counter_currencies", "type": "Union[str, list[str]]", "description": "An optional list of counter currency symbols to filter for. None returns all.", "default": null, "optional": true, "choices": null } ], "fmp": [], "polygon": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CurrencySnapshots]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'polygon']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "base_currency", "type": "str", "description": "The base, or domestic, currency.", "default": "", "optional": false, "choices": null }, { "name": "counter_currency", "type": "str", "description": "The counter, or foreign, currency.", "default": "", "optional": false, "choices": null }, { "name": "last_rate", "type": "float", "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, "optional": true, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "change", "type": "float", "description": "The change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "The change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "The 50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "The 200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low.", "default": null, "optional": true, "choices": null }, { "name": "last_rate_timestamp", "type": "datetime", "description": "The timestamp of the last rate.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "vwap", "type": "float", "description": "The volume-weighted average price.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "The change in price from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "The percentage change in price from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "prev_open", "type": "float", "description": "The previous day's opening price.", "default": null, "optional": true, "choices": null }, { "name": "prev_high", "type": "float", "description": "The previous day's high price.", "default": null, "optional": true, "choices": null }, { "name": "prev_low", "type": "float", "description": "The previous day's low price.", "default": null, "optional": true, "choices": null }, { "name": "prev_volume", "type": "float", "description": "The previous day's volume.", "default": null, "optional": true, "choices": null }, { "name": "prev_vwap", "type": "float", "description": "The previous day's VWAP.", "default": null, "optional": true, "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, "optional": true, "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, "optional": true, "choices": null }, { "name": "minute_open", "type": "float", "description": "The open price from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_high", "type": "float", "description": "The high price from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_low", "type": "float", "description": "The low price from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_close", "type": "float", "description": "The close price from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_volume", "type": "float", "description": "The volume from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_vwap", "type": "float", "description": "The VWAP from the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "minute_transactions", "type": "float", "description": "The number of transactions in the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "quote_timestamp", "type": "datetime", "description": "The timestamp of the last quote.", "default": null, "optional": true, "choices": null }, { "name": "minute_timestamp", "type": "datetime", "description": "The timestamp for the start of the most recent minute bar.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The last time the data was updated.", "default": "", "optional": false, "choices": null } ] }, "model": "CurrencySnapshots", "openapi_extra": { "model": "CurrencySnapshots" } }, "/derivatives/options/chains": { "deprecated": { "flag": null, "message": null }, "description": "Get the complete options chain for a ticker.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.options.chains(symbol='AAPL', provider='intrinio')\n# Use the \"date\" parameter to get the end-of-day-data for a specific date, where supported.\nobb.derivatives.options.chains(symbol='AAPL', date=2023-01-25, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "delay", "type": "Literal['eod', 'realtime', 'delayed']", "description": "Whether to return delayed, realtime, or eod data.", "default": "eod", "optional": true, "choices": [ "eod", "realtime", "delayed" ] }, { "name": "date", "type": "Union[date, str]", "description": "The end-of-day date for options chains data.", "default": null, "optional": true, "choices": null }, { "name": "option_type", "type": "Literal['call', 'put']", "description": "The option type, call or put, 'None' is both (default).", "default": null, "optional": true, "choices": [ "call", "put" ] }, { "name": "moneyness", "type": "Literal['otm', 'itm', 'all']", "description": "Return only contracts that are in or out of the money, default is 'all'. Parameter is ignored when a date is supplied.", "default": "all", "optional": true, "choices": [ "otm", "itm", "all" ] }, { "name": "strike_gt", "type": "int", "description": "Return options with a strike price greater than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "strike_lt", "type": "int", "description": "Return options with a strike price less than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "volume_gt", "type": "int", "description": "Return options with a volume greater than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "volume_lt", "type": "int", "description": "Return options with a volume less than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "oi_gt", "type": "int", "description": "Return options with an open interest greater than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "oi_lt", "type": "int", "description": "Return options with an open interest less than the given value. Parameter is ignored when a date is supplied.", "default": null, "optional": true, "choices": null }, { "name": "model", "type": "Literal['black_scholes', 'bjerk']", "description": "The pricing model to use for options chains data, default is 'black_scholes'. Parameter is ignored when a date is supplied.", "default": "black_scholes", "optional": true, "choices": [ "black_scholes", "bjerk" ] }, { "name": "show_extended_price", "type": "bool", "description": "Whether to include OHLC type fields, default is True. Parameter is ignored when a date is supplied.", "default": true, "optional": true, "choices": null }, { "name": "include_related_symbols", "type": "bool", "description": "Include related symbols that end in a 1 or 2 because of a corporate action, default is False.", "default": false, "optional": true, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[OptionsChains]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "underlying_symbol", "type": "list[str]", "description": "Underlying symbol for the option.", "default": "", "optional": true, "choices": null }, { "name": "underlying_price", "type": "list[float]", "description": "Price of the underlying stock.", "default": "", "optional": true, "choices": null }, { "name": "contract_symbol", "type": "list[str]", "description": "Contract symbol for the option.", "default": "", "optional": false, "choices": null }, { "name": "eod_date", "type": "list[date]", "description": "Date for which the options chains are returned.", "default": "", "optional": true, "choices": null }, { "name": "expiration", "type": "list[date]", "description": "Expiration date of the contract.", "default": "", "optional": false, "choices": null }, { "name": "dte", "type": "list[int]", "description": "Days to expiration of the contract.", "default": "", "optional": true, "choices": null }, { "name": "strike", "type": "list[float]", "description": "Strike price of the contract.", "default": "", "optional": false, "choices": null }, { "name": "option_type", "type": "list[str]", "description": "Call or Put.", "default": "", "optional": false, "choices": null }, { "name": "contract_size", "type": "list[Union[int, float]]", "description": "Number of underlying units per contract.", "default": "", "optional": true, "choices": null }, { "name": "open_interest", "type": "list[Union[int, float]]", "description": "Open interest on the contract.", "default": "", "optional": true, "choices": null }, { "name": "volume", "type": "list[Union[int, float]]", "description": "The trading volume.", "default": "", "optional": true, "choices": null }, { "name": "theoretical_price", "type": "list[float]", "description": "Theoretical value of the option.", "default": "", "optional": true, "choices": null }, { "name": "last_trade_price", "type": "list[float]", "description": "Last trade price of the option.", "default": "", "optional": true, "choices": null }, { "name": "last_trade_size", "type": "list[Union[int, float]]", "description": "Last trade size of the option.", "default": "", "optional": true, "choices": null }, { "name": "last_trade_time", "type": "list[datetime]", "description": "The timestamp of the last trade.", "default": "", "optional": true, "choices": null }, { "name": "tick", "type": "list[str]", "description": "Whether the last tick was up or down in price.", "default": "", "optional": true, "choices": null }, { "name": "bid", "type": "list[float]", "description": "Current bid price for the option.", "default": "", "optional": true, "choices": null }, { "name": "bid_size", "type": "list[Union[int, float]]", "description": "Bid size for the option.", "default": "", "optional": true, "choices": null }, { "name": "bid_time", "type": "list[datetime]", "description": "The timestamp of the bid price.", "default": "", "optional": true, "choices": null }, { "name": "bid_exchange", "type": "list[str]", "description": "The exchange of the bid price.", "default": "", "optional": true, "choices": null }, { "name": "ask", "type": "list[float]", "description": "Current ask price for the option.", "default": "", "optional": true, "choices": null }, { "name": "ask_size", "type": "list[Union[int, float]]", "description": "Ask size for the option.", "default": "", "optional": true, "choices": null }, { "name": "ask_time", "type": "list[datetime]", "description": "The timestamp of the ask price.", "default": "", "optional": true, "choices": null }, { "name": "ask_exchange", "type": "list[str]", "description": "The exchange of the ask price.", "default": "", "optional": true, "choices": null }, { "name": "mark", "type": "list[float]", "description": "The mid-price between the latest bid and ask.", "default": "", "optional": true, "choices": null }, { "name": "open", "type": "list[float]", "description": "The open price.", "default": "", "optional": true, "choices": null }, { "name": "open_bid", "type": "list[float]", "description": "The opening bid price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "open_ask", "type": "list[float]", "description": "The opening ask price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "high", "type": "list[float]", "description": "The high price.", "default": "", "optional": true, "choices": null }, { "name": "bid_high", "type": "list[float]", "description": "The highest bid price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "ask_high", "type": "list[float]", "description": "The highest ask price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "low", "type": "list[float]", "description": "The low price.", "default": "", "optional": true, "choices": null }, { "name": "bid_low", "type": "list[float]", "description": "The lowest bid price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "ask_low", "type": "list[float]", "description": "The lowest ask price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close", "type": "list[float]", "description": "The close price.", "default": "", "optional": true, "choices": null }, { "name": "close_size", "type": "list[Union[int, float]]", "description": "The closing trade size for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_time", "type": "list[datetime]", "description": "The time of the closing price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_bid", "type": "list[float]", "description": "The closing bid price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_bid_size", "type": "list[Union[int, float]]", "description": "The closing bid size for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_bid_time", "type": "list[datetime]", "description": "The time of the bid closing price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_ask", "type": "list[float]", "description": "The closing ask price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_ask_size", "type": "list[Union[int, float]]", "description": "The closing ask size for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "close_ask_time", "type": "list[datetime]", "description": "The time of the ask closing price for the option that day.", "default": "", "optional": true, "choices": null }, { "name": "prev_close", "type": "list[float]", "description": "The previous close price.", "default": "", "optional": true, "choices": null }, { "name": "change", "type": "list[float]", "description": "The change in the price of the option.", "default": "", "optional": true, "choices": null }, { "name": "change_percent", "type": "list[float]", "description": "Change, in normalized percentage points, of the option.", "default": "", "optional": true, "choices": null }, { "name": "implied_volatility", "type": "list[float]", "description": "Implied volatility of the option.", "default": "", "optional": true, "choices": null }, { "name": "delta", "type": "list[float]", "description": "Delta of the option.", "default": "", "optional": true, "choices": null }, { "name": "gamma", "type": "list[float]", "description": "Gamma of the option.", "default": "", "optional": true, "choices": null }, { "name": "theta", "type": "list[float]", "description": "Theta of the option.", "default": "", "optional": true, "choices": null }, { "name": "vega", "type": "list[float]", "description": "Vega of the option.", "default": "", "optional": true, "choices": null }, { "name": "rho", "type": "list[float]", "description": "Rho of the option.", "default": "", "optional": true, "choices": null } ], "intrinio": [], "yfinance": [ { "name": "in_the_money", "type": "list[bool]", "description": "Whether the option is in the money.", "default": "", "optional": true, "choices": null }, { "name": "currency", "type": "list[str]", "description": "Currency of the option.", "default": "", "optional": true, "choices": null } ] }, "model": "OptionsChains", "openapi_extra": { "model": "OptionsChains" } }, "/derivatives/options/unusual": { "deprecated": { "flag": null, "message": null }, "description": "Get the complete options chain for a ticker.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.options.unusual(symbol='TSLA', provider='intrinio')\n# Use the 'symbol' parameter to get the most recent activity for a specific symbol.\nobb.derivatives.options.unusual(symbol='TSLA', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for. (the underlying symbol)", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began.", "default": null, "optional": true, "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date.", "default": null, "optional": true, "choices": null }, { "name": "trade_type", "type": "Literal['block', 'sweep', 'large']", "description": "The type of unusual activity to query for.", "default": null, "optional": true, "choices": null }, { "name": "sentiment", "type": "Literal['bullish', 'bearish', 'neutral']", "description": "The sentiment type to query for.", "default": null, "optional": true, "choices": null }, { "name": "min_value", "type": "Union[int, float]", "description": "The inclusive minimum total value for the unusual activity.", "default": null, "optional": true, "choices": null }, { "name": "max_value", "type": "Union[int, float]", "description": "The inclusive maximum total value for the unusual activity.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance.", "default": 100000, "optional": true, "choices": null }, { "name": "source", "type": "Literal['delayed', 'realtime']", "description": "The source of the data. Either realtime or delayed.", "default": "delayed", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[OptionsUnusual]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "underlying_symbol", "type": "str", "description": "Symbol representing the entity requested in the data. (the underlying symbol)", "default": null, "optional": true, "choices": null }, { "name": "contract_symbol", "type": "str", "description": "Contract symbol for the option.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "trade_timestamp", "type": "datetime", "description": "The datetime of order placement.", "default": "", "optional": false, "choices": null }, { "name": "trade_type", "type": "Literal['block', 'sweep', 'large']", "description": "The type of unusual trade.", "default": "", "optional": false, "choices": null }, { "name": "sentiment", "type": "Literal['bullish', 'bearish', 'neutral']", "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.", "default": "", "optional": false, "choices": null }, { "name": "bid_at_execution", "type": "float", "description": "Bid price at execution.", "default": "", "optional": false, "choices": null }, { "name": "ask_at_execution", "type": "float", "description": "Ask price at execution.", "default": "", "optional": false, "choices": null }, { "name": "average_price", "type": "float", "description": "The average premium paid per option contract.", "default": "", "optional": false, "choices": null }, { "name": "underlying_price_at_execution", "type": "float", "description": "Price of the underlying security at execution of trade.", "default": null, "optional": true, "choices": null }, { "name": "total_size", "type": "int", "description": "The total number of contracts involved in a single transaction.", "default": "", "optional": false, "choices": null }, { "name": "total_value", "type": "Union[int, float]", "description": "The aggregated value of all option contract premiums included in the trade.", "default": "", "optional": false, "choices": null } ] }, "model": "OptionsUnusual", "openapi_extra": { "model": "OptionsUnusual" } }, "/derivatives/options/snapshots": { "deprecated": { "flag": null, "message": null }, "description": "Get a snapshot of the options market universe.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.options.snapshots(provider='intrinio')\n```\n\n", "parameters": { "standard": [], "intrinio": [ { "name": "date", "type": "Union[Union[date, datetime, str], str]", "description": "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'", "default": null, "optional": true, "choices": null }, { "name": "only_traded", "type": "bool", "description": "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.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[OptionsSnapshots]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "underlying_symbol", "type": "list[str]", "description": "Ticker symbol of the underlying asset.", "default": "", "optional": false, "choices": null }, { "name": "contract_symbol", "type": "list[str]", "description": "Symbol of the options contract.", "default": "", "optional": false, "choices": null }, { "name": "expiration", "type": "list[date]", "description": "Expiration date of the options contract.", "default": "", "optional": false, "choices": null }, { "name": "dte", "type": "list[int]", "description": "Number of days to expiration of the options contract.", "default": "", "optional": true, "choices": null }, { "name": "strike", "type": "list[float]", "description": "Strike price of the options contract.", "default": "", "optional": false, "choices": null }, { "name": "option_type", "type": "list[str]", "description": "The type of option.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "list[int]", "description": "The trading volume.", "default": "", "optional": true, "choices": null }, { "name": "open_interest", "type": "list[int]", "description": "Open interest at the time.", "default": "", "optional": true, "choices": null }, { "name": "last_price", "type": "list[float]", "description": "Last trade price at the time.", "default": "", "optional": true, "choices": null }, { "name": "last_size", "type": "list[int]", "description": "Lot size of the last trade.", "default": "", "optional": true, "choices": null }, { "name": "last_timestamp", "type": "list[datetime]", "description": "Timestamp of the last price.", "default": "", "optional": true, "choices": null }, { "name": "open", "type": "list[float]", "description": "The open price.", "default": "", "optional": true, "choices": null }, { "name": "high", "type": "list[float]", "description": "The high price.", "default": "", "optional": true, "choices": null }, { "name": "low", "type": "list[float]", "description": "The low price.", "default": "", "optional": true, "choices": null }, { "name": "close", "type": "list[float]", "description": "The close price.", "default": "", "optional": true, "choices": null } ], "intrinio": [ { "name": "bid", "type": "list[float]", "description": "The last bid price at the time.", "default": "", "optional": true, "choices": null }, { "name": "bid_size", "type": "list[int]", "description": "The size of the last bid price.", "default": "", "optional": true, "choices": null }, { "name": "bid_timestamp", "type": "list[datetime]", "description": "The timestamp of the last bid price.", "default": "", "optional": true, "choices": null }, { "name": "ask", "type": "list[float]", "description": "The last ask price at the time.", "default": "", "optional": true, "choices": null }, { "name": "ask_size", "type": "list[int]", "description": "The size of the last ask price.", "default": "", "optional": true, "choices": null }, { "name": "ask_timestamp", "type": "list[datetime]", "description": "The timestamp of the last ask price.", "default": "", "optional": true, "choices": null }, { "name": "total_bid_volume", "type": "list[int]", "description": "Total volume of bids.", "default": "", "optional": true, "choices": null }, { "name": "bid_high", "type": "list[float]", "description": "The highest bid price.", "default": "", "optional": true, "choices": null }, { "name": "bid_low", "type": "list[float]", "description": "The lowest bid price.", "default": "", "optional": true, "choices": null }, { "name": "total_ask_volume", "type": "list[int]", "description": "Total volume of asks.", "default": "", "optional": true, "choices": null }, { "name": "ask_high", "type": "list[float]", "description": "The highest ask price.", "default": "", "optional": true, "choices": null }, { "name": "ask_low", "type": "list[float]", "description": "The lowest ask price.", "default": "", "optional": true, "choices": null } ] }, "model": "OptionsSnapshots", "openapi_extra": { "model": "OptionsSnapshots" } }, "/derivatives/futures/historical": { "deprecated": { "flag": null, "message": null }, "description": "Historical futures prices.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance')\n# Enter multiple symbols.\nobb.derivatives.futures.historical(symbol='ES,NQ', provider='yfinance')\n# Enter expiration dates as \"YYYY-MM\".\nobb.derivatives.futures.historical(symbol='ES', provider='yfinance', expiration='2025-12')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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": "expiration", "type": "str", "description": "Future expiry date with format YYYY-MM", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FuturesHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", "optional": false, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", "optional": false, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", "optional": false, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [] }, "model": "FuturesHistorical", "openapi_extra": { "model": "FuturesHistorical" } }, "/derivatives/futures/curve": { "deprecated": { "flag": null, "message": null }, "description": "Futures Term Structure, current or historical.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.derivatives.futures.curve(symbol='NG', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "date", "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, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FuturesCurve]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "expiration", "type": "str", "description": "Futures expiration month.", "default": "", "optional": false, "choices": null }, { "name": "price", "type": "float", "description": "The price of the futures contract.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "FuturesCurve", "openapi_extra": { "model": "FuturesCurve" } }, "/economy/gdp/forecast": { "deprecated": { "flag": null, "message": null }, "description": "Get Forecasted GDP Data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.forecast(provider='oecd')\nobb.economy.gdp.forecast(country=united_states,germany,france, frequency=annual, units=capita, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "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 } ], "oecd": [ { "name": "country", "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, "choices": [ "argentina", "asia", "australia", "austria", "belgium", "brazil", "bulgaria", "canada", "chile", "china", "colombia", "costa_rica", "croatia", "czech_republic", "denmark", "estonia", "finland", "france", "germany", "greece", "hungary", "iceland", "india", "indonesia", "ireland", "israel", "italy", "japan", "korea", "latvia", "lithuania", "luxembourg", "mexico", "netherlands", "new_zealand", "norway", "peru", "poland", "portugal", "romania", "russia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "other_major_oil_producers", "rest_of_the_world", "world", "all" ] }, { "name": "frequency", "type": "Literal['annual', 'quarter']", "description": "Frequency of the data, default is annual.", "default": "annual", "optional": true, "choices": null }, { "name": "units", "type": "Literal['current_prices', 'volume', 'capita', 'growth', 'deflator']", "description": "Units of the data, default is volume (chain linked volume, 2015).\n'current_prices', 'volume', and 'capita' are expressed in USD; 'growth' as a percent; 'deflator' as an index.", "default": "volume", "optional": true, "choices": [ "current_prices", "volume", "capita", "growth", "deflator" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[GdpForecast]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "country", "type": "str", "description": "None", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "Forecasted GDP value for the country and date.", "default": "", "optional": false, "choices": null } ], "oecd": [] }, "model": "GdpForecast", "openapi_extra": { "model": "GdpForecast" } }, "/economy/gdp/nominal": { "deprecated": { "flag": null, "message": null }, "description": "Get Nominal GDP Data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.nominal(provider='oecd')\nobb.economy.gdp.nominal(units=capita, country=all, frequency=annual, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "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 } ], "econdb": [ { "name": "country", "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, "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", "default": true, "optional": true, "choices": null } ], "oecd": [ { "name": "country", "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, "choices": [ "oecd", "oecd_26", "oecd_europe", "g7", "g20", "euro_area", "european_union_27", "european_union_15", "nafta", "argentina", "australia", "austria", "belgium", "bulgaria", "brazil", "canada", "chile", "colombia", "costa_rica", "croatia", "czech_republic", "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", "romania", "russia", "saudi_arabia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "all" ] }, { "name": "frequency", "type": "Literal['quarter', 'annual']", "description": "Frequency of the data.", "default": "quarter", "optional": true, "choices": [ "quarter", "annual" ] }, { "name": "units", "type": "Literal['level', 'index', 'capita']", "description": "The unit of measurement for the data.Both 'level' and 'capita' (per) are measured in USD.", "default": "level", "optional": true, "choices": [ "level", "index", "capita" ] }, { "name": "price_base", "type": "Literal['current_prices', 'volume']", "description": "Price base for the data, volume is chain linked volume.", "default": "current_prices", "optional": true, "choices": [ "current_prices", "volume" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[GdpNominal]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb', 'oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "country", "type": "str", "description": "The country represented by the GDP value.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "GDP value for the country and date.", "default": "", "optional": false, "choices": null } ], "econdb": [ { "name": "value", "type": "Union[int, float]", "description": "Nominal GDP value for the country and date.", "default": "", "optional": false, "choices": null }, { "name": "nominal_growth_qoq", "type": "float", "description": "Nominal GDP growth rate quarter over quarter.", "default": "", "optional": false, "choices": null }, { "name": "nominal_growth_yoy", "type": "float", "description": "Nominal GDP growth rate year over year.", "default": "", "optional": false, "choices": null } ], "oecd": [] }, "model": "GdpNominal", "openapi_extra": { "model": "GdpNominal" } }, "/economy/gdp/real": { "deprecated": { "flag": null, "message": null }, "description": "Get Real GDP Data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.gdp.real(provider='oecd')\nobb.economy.gdp.real(country=united_states,germany,japan, provider='econdb')\n```\n\n", "parameters": { "standard": [ { "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 } ], "econdb": [ { "name": "country", "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, "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", "default": true, "optional": true, "choices": null } ], "oecd": [ { "name": "country", "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, "choices": [ "oecd", "oecd_26", "oecd_europe", "g7", "g20", "euro_area", "european_union_27", "european_union_15", "nafta", "argentina", "australia", "austria", "belgium", "bulgaria", "brazil", "canada", "chile", "colombia", "costa_rica", "croatia", "czech_republic", "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", "romania", "russia", "saudi_arabia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "all" ] }, { "name": "frequency", "type": "Literal['quarter', 'annual']", "description": "Frequency of the data.", "default": "quarter", "optional": true, "choices": [ "quarter", "annual" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[GdpReal]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb', 'oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "country", "type": "str", "description": "The country represented by the GDP value.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "GDP value for the country and date.", "default": "", "optional": false, "choices": null } ], "econdb": [ { "name": "value", "type": "Union[int, float]", "description": "Real GDP value for the country and date.", "default": "", "optional": false, "choices": null }, { "name": "real_growth_qoq", "type": "float", "description": "Real GDP growth rate quarter over quarter.", "default": "", "optional": false, "choices": null }, { "name": "real_growth_yoy", "type": "float", "description": "Real GDP growth rate year over year.", "default": "", "optional": false, "choices": null } ], "oecd": [] }, "model": "GdpReal", "openapi_extra": { "model": "GdpReal" } }, "/economy/survey/bls_series": { "deprecated": { "flag": null, "message": null }, "description": "Get time series data for one, or more, BLS series IDs.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.bls_series(provider='bls', symbol='CES0000000001')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): bls.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "bls": [ { "name": "calculations", "type": "bool", "description": "Include calculations in the response, if available. Default is True.", "default": true, "optional": true, "choices": null }, { "name": "annual_average", "type": "bool", "description": "Include annual averages in the response, if available. Default is False.", "default": false, "optional": true, "choices": null }, { "name": "aspects", "type": "bool", "description": "Include all aspects associated with a data point for a given BLS series ID, if available. Returned with the series metadata, under `extras` of the response object. Default is False.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BlsSeries]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['bls']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the series.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Observation value for the symbol and date.", "default": null, "optional": true, "choices": null } ], "bls": [ { "name": "change_1M", "type": "float", "description": "One month change in value.", "default": null, "optional": true, "choices": null }, { "name": "change_3M", "type": "float", "description": "Three month change in value.", "default": null, "optional": true, "choices": null }, { "name": "change_6M", "type": "float", "description": "Six month change in value.", "default": null, "optional": true, "choices": null }, { "name": "change_12M", "type": "float", "description": "One year change in value.", "default": null, "optional": true, "choices": null }, { "name": "change_percent_1M", "type": "float", "description": "One month change in percent.", "default": null, "optional": true, "choices": null }, { "name": "change_percent_3M", "type": "float", "description": "Three month change in percent.", "default": null, "optional": true, "choices": null }, { "name": "change_percent_6M", "type": "float", "description": "Six month change in percent.", "default": null, "optional": true, "choices": null }, { "name": "change_percent_12M", "type": "float", "description": "One year change in percent.", "default": null, "optional": true, "choices": null }, { "name": "latest", "type": "bool", "description": "Latest value indicator.", "default": null, "optional": true, "choices": null }, { "name": "footnotes", "type": "str", "description": "Footnotes accompanying the value.", "default": null, "optional": true, "choices": null } ] }, "model": "BlsSeries", "openapi_extra": { "model": "BlsSeries" } }, "/economy/survey/bls_search": { "deprecated": { "flag": null, "message": null }, "description": "Search BLS surveys by category and keyword or phrase to identify BLS series IDs.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.bls_search(provider='bls', category=cpi)\n# Use semi-colon to separate multiple queries as an & operator.\nobb.economy.survey.bls_search(provider='bls', category=cpi, query='seattle;gasoline')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "The search word(s). Use semi-colon to separate multiple queries as an & operator.", "default": "", "optional": true, "choices": null } ], "bls": [ { "name": "category", "type": "Literal['cpi', 'pce', 'ppi', 'ip', 'jolts', 'nfp', 'cps', 'lfs', 'wages', 'ec', 'sla', 'bed', 'tu']", "description": "The category of BLS survey to search within.\n An empty search query will return all series within the category. Options are:\n \n cpi - Consumer Price Index\n \n pce - Personal Consumption Expenditure\n \n ppi - Producer Price Index\n \n ip - Industry Productivity\n \n jolts - Job Openings and Labor Turnover Survey\n \n nfp - Nonfarm Payrolls\n \n cps - Current Population Survey\n \n lfs - Labor Force Statistics\n \n wages - Wages\n \n ec - Employer Costs\n \n sla - State and Local Area Employment\n \n bed - Business Employment Dynamics\n \n tu - Time Use", "default": "", "optional": false, "choices": [ "cpi", "pce", "ppi", "ip", "jolts", "nfp", "cps", "lfs", "wages", "ec", "sla", "bed", "tu" ] }, { "name": "include_extras", "type": "bool", "description": "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'.", "default": false, "optional": true, "choices": null }, { "name": "include_code_map", "type": "bool", "description": "When True, includes the complete code map for ea\u00e7h 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.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BlsSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['bls']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "The title of the series.", "default": null, "optional": true, "choices": null }, { "name": "survey_name", "type": "str", "description": "The name of the survey.", "default": null, "optional": true, "choices": null } ], "bls": [] }, "model": "BlsSearch", "openapi_extra": { "model": "BlsSearch" } }, "/economy/survey/sloos": { "deprecated": { "flag": null, "message": null }, "description": "Get Senior Loan Officers Opinion Survey.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.sloos(provider='fred')\nobb.economy.survey.sloos(category=credit_card, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "category", "type": "Literal['spreads', 'consumer', 'auto', 'credit_card', 'firms', 'mortgage', 'commercial_real_estate', 'standards', 'demand', 'foreign_banks']", "description": "Category of survey response.", "default": "spreads", "optional": true, "choices": [ "spreads", "consumer", "auto", "credit_card", "firms", "mortgage", "commercial_real_estate", "standards", "demand", "foreign_banks" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SeniorLoanOfficerSurvey]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Survey value.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Survey title.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "SeniorLoanOfficerSurvey", "openapi_extra": { "model": "SeniorLoanOfficerSurvey" } }, "/economy/survey/university_of_michigan": { "deprecated": { "flag": null, "message": null }, "description": "Get University of Michigan Consumer Sentiment and Inflation Expectations Surveys.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.university_of_michigan(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "frequency", "type": "Literal['quarter', 'annual']", "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", "default": null, "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[UniversityOfMichigan]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "consumer_sentiment", "type": "float", "description": "Index of the results of the University of Michigan's monthly Survey of Consumers, which is used to estimate future spending and saving. (1966:Q1=100).", "default": null, "optional": true, "choices": null }, { "name": "inflation_expectation", "type": "float", "description": "Median expected price change next 12 months, Surveys of Consumers.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "UniversityOfMichigan", "openapi_extra": { "model": "UniversityOfMichigan" } }, "/economy/survey/economic_conditions_chicago": { "deprecated": { "flag": null, "message": null }, "description": "Get The Survey Of Economic Conditions For The Chicago Region.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.economic_conditions_chicago(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "frequency", "type": "Literal['annual', 'quarter']", "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", "default": null, "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SurveyOfEconomicConditionsChicago]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "activity_index", "type": "float", "description": "Activity Index.", "default": null, "optional": true, "choices": null }, { "name": "one_year_outlook", "type": "float", "description": "One Year Outlook Index.", "default": null, "optional": true, "choices": null }, { "name": "manufacturing_activity", "type": "float", "description": "Manufacturing Activity Index.", "default": null, "optional": true, "choices": null }, { "name": "non_manufacturing_activity", "type": "float", "description": "Non-Manufacturing Activity Index.", "default": null, "optional": true, "choices": null }, { "name": "capital_expenditures_expectations", "type": "float", "description": "Capital Expenditures Expectations Index.", "default": null, "optional": true, "choices": null }, { "name": "hiring_expectations", "type": "float", "description": "Hiring Expectations Index.", "default": null, "optional": true, "choices": null }, { "name": "current_hiring", "type": "float", "description": "Current Hiring Index.", "default": null, "optional": true, "choices": null }, { "name": "labor_costs", "type": "float", "description": "Labor Costs Index.", "default": null, "optional": true, "choices": null }, { "name": "non_labor_costs", "type": "float", "description": "Non-Labor Costs Index.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "SurveyOfEconomicConditionsChicago", "openapi_extra": { "model": "SurveyOfEconomicConditionsChicago" } }, "/economy/survey/manufacturing_outlook_texas": { "deprecated": { "flag": null, "message": null }, "description": "Get The Manufacturing Outlook Survey For The Texas Region.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.manufacturing_outlook_texas(provider='fred')\nobb.economy.survey.manufacturing_outlook_texas(topic=business_outlook,new_orders, transform=pc1, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "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]]]", "description": "The topic for the survey response. Multiple items allowed for provider(s): fred.", "default": "new_orders_growth", "optional": true, "choices": [ "business_activity", "business_outlook", "capex", "prices_paid", "production", "inventory", "new_orders", "new_orders_growth", "unfilled_orders", "shipments", "delivery_time", "employment", "wages", "hours_worked" ] }, { "name": "frequency", "type": "Literal['annual', 'quarter']", "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", "default": null, "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ManufacturingOutlookTexas]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "topic", "type": "str", "description": "Topic of the survey response.", "default": null, "optional": true, "choices": null }, { "name": "diffusion_index", "type": "float", "description": "Diffusion Index.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_increase", "type": "float", "description": "Percent of respondents reporting an increase over the last month.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_decrease", "type": "float", "description": "Percent of respondents reporting a decrease over the last month.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_no_change", "type": "float", "description": "Percent of respondents reporting no change over the last month.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "ManufacturingOutlookTexas", "openapi_extra": { "model": "ManufacturingOutlookTexas" } }, "/economy/survey/manufacturing_outlook_ny": { "deprecated": { "flag": null, "message": null }, "description": "Get the Empire State Manufacturing Survey.\n\nIt is a monthly survey of manufacturers in New York State conducted by the Federal Reserve Bank of New York.\n\nParticipants from across the state in a variety of industries respond to a questionnaire\nand report the change in a variety of indicators from the previous month.\n\nRespondents also state the likely direction of these same indicators six months ahead.\nApril 2002 is the first report, although survey data date back to July 2001.\n\nThe survey is sent on the first day of each month to the same pool of about 200\nmanufacturing executives in New York State, typically the president or CEO.\n\nAbout 100 responses are received. Most are completed by the tenth, although surveys are accepted until the fifteenth.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.manufacturing_outlook_ny(provider='fred')\nobb.economy.survey.manufacturing_outlook_ny(topic=hours_worked,new_orders, transform=pc1, provider='fred', seasonally_adjusted=True)\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "topic", "type": "Union[Union[Literal['business_outlook', 'hours_worked', 'employment', 'inventories', 'prices_received', 'prices_paid', 'capex', 'unfilled_orders', 'new_orders', 'shipments', 'delivery_times'], str], list[Union[Literal['business_outlook', 'hours_worked', 'employment', 'inventories', 'prices_received', 'prices_paid', 'capex', 'unfilled_orders', 'new_orders', 'shipments', 'delivery_times'], str]]]", "description": "The topic for the survey response. Multiple items allowed for provider(s): fred.", "default": "new_orders", "optional": true, "choices": [ "business_outlook", "hours_worked", "employment", "inventories", "prices_received", "prices_paid", "capex", "unfilled_orders", "new_orders", "shipments", "delivery_times" ] }, { "name": "seasonally_adjusted", "type": "bool", "description": "Whether the data is seasonally adjusted, default is False", "default": false, "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['quarter', 'annual']", "description": "Frequency aggregation to convert monthly data to lower frequency. None is monthly.", "default": null, "optional": true, "choices": null }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": null }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ManufacturingOutlookNY]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "topic", "type": "str", "description": "Topic of the survey response.", "default": null, "optional": true, "choices": null }, { "name": "diffusion_index", "type": "float", "description": "Diffusion Index.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_increase", "type": "float", "description": "Percent of respondents reporting an increase over the last month.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_decrease", "type": "float", "description": "Percent of respondents reporting a decrease over the last month.", "default": null, "optional": true, "choices": null }, { "name": "percent_reporting_no_change", "type": "float", "description": "Percent of respondents reporting no change over the last month.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "ManufacturingOutlookNY", "openapi_extra": { "widget_config": { "name": "Empire State Manufacturing Survey" }, "model": "ManufacturingOutlookNY" } }, "/economy/survey/nonfarm_payrolls": { "deprecated": { "flag": null, "message": null }, "description": "Get Nonfarm Payrolls Survey.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.survey.nonfarm_payrolls(provider='fred')\nobb.economy.survey.nonfarm_payrolls(category=avg_hours, provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "date", "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, "choices": null } ], "fred": [ { "name": "category", "type": "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']", "description": "The category to query.", "default": "employees_nsa", "optional": true, "choices": [ "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" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[NonFarmPayrolls]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "float", "description": "", "default": "", "optional": false, "choices": null } ], "fred": [ { "name": "name", "type": "str", "description": "The name of the series.", "default": "", "optional": false, "choices": null }, { "name": "element_id", "type": "str", "description": "The element id in the parent/child relationship.", "default": "", "optional": false, "choices": null }, { "name": "parent_id", "type": "str", "description": "The parent id in the parent/child relationship.", "default": "", "optional": false, "choices": null }, { "name": "children", "type": "str", "description": "The element_id of each child, as a comma-separated string.", "default": null, "optional": true, "choices": null }, { "name": "level", "type": "int", "description": "The indentation level of the element.", "default": "", "optional": false, "choices": null } ] }, "model": "NonFarmPayrolls", "openapi_extra": { "model": "NonFarmPayrolls" } }, "/economy/calendar": { "deprecated": { "flag": null, "message": null }, "description": "Get the upcoming, or historical, economic calendar of global events.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# By default, the calendar will be forward-looking.\nobb.economy.calendar(provider='fmp')\nobb.economy.calendar(provider='fmp', start_date='2020-03-01', end_date='2020-03-31')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fmp": [], "tradingeconomics": [ { "name": "country", "type": "Union[str, list[str]]", "description": "Country of the event. Multiple items allowed for provider(s): tradingeconomics.", "default": null, "optional": true, "choices": [ "afghanistan", "albania", "algeria", "andorra", "angola", "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", "bulgaria", "burkina_faso", "burundi", "cambodia", "cameroon", "canada", "cape_verde", "cayman_islands", "central_african_republic", "chad", "chile", "china", "colombia", "comoros", "congo", "costa_rica", "croatia", "cuba", "cyprus", "czech_republic", "denmark", "djibouti", "dominica", "dominican_republic", "east_timor", "ecuador", "egypt", "el_salvador", "equatorial_guinea", "eritrea", "estonia", "ethiopia", "euro_area", "faroe_islands", "fiji", "finland", "france", "gabon", "gambia", "georgia", "germany", "ghana", "greece", "grenada", "guatemala", "guinea", "guinea_bissau", "guyana", "haiti", "honduras", "hong_kong", "hungary", "iceland", "india", "indonesia", "iran", "iraq", "ireland", "isle_of_man", "israel", "italy", "ivory_coast", "jamaica", "japan", "jordan", "kazakhstan", "kenya", "kiribati", "kosovo", "kuwait", "kyrgyzstan", "laos", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "macao", "madagascar", "malawi", "malaysia", "maldives", "mali", "malta", "mauritania", "mauritius", "mexico", "moldova", "monaco", "mongolia", "montenegro", "morocco", "mozambique", "myanmar", "namibia", "nepal", "netherlands", "new_caledonia", "new_zealand", "nicaragua", "niger", "nigeria", "north_korea", "north_macedonia", "norway", "oman", "pakistan", "palestine", "panama", "papua_new_guinea", "paraguay", "peru", "philippines", "poland", "portugal", "puerto_rico", "qatar", "republic_of_the_congo", "romania", "russia", "rwanda", "samoa", "sao_tome_and_principe", "saudi_arabia", "senegal", "serbia", "seychelles", "sierra_leone", "singapore", "slovakia", "slovenia", "solomon_islands", "somalia", "south_africa", "south_korea", "south_sudan", "spain", "sri_lanka", "sudan", "suriname", "swaziland", "sweden", "switzerland", "syria", "taiwan", "tajikistan", "tanzania", "thailand", "togo", "tonga", "trinidad_and_tobago", "tunisia", "turkey", "turkmenistan", "uganda", "ukraine", "united_arab_emirates", "united_kingdom", "united_states", "uruguay", "uzbekistan", "vanuatu", "venezuela", "vietnam", "yemen", "zambia", "zimbabwe" ] }, { "name": "importance", "type": "Literal['low', 'medium', 'high']", "description": "Importance of the event.", "default": null, "optional": true, "choices": [ "low", "medium", "high" ] }, { "name": "group", "type": "Literal['interest_rate', 'inflation', 'bonds', 'consumer', 'gdp', 'government', 'housing', 'labour', 'markets', 'money', 'prices', 'trade', 'business']", "description": "Grouping of events.", "default": null, "optional": true, "choices": [ "interest_rate", "inflation", "bonds", "consumer", "gdp", "government", "housing", "labour", "markets", "money", "prices", "trade", "business" ] }, { "name": "calendar_id", "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, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EconomicCalendar]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'tradingeconomics']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country of event.", "default": null, "optional": true, "choices": null }, { "name": "category", "type": "str", "description": "Category of event.", "default": null, "optional": true, "choices": null }, { "name": "event", "type": "str", "description": "Event name.", "default": null, "optional": true, "choices": null }, { "name": "importance", "type": "str", "description": "The importance level for the event.", "default": null, "optional": true, "choices": null }, { "name": "source", "type": "str", "description": "Source of the data.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the data.", "default": null, "optional": true, "choices": null }, { "name": "unit", "type": "str", "description": "Unit of the data.", "default": null, "optional": true, "choices": null }, { "name": "consensus", "type": "Union[str, float]", "description": "Average forecast among a representative group of economists.", "default": null, "optional": true, "choices": null }, { "name": "previous", "type": "Union[str, float]", "description": "Value for the previous period after the revision (if revision is applicable).", "default": null, "optional": true, "choices": null }, { "name": "revised", "type": "Union[str, float]", "description": "Revised previous value, if applicable.", "default": null, "optional": true, "choices": null }, { "name": "actual", "type": "Union[str, float]", "description": "Latest released value.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "change", "type": "float", "description": "Value change since previous.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Percentage change since previous.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last updated timestamp.", "default": null, "optional": true, "choices": null }, { "name": "created_at", "type": "datetime", "description": "Created at timestamp.", "default": null, "optional": true, "choices": null } ], "tradingeconomics": [ { "name": "forecast", "type": "Union[str, float]", "description": "TradingEconomics projections.", "default": null, "optional": true, "choices": null }, { "name": "reference", "type": "str", "description": "Abbreviated period for which released data refers to.", "default": null, "optional": true, "choices": null }, { "name": "reference_date", "type": "date", "description": "Date for the reference period.", "default": null, "optional": true, "choices": null }, { "name": "calendar_id", "type": "int", "description": "TradingEconomics Calendar ID.", "default": null, "optional": true, "choices": null }, { "name": "date_span", "type": "int", "description": "Date span of the event.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "TradingEconomics Symbol.", "default": null, "optional": true, "choices": null }, { "name": "ticker", "type": "str", "description": "TradingEconomics Ticker symbol.", "default": null, "optional": true, "choices": null }, { "name": "te_url", "type": "str", "description": "TradingEconomics URL path.", "default": null, "optional": true, "choices": null }, { "name": "source_url", "type": "str", "description": "Source URL.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last update of the data.", "default": null, "optional": true, "choices": null } ] }, "model": "EconomicCalendar", "openapi_extra": { "model": "EconomicCalendar" } }, "/economy/cpi": { "deprecated": { "flag": null, "message": null }, "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.cpi(country='japan,china,turkey', provider='fred')\n# Use the `transform` parameter to define the reference period for the change in values. Default is YoY.\nobb.economy.cpi(country='united_states,united_kingdom', transform='period', provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "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": null }, { "name": "transform", "type": "Literal['index', 'yoy', 'period']", "description": "Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).", "default": "yoy", "optional": true, "choices": [ "index", "yoy", "period" ] }, { "name": "frequency", "type": "Literal['annual', 'quarter', 'monthly']", "description": "The frequency of the data.", "default": "monthly", "optional": true, "choices": [ "annual", "quarter", "monthly" ] }, { "name": "harmonized", "type": "bool", "description": "If true, returns harmonized data.", "default": false, "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 } ], "fred": [ { "name": "country", "type": "Union[Literal['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'], str]", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null } ], "oecd": [ { "name": "country", "type": "str", "description": "Country to get CPI for. This is the list of OECD supported countries", "default": "united_states", "optional": true, "choices": null }, { "name": "expenditure", "type": "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']", "description": "Expenditure component of CPI.", "default": "total", "optional": true, "choices": [ "total", "food_non_alcoholic_beverages", "alcoholic_beverages_tobacco_narcotics", "clothing_footwear", "housing_water_electricity_gas", "furniture_household_equipment", "health", "transport", "communication", "recreation_culture", "education", "restaurants_hotels", "miscellaneous_goods_services", "energy", "goods", "housing", "housing_excluding_rentals", "all_non_food_non_energy", "services_less_housing", "services_less_house_excl_rentals", "services", "overall_excl_energy_food_alcohol_tobacco", "residuals", "fuels_lubricants_personal", "actual_rentals", "imputed_rentals", "maintenance_repair_dwelling", "water_supply_other_services", "electricity_gas_other_fuels", "all" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ConsumerPriceIndex]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred', 'oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "country", "type": "str", "description": "None", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "float", "description": "CPI index value or period change.", "default": "", "optional": false, "choices": null } ], "fred": [], "oecd": [ { "name": "expenditure", "type": "str", "description": "Expenditure component of CPI.", "default": "", "optional": false, "choices": null } ] }, "model": "ConsumerPriceIndex", "openapi_extra": { "model": "ConsumerPriceIndex" } }, "/economy/risk_premium": { "deprecated": { "flag": null, "message": null }, "description": "Get Market Risk Premium by country.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.risk_premium(provider='fmp')\n```\n\n", "parameters": { "standard": [], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[RiskPremium]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "country", "type": "str", "description": "Market country.", "default": "", "optional": false, "choices": null }, { "name": "continent", "type": "str", "description": "Continent of the country.", "default": null, "optional": true, "choices": null }, { "name": "total_equity_risk_premium", "type": "Annotated[float, Gt(gt=0)]", "description": "Total equity risk premium for the country.", "default": null, "optional": true, "choices": null }, { "name": "country_risk_premium", "type": "Annotated[float, Ge(ge=0)]", "description": "Country-specific risk premium.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "model": "RiskPremium", "openapi_extra": { "model": "RiskPremium" } }, "/economy/balance_of_payments": { "deprecated": { "flag": null, "message": null }, "description": "Balance of Payments Reports.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.balance_of_payments(provider='fred')\nobb.economy.balance_of_payments(provider='fred', country=brazil)\n```\n\n", "parameters": { "standard": [], "fred": [ { "name": "country", "type": "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']", "description": "The country to get data. Enter as a 3-letter ISO country code, default is USA.", "default": "united_states", "optional": true, "choices": [ "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" ] }, { "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 } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BalanceOfPayments]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period", "type": "date", "description": "The date representing the beginning of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "balance_percent_of_gdp", "type": "float", "description": "Current Account Balance as Percent of GDP", "default": null, "optional": true, "choices": null }, { "name": "balance_total", "type": "float", "description": "Current Account Total Balance (USD)", "default": null, "optional": true, "choices": null }, { "name": "balance_total_services", "type": "float", "description": "Current Account Total Services Balance (USD)", "default": null, "optional": true, "choices": null }, { "name": "balance_total_secondary_income", "type": "float", "description": "Current Account Total Secondary Income Balance (USD)", "default": null, "optional": true, "choices": null }, { "name": "balance_total_goods", "type": "float", "description": "Current Account Total Goods Balance (USD)", "default": null, "optional": true, "choices": null }, { "name": "balance_total_primary_income", "type": "float", "description": "Current Account Total Primary Income Balance (USD)", "default": null, "optional": true, "choices": null }, { "name": "credits_services_percent_of_goods_and_services", "type": "float", "description": "Current Account Credits Services as Percent of Goods and Services", "default": null, "optional": true, "choices": null }, { "name": "credits_services_percent_of_current_account", "type": "float", "description": "Current Account Credits Services as Percent of Current Account", "default": null, "optional": true, "choices": null }, { "name": "credits_total_services", "type": "float", "description": "Current Account Credits Total Services (USD)", "default": null, "optional": true, "choices": null }, { "name": "credits_total_goods", "type": "float", "description": "Current Account Credits Total Goods (USD)", "default": null, "optional": true, "choices": null }, { "name": "credits_total_primary_income", "type": "float", "description": "Current Account Credits Total Primary Income (USD)", "default": null, "optional": true, "choices": null }, { "name": "credits_total_secondary_income", "type": "float", "description": "Current Account Credits Total Secondary Income (USD)", "default": null, "optional": true, "choices": null }, { "name": "credits_total", "type": "float", "description": "Current Account Credits Total (USD)", "default": null, "optional": true, "choices": null }, { "name": "debits_services_percent_of_goods_and_services", "type": "float", "description": "Current Account Debits Services as Percent of Goods and Services", "default": null, "optional": true, "choices": null }, { "name": "debits_services_percent_of_current_account", "type": "float", "description": "Current Account Debits Services as Percent of Current Account", "default": null, "optional": true, "choices": null }, { "name": "debits_total_services", "type": "float", "description": "Current Account Debits Total Services (USD)", "default": null, "optional": true, "choices": null }, { "name": "debits_total_goods", "type": "float", "description": "Current Account Debits Total Goods (USD)", "default": null, "optional": true, "choices": null }, { "name": "debits_total_primary_income", "type": "float", "description": "Current Account Debits Total Primary Income (USD)", "default": null, "optional": true, "choices": null }, { "name": "debits_total", "type": "float", "description": "Current Account Debits Total (USD)", "default": null, "optional": true, "choices": null }, { "name": "debits_total_secondary_income", "type": "float", "description": "Current Account Debits Total Secondary Income (USD)", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "BalanceOfPayments", "openapi_extra": { "model": "BalanceOfPayments" } }, "/economy/fred_search": { "deprecated": { "flag": null, "message": null }, "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_search(provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "The search word(s).", "default": null, "optional": true, "choices": null } ], "fred": [ { "name": "search_type", "type": "Literal['full_text', 'series_id', 'release']", "description": "The type of search to perform. Automatically set to 'release' when a 'release_id' is provided.", "default": "full_text", "optional": true, "choices": [ "full_text", "series_id", "release" ] }, { "name": "release_id", "type": "Annotated[int, Ge(ge=0)]", "description": "A specific release ID to target.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return. (1-1000)", "default": null, "optional": true, "choices": null }, { "name": "offset", "type": "Annotated[int, Ge(ge=0)]", "description": "Offset the results in conjunction with limit. This parameter is ignored When search_type is 'release'.", "default": 0, "optional": true, "choices": null }, { "name": "order_by", "type": "Literal['search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity']", "description": "Order the results by a specific attribute. The default is 'observation_end'.", "default": "observation_end", "optional": true, "choices": [ "search_rank", "series_id", "title", "units", "frequency", "seasonal_adjustment", "realtime_start", "realtime_end", "last_updated", "observation_start", "observation_end", "popularity", "group_popularity" ] }, { "name": "sort_order", "type": "Literal['asc', 'desc']", "description": "Sort the 'order_by' item in ascending or descending order. The default is 'desc'.", "default": "desc", "optional": true, "choices": null }, { "name": "filter_variable", "type": "Literal['frequency', 'units', 'seasonal_adjustment']", "description": "Filter by an attribute.", "default": null, "optional": true, "choices": null }, { "name": "filter_value", "type": "str", "description": "String value to filter the variable by. Used in conjunction with filter_variable. This parameter is ignored when search_type is 'release'.", "default": null, "optional": true, "choices": null }, { "name": "tag_names", "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, "choices": null }, { "name": "exclude_tag_names", "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, "choices": null }, { "name": "series_id", "type": "str", "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FredSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "release_id", "type": "str", "description": "The release ID for queries.", "default": null, "optional": true, "choices": null }, { "name": "series_id", "type": "str", "description": "The series ID for the item in the release.", "default": null, "optional": true, "choices": null }, { "name": "series_group", "type": "str", "description": "The series group ID of the series. This value is used to query for regional data.", "default": null, "optional": true, "choices": null }, { "name": "region_type", "type": "str", "description": "The region type of the series.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "The name of the release.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "The title of the series.", "default": null, "optional": true, "choices": null }, { "name": "observation_start", "type": "date", "description": "The date of the first observation in the series.", "default": null, "optional": true, "choices": null }, { "name": "observation_end", "type": "date", "description": "The date of the last observation in the series.", "default": null, "optional": true, "choices": null }, { "name": "frequency", "type": "str", "description": "The frequency of the data.", "default": null, "optional": true, "choices": null }, { "name": "frequency_short", "type": "str", "description": "Short form of the data frequency.", "default": null, "optional": true, "choices": null }, { "name": "units", "type": "str", "description": "The units of the data.", "default": null, "optional": true, "choices": null }, { "name": "units_short", "type": "str", "description": "Short form of the data units.", "default": null, "optional": true, "choices": null }, { "name": "seasonal_adjustment", "type": "str", "description": "The seasonal adjustment of the data.", "default": null, "optional": true, "choices": null }, { "name": "seasonal_adjustment_short", "type": "str", "description": "Short form of the data seasonal adjustment.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The datetime of the last update to the data.", "default": null, "optional": true, "choices": null }, { "name": "popularity", "type": "int", "description": "Popularity of the series", "default": null, "optional": true, "choices": null }, { "name": "group_popularity", "type": "int", "description": "Group popularity of the release", "default": null, "optional": true, "choices": null }, { "name": "realtime_start", "type": "date", "description": "The realtime start date of the series.", "default": null, "optional": true, "choices": null }, { "name": "realtime_end", "type": "date", "description": "The realtime end date of the series.", "default": null, "optional": true, "choices": null }, { "name": "notes", "type": "str", "description": "Description of the release.", "default": null, "optional": true, "choices": null }, { "name": "press_release", "type": "bool", "description": "If the release is a press release.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "URL to the release.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "FredSearch", "openapi_extra": { "model": "FredSearch" } }, "/economy/fred_series": { "deprecated": { "flag": null, "message": null }, "description": "Get data by series ID from FRED.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_series(symbol='NFCI', provider='fred')\n# Multiple series can be passed in as a list.\nobb.economy.fred_series(symbol='NFCI,STLFSI4', provider='fred')\n# Use the `transform` parameter to transform the data as change, log, or percent change.\nobb.economy.fred_series(symbol='CBBTCUSD', transform=pc1, provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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": 100000, "optional": true, "choices": null } ], "fred": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100000, "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period", "default": "eop", "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ], "intrinio": [ { "name": "all_pages", "type": "bool", "description": "Returns all pages of data from the API call at once.", "default": false, "optional": true, "choices": null }, { "name": "sleep", "type": "float", "description": "Time to sleep between requests to avoid rate limiting.", "default": 1.0, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FredSeries]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null } ], "fred": [], "intrinio": [ { "name": "value", "type": "float", "description": "Value of the index.", "default": null, "optional": true, "choices": null } ] }, "model": "FredSeries", "openapi_extra": { "model": "FredSeries" } }, "/economy/fred_release_table": { "deprecated": { "flag": null, "message": null }, "description": "Get economic release data by ID and/or element from FRED.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the top-level elements of a release by not supplying an element ID.\nobb.economy.fred_release_table(release_id='50', provider='fred')\n# Drill down on a specific section of the release.\nobb.economy.fred_release_table(release_id='50', element_id='4880', provider='fred')\n# Drill down on a specific table of the release.\nobb.economy.fred_release_table(release_id='50', element_id='4881', provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "release_id", "type": "str", "description": "The ID of the release. Use `fred_search` to find releases.", "default": "", "optional": false, "choices": null }, { "name": "element_id", "type": "str", "description": "The element ID of a specific table in the release.", "default": null, "optional": true, "choices": null }, { "name": "date", "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, "choices": null } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FredReleaseTable]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "level", "type": "int", "description": "The indentation level of the element.", "default": null, "optional": true, "choices": null }, { "name": "element_type", "type": "str", "description": "The type of the element.", "default": null, "optional": true, "choices": null }, { "name": "line", "type": "int", "description": "The line number of the element.", "default": null, "optional": true, "choices": null }, { "name": "element_id", "type": "str", "description": "The element id in the parent/child relationship.", "default": null, "optional": true, "choices": null }, { "name": "parent_id", "type": "str", "description": "The parent id in the parent/child relationship.", "default": null, "optional": true, "choices": null }, { "name": "children", "type": "str", "description": "The element_id of each child, as a comma-separated string.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "The name of the series.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The reported value of the series.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "FredReleaseTable", "openapi_extra": { "model": "FredReleaseTable" } }, "/economy/money_measures": { "deprecated": { "flag": null, "message": null }, "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.money_measures(provider='federal_reserve')\nobb.economy.money_measures(adjusted=False, provider='federal_reserve')\n```\n\n", "parameters": { "standard": [ { "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": "adjusted", "type": "bool", "description": "Whether to return seasonally adjusted data.", "default": true, "optional": true, "choices": null } ], "federal_reserve": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[MoneyMeasures]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "month", "type": "date", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "M1", "type": "float", "description": "Value of the M1 money supply in billions.", "default": "", "optional": false, "choices": null }, { "name": "M2", "type": "float", "description": "Value of the M2 money supply in billions.", "default": "", "optional": false, "choices": null }, { "name": "currency", "type": "float", "description": "Value of currency in circulation in billions.", "default": null, "optional": true, "choices": null }, { "name": "demand_deposits", "type": "float", "description": "Value of demand deposits in billions.", "default": null, "optional": true, "choices": null }, { "name": "retail_money_market_funds", "type": "float", "description": "Value of retail money market funds in billions.", "default": null, "optional": true, "choices": null }, { "name": "other_liquid_deposits", "type": "float", "description": "Value of other liquid deposits in billions.", "default": null, "optional": true, "choices": null }, { "name": "small_denomination_time_deposits", "type": "float", "description": "Value of small denomination time deposits in billions.", "default": null, "optional": true, "choices": null } ], "federal_reserve": [] }, "model": "MoneyMeasures", "openapi_extra": { "model": "MoneyMeasures" } }, "/economy/unemployment": { "deprecated": { "flag": null, "message": null }, "description": "Get global unemployment data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.unemployment(provider='oecd')\nobb.economy.unemployment(country='all', frequency='quarter', provider='oecd')\n# Demographics for the statistics are selected with the `age` parameter.\nobb.economy.unemployment(country='all', frequency='quarter', age=total, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "The frequency of the data.", "default": "monthly", "optional": true, "choices": [ "monthly", "quarter", "annual" ] }, { "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 } ], "oecd": [ { "name": "country", "type": "str", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null }, { "name": "sex", "type": "Literal['total', 'male', 'female']", "description": "Sex to get unemployment for.", "default": "total", "optional": true, "choices": [ "total", "male", "female" ] }, { "name": "age", "type": "Literal['total', '15-24', '25+']", "description": "Age group to get unemployment for. Total indicates 15 years or over", "default": "total", "optional": true, "choices": [ "total", "15-24", "25+" ] }, { "name": "seasonal_adjustment", "type": "bool", "description": "Whether to get seasonally adjusted unemployment. Defaults to False.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[Unemployment]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for which unemployment rate is given", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Unemployment rate, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "Unemployment", "openapi_extra": { "model": "Unemployment" } }, "/economy/composite_leading_indicator": { "deprecated": { "flag": null, "message": null }, "description": "Get the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.composite_leading_indicator(provider='oecd')\nobb.economy.composite_leading_indicator(country=all, provider='oecd', growth_rate=True)\n```\n\n", "parameters": { "standard": [ { "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 } ], "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]]]", "description": "Country to get the CLI for, default is G20. Multiple items allowed for provider(s): oecd.", "default": "g20", "optional": true, "choices": [ "g20", "g7", "asia5", "north_america", "europe4", "australia", "brazil", "canada", "china", "france", "germany", "india", "indonesia", "italy", "japan", "mexico", "spain", "south_africa", "south_korea", "turkey", "united_states", "united_kingdom", "all" ] }, { "name": "adjustment", "type": "Literal['amplitude', 'normalized']", "description": "Adjustment of the data, either 'amplitude' or 'normalized'. Default is amplitude.", "default": "amplitude", "optional": true, "choices": null }, { "name": "growth_rate", "type": "bool", "description": "Return the 1-year growth rate (%) of the CLI, default is False.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CompositeLeadingIndicator]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "float", "description": "CLI value", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for the CLI value.", "default": "", "optional": false, "choices": null } ], "oecd": [] }, "model": "CompositeLeadingIndicator", "openapi_extra": { "model": "CompositeLeadingIndicator" } }, "/economy/short_term_interest_rate": { "deprecated": { "flag": true, "message": "This endpoint will be removed in a future version. Use, `/economy/interest_rates`, instead. Deprecated in OpenBB Platform V4.3 to be removed in V4.5." }, "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.short_term_interest_rate(provider='oecd')\nobb.economy.short_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "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 } ], "oecd": [ { "name": "country", "type": "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']", "description": "Country to get interest rate for.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarterly', 'annual']", "description": "Frequency to get interest rate for for.", "default": "monthly", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[STIR]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for which interest rate is given", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "STIR", "openapi_extra": { "model": "STIR" } }, "/economy/long_term_interest_rate": { "deprecated": { "flag": true, "message": "This endpoint will be removed in a future version. Use, `/economy/interest_rates`, instead. Deprecated in OpenBB Platform V4.3 to be removed in V4.5." }, "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.long_term_interest_rate(provider='oecd')\nobb.economy.long_term_interest_rate(country=all, frequency=quarterly, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "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 } ], "oecd": [ { "name": "country", "type": "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']", "description": "Country to get interest rate for.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarterly', 'annual']", "description": "Frequency to get interest rate for for.", "default": "monthly", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[LTIR]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Interest rate (given as a whole number, i.e 10=10%)", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for which interest rate is given", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "LTIR", "openapi_extra": { "model": "LTIR" } }, "/economy/fred_regional": { "deprecated": { "flag": null, "message": null }, "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fred_regional(symbol='NYICLAIMS', provider='fred')\n# With a date, time series data is returned.\nobb.economy.fred_regional(symbol='NYICLAIMS', start_date='2021-01-01', end_date='2021-12-31', limit=10, provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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": 100000, "optional": true, "choices": null } ], "fred": [ { "name": "symbol", "type": "str", "description": "For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the `is_series_group` parameter to True. Not all series that are in FRED have geographical data.", "default": "", "optional": false, "choices": null }, { "name": "is_series_group", "type": "bool", "description": "When True, the symbol provided is for a series_group, else it is for a series ID.", "default": false, "optional": true, "choices": null }, { "name": "region_type", "type": "Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion']", "description": "The type of regional data. Parameter is only valid when `is_series_group` is True.", "default": null, "optional": true, "choices": [ "bea", "msa", "frb", "necta", "state", "country", "county", "censusregion" ] }, { "name": "season", "type": "Literal['sa', 'nsa', 'ssa']", "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True.", "default": "nsa", "optional": true, "choices": [ "sa", "nsa", "ssa" ] }, { "name": "units", "type": "str", "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True.", "default": null, "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency.\n \n None = No change\n \n a = Annual\n \n q = Quarterly\n \n m = Monthly\n \n w = Weekly\n \n d = Daily\n \n wef = Weekly, Ending Friday\n \n weth = Weekly, Ending Thursday\n \n wew = Weekly, Ending Wednesday\n \n wetu = Weekly, Ending Tuesday\n \n wem = Weekly, Ending Monday\n \n wesu = Weekly, Ending Sunday\n \n wesa = Weekly, Ending Saturday\n \n bwew = Biweekly, Ending Wednesday\n \n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", "default": "eop", "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FredRegional]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null } ], "fred": [ { "name": "region", "type": "str", "description": "The name of the region.", "default": "", "optional": false, "choices": null }, { "name": "code", "type": "Union[str, int]", "description": "The code of the region.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "The obersvation value. The units are defined in the search results by series ID.", "default": null, "optional": true, "choices": null }, { "name": "series_id", "type": "str", "description": "The individual series ID for the region.", "default": "", "optional": false, "choices": null } ] }, "model": "FredRegional", "openapi_extra": { "model": "FredRegional" } }, "/economy/country_profile": { "deprecated": { "flag": null, "message": null }, "description": "Get a profile of country statistics and economic indicators.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.country_profile(provider='econdb', country='united_kingdom')\n# Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.\nobb.economy.country_profile(country='united_states,jp', latest=False, provider='econdb')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false, "choices": null } ], "econdb": [ { "name": "latest", "type": "bool", "description": "If True, return only the latest data. If False, return all available data for each indicator.", "default": true, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CountryProfile]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "country", "type": "str", "description": "", "default": "", "optional": false, "choices": null }, { "name": "population", "type": "int", "description": "Population.", "default": null, "optional": true, "choices": null }, { "name": "gdp_usd", "type": "float", "description": "Gross Domestic Product, in billions of USD.", "default": null, "optional": true, "choices": null }, { "name": "gdp_qoq", "type": "float", "description": "GDP growth quarter-over-quarter change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "gdp_yoy", "type": "float", "description": "GDP growth year-over-year change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "cpi_yoy", "type": "float", "description": "Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "core_yoy", "type": "float", "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "retail_sales_yoy", "type": "float", "description": "Retail Sales year-over-year change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "industrial_production_yoy", "type": "float", "description": "Industrial Production year-over-year change, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "policy_rate", "type": "float", "description": "Short term policy rate, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "yield_10y", "type": "float", "description": "10-year government bond yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "govt_debt_gdp", "type": "float", "description": "Government debt as a percent (normalized) of GDP.", "default": null, "optional": true, "choices": null }, { "name": "current_account_gdp", "type": "float", "description": "Current account balance as a percent (normalized) of GDP.", "default": null, "optional": true, "choices": null }, { "name": "jobless_rate", "type": "float", "description": "Unemployment rate, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "econdb": [] }, "model": "CountryProfile", "openapi_extra": { "model": "CountryProfile" } }, "/economy/available_indicators": { "deprecated": { "flag": null, "message": null }, "description": "Get the available economic indicators for a provider.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.available_indicators(provider='econdb')\n```\n\n", "parameters": { "standard": [], "econdb": [ { "name": "use_cache", "type": "bool", "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week.", "default": true, "optional": true, "choices": null } ], "imf": [ { "name": "query", "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, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[AvailableIndicators]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb', 'imf']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol_root", "type": "str", "description": "The root symbol representing the indicator.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data. The root symbol with additional codes.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The name of the country, region, or entity represented by the symbol.", "default": null, "optional": true, "choices": null }, { "name": "iso", "type": "str", "description": "The ISO code of the country, region, or entity represented by the symbol.", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "The description of the indicator.", "default": null, "optional": true, "choices": null }, { "name": "frequency", "type": "str", "description": "The frequency of the indicator data.", "default": null, "optional": true, "choices": null } ], "econdb": [ { "name": "currency", "type": "str", "description": "The currency, or unit, the data is based in.", "default": null, "optional": true, "choices": null }, { "name": "scale", "type": "str", "description": "The scale of the data.", "default": null, "optional": true, "choices": null }, { "name": "multiplier", "type": "int", "description": "The multiplier of the data to arrive at whole units.", "default": "", "optional": false, "choices": null }, { "name": "transformation", "type": "str", "description": "Transformation type.", "default": "", "optional": false, "choices": null }, { "name": "source", "type": "str", "description": "The original source of the data.", "default": null, "optional": true, "choices": null }, { "name": "first_date", "type": "date", "description": "The first date of the data.", "default": null, "optional": true, "choices": null }, { "name": "last_date", "type": "date", "description": "The last date of the data.", "default": null, "optional": true, "choices": null }, { "name": "last_insert_timestamp", "type": "datetime", "description": "The time of the last update. Data is typically reported with a lag.", "default": null, "optional": true, "choices": null } ], "imf": [ { "name": "dataset", "type": "str", "description": "The IMF dataset associated with the symbol.", "default": null, "optional": true, "choices": null }, { "name": "table", "type": "str", "description": "The name of the table associated with the symbol.", "default": null, "optional": true, "choices": null }, { "name": "level", "type": "int", "description": "The indentation level of the data, relative to the table and symbol_root", "default": null, "optional": true, "choices": null }, { "name": "order", "type": "Union[int, float]", "description": "Order of the data, relative to the table.", "default": null, "optional": true, "choices": null }, { "name": "children", "type": "str", "description": "The symbol of the child data, if any.", "default": null, "optional": true, "choices": null }, { "name": "unit", "type": "str", "description": "The unit of the data.", "default": null, "optional": true, "choices": null } ] }, "model": "AvailableIndicators", "openapi_extra": { "model": "AvailableIndicators" } }, "/economy/indicators": { "deprecated": { "flag": null, "message": null }, "description": "Get economic indicators by country and indicator.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.indicators(provider='econdb', symbol=PCOCO)\n# Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.\nobb.economy.indicators(symbol=CPI, country='united_states,jp', provider='econdb')\n# Use the `main` symbol to get the group of main indicators for a country.\nobb.economy.indicators(provider='econdb', symbol=main, country='eu')\n# When the provider is 'imf', the absence of a symbol will default to 'irfcl_top_lines'. Use 'IRFCL' to get all the data from the set of indicators.\nobb.economy.indicators(provider='imf')\n# When the provider is 'imf', complete tables are returned by using a 'preset'. Refer to the function's docstring for descriptions of each preset. When no country is supplied, the data is returned for all countries.\nobb.economy.indicators(provider='imf', symbol=gold_reserves)\n# When the provider is 'imf', multiple countries and symbols can be supplied. Enter countries as a two-letter ISO country code, or the country name in lower_snake_case.\nobb.economy.indicators(provider='imf', symbol=RAFA_USD,RAPFA_USD,RAFA_RAPFA_RO, country='us,china,jp,4f,gb', start_date='2010-01-01', end_date='2020-12-31', frequency=annual)\n# When the provider is 'imf', additional presets return the core Financial Soundness Indicators.\n 'fsi_core' - Core FSIs\n 'fsi_encouraged_set' - Encouraged Set of FSIs,\n 'fsi_core_underlying' - Underlying data for the Core FSIs.\n 'fsi_other' - Additional/Other FSIs that are not in the Core or Encouraged Set.\n 'fsi_all' - all FSI data for a single country.\nobb.economy.indicators(provider='imf', symbol=fsi_encouraged_set, country='us,fr,gb', start_date='2022-01-01', end_date='2023-12-31', frequency=annual)\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. The country represented by the indicator, if available. Multiple items allowed for provider(s): econdb, imf.", "default": null, "optional": true, "choices": [ "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" ] }, { "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 } ], "econdb": [ { "name": "symbol", "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, "choices": null }, { "name": "transform", "type": "Literal['toya', 'tpop', 'tusd', 'tpgp']", "description": "The transformation to apply to the data, default is None.\n\n tpop: Change from previous period\n toya: Change from one year ago\n tusd: Values as US dollars\n tpgp: Values as a percent of GDP\n\n Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results.\n This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities.\n `tusd` should only be used where values are currencies.", "default": null, "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['annual', 'quarter', 'month']", "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'.", "default": "quarter", "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data.", "default": true, "optional": true, "choices": null } ], "imf": [ { "name": "symbol", "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, "choices": null }, { "name": "frequency", "type": "Literal['annual', 'quarter', 'month']", "description": "Frequency of the data, default is 'quarter'.", "default": "quarter", "optional": true, "choices": [ "annual", "quarter", "month" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EconomicIndicators]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb', 'imf']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol_root", "type": "str", "description": "The root symbol for the indicator (e.g. GDP).", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country represented by the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "", "default": null, "optional": true, "choices": null } ], "econdb": [], "imf": [ { "name": "unit", "type": "str", "description": "The unit of the value.", "default": null, "optional": true, "choices": null }, { "name": "scale", "type": "str", "description": "The scale of the value.", "default": null, "optional": true, "choices": null }, { "name": "table", "type": "str", "description": "The name of the table associated with the symbol.", "default": null, "optional": true, "choices": null }, { "name": "level", "type": "int", "description": "The indentation level of the data, relative to the table and symbol_root", "default": null, "optional": true, "choices": null }, { "name": "order", "type": "Union[int, float]", "description": "Order of the data, relative to the table.", "default": null, "optional": true, "choices": null }, { "name": "reference_sector", "type": "str", "description": "The reference sector for the data.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "The title of the series associated with the symbol.", "default": null, "optional": true, "choices": null } ] }, "model": "EconomicIndicators", "openapi_extra": { "model": "EconomicIndicators" } }, "/economy/central_bank_holdings": { "deprecated": { "flag": null, "message": null }, "description": "Get the balance sheet holdings of a central bank.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# The default is the latest Treasury securities held by the Federal Reserve.\nobb.economy.central_bank_holdings(provider='federal_reserve')\n# Get historical summaries of the Fed's holdings.\nobb.economy.central_bank_holdings(provider='federal_reserve', summary=True)\n# Get the balance sheet holdings as-of a historical date.\nobb.economy.central_bank_holdings(provider='federal_reserve', date='2019-05-21')\n# Use the `holding_type` parameter to select Agency securities, or specific categories or Treasury securities.\nobb.economy.central_bank_holdings(provider='federal_reserve', holding_type=agency_debts)\n```\n\n", "parameters": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null } ], "federal_reserve": [ { "name": "holding_type", "type": "Literal['all_agency', 'agency_debts', 'mbs', 'cmbs', 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips']", "description": "Type of holdings to return.", "default": "all_treasury", "optional": true, "choices": [ "all_agency", "agency_debts", "mbs", "cmbs", "all_treasury", "bills", "notesbonds", "frn", "tips" ] }, { "name": "summary", "type": "bool", "description": "If True, returns historical weekly summary by holding type. This parameter takes priority over other parameters.", "default": false, "optional": true, "choices": null }, { "name": "cusip", "type": "Union[str, list[str]]", "description": " Multiple items allowed for provider(s): federal_reserve.", "default": null, "optional": true, "choices": null }, { "name": "wam", "type": "bool", "description": "If True, returns weighted average maturity aggregated by agency or treasury securities. This parameter takes priority over `holding_type`, `cusip`, and `monthly`.", "default": false, "optional": true, "choices": null }, { "name": "monthly", "type": "bool", "description": "If True, returns historical data for all Treasury securities at a monthly interval. This parameter takes priority over other parameters, except `wam`. Only valid when `holding_type` is set to: 'all_treasury', 'bills', 'notesbonds', 'frn', 'tips'.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CentralBankHoldings]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null } ], "federal_reserve": [ { "name": "security_type", "type": "str", "description": "Type of security - i.e. TIPs, FRNs, etc.", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "Description of the security. Only returned for Agency securities.", "default": null, "optional": true, "choices": null }, { "name": "is_aggreated", "type": "Literal['Y']", "description": "Whether the security is aggregated. Only returned for Agency securities.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "", "default": null, "optional": true, "choices": null }, { "name": "issuer", "type": "str", "description": "Issuer of the security.", "default": null, "optional": true, "choices": null }, { "name": "maturity_date", "type": "date", "description": "Maturity date of the security.", "default": null, "optional": true, "choices": null }, { "name": "term", "type": "str", "description": "Term of the security. Only returned for Agency securities.", "default": null, "optional": true, "choices": null }, { "name": "face_value", "type": "float", "description": "Current face value of the security (Thousands of $USD). Current face value of the securities, which is the remaining principal balance of the securities.", "default": null, "optional": true, "choices": null }, { "name": "par_value", "type": "float", "description": "Par value of the security (Thousands of $USD). Changes in par may reflect primary and secondary market transactions and/or custodial account activity.", "default": null, "optional": true, "choices": null }, { "name": "coupon", "type": "float", "description": "Coupon rate of the security.", "default": null, "optional": true, "choices": null }, { "name": "spread", "type": "float", "description": "Spread to the current reference rate, as determined at each security's initial auction.", "default": null, "optional": true, "choices": null }, { "name": "percent_outstanding", "type": "float", "description": "Total percent of the outstanding CUSIP issuance.", "default": null, "optional": true, "choices": null }, { "name": "bills", "type": "float", "description": "Treasury bills amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "frn", "type": "float", "description": "Floating rate Treasury notes amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "notes_and_bonds", "type": "float", "description": "Treasuy Notes and bonds amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "tips", "type": "float", "description": "Treasury inflation-protected securities amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "mbs", "type": "float", "description": "Mortgage-backed securities amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "cmbs", "type": "float", "description": "Commercial mortgage-backed securities amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "agencies", "type": "float", "description": "Agency securities amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "total", "type": "float", "description": "Total SOMA holdings amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "tips_inflation_compensation", "type": "float", "description": "Treasury inflation-protected securities inflation compensation amount (Thousands of $USD). Only returned when 'summary' is True.", "default": null, "optional": true, "choices": null }, { "name": "change_prior_week", "type": "float", "description": "Change in SOMA holdings from the prior week (Thousands of $USD).", "default": null, "optional": true, "choices": null }, { "name": "change_prior_year", "type": "float", "description": "Change in SOMA holdings from the prior year (Thousands of $USD).", "default": null, "optional": true, "choices": null } ] }, "model": "CentralBankHoldings", "openapi_extra": { "model": "CentralBankHoldings" } }, "/economy/share_price_index": { "deprecated": { "flag": null, "message": null }, "description": "Get the Share Price Index by country from the OECD Short-Term Economics Statistics.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.share_price_index(provider='oecd')\n# Multiple countries can be passed in as a list.\nobb.economy.share_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "The frequency of the data.", "default": "monthly", "optional": true, "choices": [ "monthly", "quarter", "annual" ] }, { "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 } ], "oecd": [ { "name": "country", "type": "str", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SharePriceIndex]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Share price index value.", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "SharePriceIndex", "openapi_extra": { "model": "SharePriceIndex" } }, "/economy/house_price_index": { "deprecated": { "flag": null, "message": null }, "description": "Get the House Price Index by country from the OECD Short-Term Economics Statistics.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.house_price_index(provider='oecd')\n# Multiple countries can be passed in as a list.\nobb.economy.house_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "The frequency of the data.", "default": "quarter", "optional": true, "choices": [ "monthly", "quarter", "annual" ] }, { "name": "transform", "type": "Literal['index', 'yoy', 'period']", "description": "Transformation of the CPI data. Period represents the change since previous. Defaults to change from one year ago (yoy).", "default": "index", "optional": true, "choices": [ "index", "yoy", "period" ] }, { "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 } ], "oecd": [ { "name": "country", "type": "str", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HousePriceIndex]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Share price index value.", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "HousePriceIndex", "openapi_extra": { "model": "HousePriceIndex" } }, "/economy/immediate_interest_rate": { "deprecated": { "flag": true, "message": "This endpoint will be removed in a future version. Use, `/economy/interest_rates`, instead. Deprecated in OpenBB Platform V4.3 to be removed in V4.5." }, "description": "Get immediate interest rates by country.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.immediate_interest_rate(provider='oecd')\n# Multiple countries can be passed in as a list.\nobb.economy.immediate_interest_rate(country='united_kingdom,germany', frequency=monthly, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): oecd.", "default": "united_states", "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 } ], "oecd": [ { "name": "country", "type": "str", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "The frequency of the data.", "default": "monthly", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ImmediateInterestRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for which interest rate is given", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Immediate interest rates, call money, interbank rate.", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "ImmediateInterestRate", "openapi_extra": { "model": "ImmediateInterestRate" } }, "/economy/interest_rates": { "deprecated": { "flag": null, "message": null }, "description": "Get interest rates by country(s) and duration.\nMost OECD countries publish short-term, a long-term, and immediate rates monthly.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.interest_rates(provider='oecd')\n# For OECD, duration can be 'immediate', 'short', or 'long'. Default is 'short', which is the 3-month rate. Overnight interbank rate is 'immediate', and 10-year rate is 'long'.\nobb.economy.interest_rates(provider='oecd', country='all', duration=immediate, frequency=quarter)\n# Multiple countries can be passed in as a list.\nobb.economy.interest_rates(duration=long, country='united_kingdom,germany', frequency=monthly, provider='oecd')\n```\n\n", "parameters": { "standard": [ { "name": "country", "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" ] }, { "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 } ], "oecd": [ { "name": "duration", "type": "Literal['immediate', 'short', 'long']", "description": "Duration of the interest rate. 'immediate' is the overnight rate, 'short' is the 3-month rate, and 'long' is the 10-year rate.", "default": "short", "optional": true, "choices": [ "immediate", "short", "long" ] }, { "name": "frequency", "type": "Literal['monthly', 'quarter', 'annual']", "description": "Frequency to get interest rate for for.", "default": "monthly", "optional": true, "choices": [ "monthly", "quarter", "annual" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CountryInterestRates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['oecd']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The interest rate value.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country for which the interest rate is given.", "default": null, "optional": true, "choices": null } ], "oecd": [] }, "model": "CountryInterestRates", "openapi_extra": { "model": "CountryInterestRates" } }, "/economy/retail_prices": { "deprecated": { "flag": null, "message": null }, "description": "Get retail prices for common items.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.retail_prices(provider='fred')\n# The price of eggs in the northeast census region.\nobb.economy.retail_prices(item='eggs', region=northeast, provider='fred')\n# The percentage change in price, from one-year ago, of various meats, US City Average.\nobb.economy.retail_prices(item='meats', transform=pc1, provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "item", "type": "str", "description": "The item or basket of items to query.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country to get data.", "default": "united_states", "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 } ], "fred": [ { "name": "item", "type": "Literal['beverages', 'cereals', 'dairy', 'fuel', 'produce', 'meats', 'bacon', 'bananas', 'beans', 'beef', 'beer', 'bread', 'butter', 'cheese', 'chicken', 'chops', 'coffee', 'cookies', 'corn', 'diesel', 'eggs', 'electricity', 'flour', 'gas', 'gasoline', 'grapefruit', 'ground_beef', 'ham', 'ice_cream', 'lemons', 'lettuce', 'malt_beverages', 'milk', 'oil', 'orange_juice', 'oranges', 'pork', 'potato_chips', 'potatoes', 'rice', 'soft_drinks', 'spaghetti', 'steak', 'strawberries', 'sugar', 'tomatoes', 'unleaded', 'usda', 'vodka', 'wine', 'yogurt']", "description": "The item or basket of items to query.", "default": "fuel", "optional": true, "choices": null }, { "name": "country", "type": "Literal['united_states']", "description": "The country to get data.", "default": "united_states", "optional": true, "choices": null }, { "name": "region", "type": "Literal['all_city', 'northeast', 'midwest', 'south', 'west']", "description": "The region to get average price levels for.", "default": "all_city", "optional": true, "choices": null }, { "name": "frequency", "type": "Literal['annual', 'quarter', 'monthly']", "description": "The frequency of the data.", "default": "monthly", "optional": true, "choices": null }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[RetailPrices]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "Description of the item.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Price, or change in price, per unit.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "RetailPrices", "openapi_extra": { "model": "RetailPrices" } }, "/economy/primary_dealer_positioning": { "deprecated": { "flag": null, "message": null }, "description": "Get Primary dealer positioning statistics.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.primary_dealer_positioning(provider='federal_reserve')\nobb.economy.primary_dealer_positioning(category=abs, provider='federal_reserve')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [ { "name": "category", "type": "Literal['treasuries', 'bills', 'coupons', 'notes', 'tips', 'mbs', 'cmbs', 'municipal', 'corporate', 'commercial_paper', 'corporate_ig', 'corporate_junk', 'abs']", "description": "The category of asset to return, defaults to 'treasuries'.", "default": "treasuries", "optional": true, "choices": [ "treasuries", "bills", "coupons", "notes", "tips", "mbs", "cmbs", "municipal", "corporate", "commercial_paper", "corporate_ig", "corporate_junk", "abs" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PrimaryDealerPositioning]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null } ], "federal_reserve": [ { "name": "value", "type": "int", "description": "The reported value of the net position (long - short), in millions of $USD.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Short name for the series.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the series.", "default": "", "optional": false, "choices": null } ] }, "model": "PrimaryDealerPositioning", "openapi_extra": { "model": "PrimaryDealerPositioning" } }, "/economy/pce": { "deprecated": { "flag": null, "message": null }, "description": "Get Personal Consumption Expenditures (PCE) reports.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.pce(provider='fred')\n# Get reports for multiple dates, entered as a comma-separated string.\nobb.economy.pce(provider='fred', date='2024-05-01,2024-04-01,2023-05-01', category=pce_price_index)\n```\n\n", "parameters": { "standard": [ { "name": "date", "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, "choices": null } ], "fred": [ { "name": "category", "type": "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']", "description": "The category to query.", "default": "personal_income", "optional": true, "choices": [ "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" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PersonalConsumptionExpenditures]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "float", "description": "", "default": "", "optional": false, "choices": null } ], "fred": [ { "name": "name", "type": "str", "description": "The name of the series.", "default": "", "optional": false, "choices": null }, { "name": "element_id", "type": "str", "description": "The element id in the parent/child relationship.", "default": "", "optional": false, "choices": null }, { "name": "parent_id", "type": "str", "description": "The parent id in the parent/child relationship.", "default": "", "optional": false, "choices": null }, { "name": "children", "type": "str", "description": "The element_id of each child, as a comma-separated string.", "default": null, "optional": true, "choices": null }, { "name": "level", "type": "int", "description": "The indentation level of the element.", "default": "", "optional": false, "choices": null }, { "name": "line", "type": "int", "description": "The line number of the series in the table.", "default": "", "optional": false, "choices": null } ] }, "model": "PersonalConsumptionExpenditures", "openapi_extra": { "model": "PersonalConsumptionExpenditures" } }, "/economy/export_destinations": { "deprecated": { "flag": null, "message": null }, "description": "Get top export destinations by country from the UN Comtrade International Trade Statistics Database.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.export_destinations(provider='econdb', country='us')\n```\n\n", "parameters": { "standard": [ { "name": "country", "type": "Union[str, list[str]]", "description": "The country to get data. Multiple items allowed for provider(s): econdb.", "default": "", "optional": false, "choices": null } ], "econdb": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ExportDestinations]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "origin_country", "type": "str", "description": "The country of origin.", "default": "", "optional": false, "choices": null }, { "name": "destination_country", "type": "str", "description": "The destination country.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "Union[float, int]", "description": "The value of the export.", "default": "", "optional": false, "choices": null } ], "econdb": [ { "name": "units", "type": "str", "description": "The units of measurement for the value.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "The title of the data.", "default": "", "optional": false, "choices": null }, { "name": "footnote", "type": "str", "description": "The footnote for the data.", "default": "", "optional": false, "choices": null } ] }, "model": "ExportDestinations", "openapi_extra": { "model": "ExportDestinations" } }, "/economy/primary_dealer_fails": { "deprecated": { "flag": null, "message": null }, "description": "Primary Dealer Statistics for Fails to Deliver and Fails to Receive.\n\nData from the NY Federal Reserve are updated on Thursdays at approximately\n4:15 p.m. with the previous week's statistics.\n\nFor research on the topic, see:\nhttps://www.federalreserve.gov/econres/notes/feds-notes/the-systemic-nature-of-settlement-fails-20170703.html\n\n\"Large and protracted settlement fails are believed to undermine the liquidity\nand well-functioning of securities markets.\n\nNear-100 percent pass-through of fails suggests a high degree of collateral\nre-hypothecation together with the inability or unwillingness to borrow or buy the needed securities.\"", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.primary_dealer_fails(provider='federal_reserve')\n# Transform the data to be percentage totals by asset class\nobb.economy.primary_dealer_fails(provider='federal_reserve', unit=percent)\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [ { "name": "asset_class", "type": "Literal['all', 'treasuries', 'tips', 'agency', 'mbs', 'corporate']", "description": "Asset class to return, default is 'all'.", "default": "all", "optional": true, "choices": [ "all", "treasuries", "tips", "agency", "mbs", "corporate" ] }, { "name": "unit", "type": "Literal['value', 'percent']", "description": "Unit of the data returned to the 'value' field. Default is 'value', which represents millions of USD. 'percent' returns data as the percentage of the total fails-to-receive and fails-to-deliver, by asset class.", "default": "value", "optional": true, "choices": [ "value", "percent" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PrimaryDealerFails]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null } ], "federal_reserve": [ { "name": "title", "type": "str", "description": "Title of the series' symbol.", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "Union[int, float]", "description": "Value of the data returned, in millions of USD if the `unit` parameter is 'value' else a normalized percent.", "default": "", "optional": false, "choices": null } ] }, "model": "PrimaryDealerFails", "openapi_extra": { "model": "PrimaryDealerFails" } }, "/economy/port_volume": { "deprecated": { "flag": null, "message": null }, "description": "Get average dwelling times and TEU volumes from the top ports.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.port_volume(provider='econdb')\n```\n\n", "parameters": { "standard": [ { "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 } ], "econdb": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PortVolume]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "port_code", "type": "str", "description": "Port code.", "default": null, "optional": true, "choices": null }, { "name": "port_name", "type": "str", "description": "Port name.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Country where the port is located.", "default": null, "optional": true, "choices": null } ], "econdb": [ { "name": "export_dwell_time", "type": "float", "description": "EconDB model estimate for the average number of days from when a container enters the terminal gates until it is loaded on a vessel. High dwelling times can indicate vessel delays.", "default": null, "optional": true, "choices": null }, { "name": "import_dwell_time", "type": "float", "description": "EconDB model estimate for the average number of days from when a container is discharged from a vessel until it exits the terminal gates. High dwelling times can indicate trucking or port congestion.", "default": null, "optional": true, "choices": null }, { "name": "import_teu", "type": "int", "description": "EconDB model estimate for the number of twenty-foot equivalent units (TEUs) of containers imported through the port.", "default": null, "optional": true, "choices": null }, { "name": "export_teu", "type": "int", "description": "EconDB model estimate for the number of twenty-foot equivalent units (TEUs) of containers exported through the port.", "default": null, "optional": true, "choices": null } ] }, "model": "PortVolume", "openapi_extra": { "model": "PortVolume" } }, "/economy/direction_of_trade": { "deprecated": { "flag": null, "message": null }, "description": "Get Direction Of Trade Statistics from the IMF database.\n\nThe Direction of Trade Statistics (DOTS) presents the value of merchandise exports and\nimports disaggregated according to a country's primary trading partners.\nArea and world aggregates are included in the display of trade flows between major areas of the world.\nReported data is supplemented by estimates whenever such data is not available or current.\nImports are reported on a cost, insurance and freight (CIF) basis\nand exports are reported on a free on board (FOB) basis.\nTime series data includes estimates derived from reports of partner countries\nfor non-reporting and slow-reporting countries.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.direction_of_trade(provider='imf', country='all', counterpart='china')\n# Select multiple countries or counterparts by entering a comma-separated list. The direction of trade can be 'exports', 'imports', 'balance', or 'all'.\nobb.economy.direction_of_trade(provider='imf', country='us', counterpart='world,eu', frequency='annual', direction='exports')\n```\n\n", "parameters": { "standard": [ { "name": "country", "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, "choices": [ "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" ] }, { "name": "counterpart", "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, "choices": [ "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" ] }, { "name": "direction", "type": "Literal['exports', 'imports', 'balance', 'all']", "description": "Trade direction. Use 'all' to get all data for this dimension.", "default": "balance", "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": "frequency", "type": "Literal['month', 'quarter', 'annual']", "description": "The frequency of the data.", "default": "month", "optional": true, "choices": null } ], "imf": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[DirectionOfTrade]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['imf']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "", "default": "", "optional": false, "choices": null }, { "name": "counterpart", "type": "str", "description": "Counterpart country or region to the trade.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title corresponding to the symbol.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Trade value.", "default": "", "optional": false, "choices": null }, { "name": "scale", "type": "str", "description": "Scale of the value.", "default": null, "optional": true, "choices": null } ], "imf": [] }, "model": "DirectionOfTrade", "openapi_extra": { "model": "DirectionOfTrade" } }, "/economy/fomc_documents": { "deprecated": { "flag": null, "message": null }, "description": "Get FOMC documents by year and document type.\nOptionally, download the file directly from the Federal Reserve's website.\n\nSource: https://www.federalreserve.gov/monetarypolicy/fomc_historical.htm\nSource: https://www.federalreserve.gov/monetarypolicy/fomccalendars.htm\n\nThis function does not return the typical OBBject response.\n\nThe response is `list[dict[str, str]]` of FOMC documents and their URLs.\n\nEach dictionary entry has keys: `date`, `url`, `doc_type`, and `doc_format`.\n\nIf `as_choices` is True, the response is a list of valid Workspace parameter choices.\nKeys, `label` and `value`, correspond with the `doc_type` + `date`, and the `url`, respectively.\n\nIf `url` was provided, the response is a `dict[str, Any]` with keys `filename`, `content`, and `data_format`.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.economy.fomc_documents(provider='federal_reserve')\n# Filter all documents by year.\nobb.economy.fomc_documents(provider='federal_reserve', year=2022)\n# Filter all documents by year and document type.\nobb.economy.fomc_documents(provider='federal_reserve', year=2022, document_type=minutes)\n# The `url` parameter will override all other parameters to download the document. The response will be a dictionary with keys `filename`, `content`, and `data_format`. PDF content will be a base64 encoded string of the document.\nobb.economy.fomc_documents(provider='federal_reserve', url=https://www.federalreserve.gov/monetarypolicy/files/fomcminutes20220126.pdf)\n```\n\n", "parameters": { "standard": [], "federal_reserve": [ { "name": "year", "type": "int", "description": "The year of FOMC documents to retrieve. If None, all years since 1959 are returned.", "default": null, "optional": true, "choices": null }, { "name": "document_type", "type": "str", "description": "Filter by document type. Default is all. Choose from: all, monetary_policy, minutes, projections, materials, press_release, press_conference, conference_call, agenda, transcript, speaker_key, beige_book, teal_book, green_book, blue_book, red_book", "default": null, "optional": true, "choices": null }, { "name": "pdf_only", "type": "bool", "description": "Whether to return as a list with only the PDF documents. Default is False.", "default": false, "optional": true, "choices": null }, { "name": "as_choices", "type": "bool", "description": "Whether to return cast as a list of valid Workspace parameter choices. Leave as False for typical use.", "default": false, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "Download a document from the supplied URL. When provided, all other parameters are ignored. Content is returned as a base64 encoded string.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FomcDocuments]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "federal_reserve": [ { "name": "content", "type": "Any", "description": "The content of request results. If `url` was provided, the content is a dictionary with keys `filename` and `content`. Otherwise, it is a list of dictionaries with a mapping of FOMC documents to URLs. The endpoint response will not be an OBBject.results object, but the content directly.", "default": null, "optional": true, "choices": null } ] }, "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": { "flag": null, "message": null }, "description": "Get historical and upcoming initial public offerings (IPOs).", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.ipo(provider='intrinio')\n# Get all IPOs available.\nobb.equity.calendar.ipo(provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "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": 100, "optional": true, "choices": null } ], "intrinio": [ { "name": "status", "type": "Literal['upcoming', 'priced', 'withdrawn']", "description": "Status of the IPO. [upcoming, priced, or withdrawn]", "default": null, "optional": true, "choices": null }, { "name": "min_value", "type": "int", "description": "Return IPOs with an offer dollar amount greater than the given amount.", "default": null, "optional": true, "choices": null }, { "name": "max_value", "type": "int", "description": "Return IPOs with an offer dollar amount less than the given amount.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CalendarIpo]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "ipo_date", "type": "date", "description": "The date of the IPO, when the stock first trades on a major exchange.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "status", "type": "Literal['upcoming', 'priced', 'withdrawn']", "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ.", "default": null, "optional": true, "choices": null }, { "name": "offer_amount", "type": "float", "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count", "default": null, "optional": true, "choices": null }, { "name": "share_price", "type": "float", "description": "The price per share at which the IPO was offered.", "default": null, "optional": true, "choices": null }, { "name": "share_price_lowest", "type": "float", "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true, "choices": null }, { "name": "share_price_highest", "type": "float", "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs).", "default": null, "optional": true, "choices": null }, { "name": "share_count", "type": "int", "description": "The number of shares offered in the IPO.", "default": null, "optional": true, "choices": null }, { "name": "share_count_lowest", "type": "int", "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true, "choices": null }, { "name": "share_count_highest", "type": "int", "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs).", "default": null, "optional": true, "choices": null }, { "name": "announcement_url", "type": "str", "description": "The URL to the company's announcement of the IPO", "default": null, "optional": true, "choices": null }, { "name": "sec_report_url", "type": "str", "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.", "default": null, "optional": true, "choices": null }, { "name": "open_price", "type": "float", "description": "The opening price at the beginning of the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "close_price", "type": "float", "description": "The closing price at the end of the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The volume at the end of the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "day_change", "type": "float", "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "week_change", "type": "float", "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "month_change", "type": "float", "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs).", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "The Intrinio ID of the IPO.", "default": null, "optional": true, "choices": null }, { "name": "company", "type": "IntrinioCompany", "description": "The company that is going public via the IPO.", "default": null, "optional": true, "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The primary Security for the Company that is going public via the IPO", "default": null, "optional": true, "choices": null } ] }, "model": "CalendarIpo", "openapi_extra": { "model": "CalendarIpo" } }, "/equity/calendar/dividend": { "deprecated": { "flag": null, "message": null }, "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.dividend(provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CalendarDividend]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "ex_dividend_date", "type": "date", "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "amount", "type": "float", "description": "The dividend amount per share.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "record_date", "type": "date", "description": "The record date of ownership for eligibility.", "default": null, "optional": true, "choices": null }, { "name": "payment_date", "type": "date", "description": "The payment date of the dividend.", "default": null, "optional": true, "choices": null }, { "name": "declaration_date", "type": "date", "description": "Declaration date of the dividend.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "adjusted_amount", "type": "float", "description": "The adjusted-dividend amount.", "default": null, "optional": true, "choices": null }, { "name": "label", "type": "str", "description": "Ex-dividend date formatted for display.", "default": null, "optional": true, "choices": null } ] }, "model": "CalendarDividend", "openapi_extra": { "model": "CalendarDividend" } }, "/equity/calendar/splits": { "deprecated": { "flag": null, "message": null }, "description": "Get historical and upcoming stock split operations.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.splits(provider='fmp')\n# Get stock splits calendar for specific dates.\nobb.equity.calendar.splits(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CalendarSplits]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "label", "type": "str", "description": "Label of the stock splits.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "numerator", "type": "float", "description": "Numerator of the stock splits.", "default": "", "optional": false, "choices": null }, { "name": "denominator", "type": "float", "description": "Denominator of the stock splits.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "CalendarSplits", "openapi_extra": { "model": "CalendarSplits" } }, "/equity/calendar/events": { "deprecated": { "flag": null, "message": null }, "description": "Get historical and upcoming company events, such as Investor Day, Conference Call, Earnings Release.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.events(provider='fmp')\n# Get company events calendar for specific dates.\nobb.equity.calendar.events(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CalendarEvents]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data. The date of the event.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "exchange", "type": "str", "description": "Exchange where the symbol is listed.", "default": null, "optional": true, "choices": null }, { "name": "time", "type": "str", "description": "The estimated time of the event, local to the exchange.", "default": null, "optional": true, "choices": null }, { "name": "timing", "type": "str", "description": "The timing of the event - e.g. before, during, or after market hours.", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "The title of the event.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "The URL to the press release for the announcement.", "default": null, "optional": true, "choices": null }, { "name": "announcement_date", "type": "date", "description": "The date when the event was announced.", "default": null, "optional": true, "choices": null } ] }, "model": "CalendarEvents", "openapi_extra": { "model": "CalendarEvents" } }, "/equity/calendar/earnings": { "deprecated": { "flag": null, "message": null }, "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.calendar.earnings(provider='fmp')\n# Get earnings calendar for specific dates.\nobb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CalendarEarnings]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "report_date", "type": "date", "description": "The date of the earnings report.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "eps_previous", "type": "float", "description": "The earnings-per-share from the same previously reported period.", "default": null, "optional": true, "choices": null }, { "name": "eps_consensus", "type": "float", "description": "The analyst conesus earnings-per-share estimate.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "eps_actual", "type": "float", "description": "The actual earnings per share announced.", "default": null, "optional": true, "choices": null }, { "name": "revenue_actual", "type": "float", "description": "The actual reported revenue.", "default": null, "optional": true, "choices": null }, { "name": "revenue_consensus", "type": "float", "description": "The revenue forecast consensus.", "default": null, "optional": true, "choices": null }, { "name": "period_ending", "type": "date", "description": "The fiscal period end date.", "default": null, "optional": true, "choices": null }, { "name": "reporting_time", "type": "str", "description": "The reporting time - e.g. after market close.", "default": null, "optional": true, "choices": null }, { "name": "updated_date", "type": "date", "description": "The date the data was updated last.", "default": null, "optional": true, "choices": null } ] }, "model": "CalendarEarnings", "openapi_extra": { "model": "CalendarEarnings" } }, "/equity/compare/peers": { "deprecated": { "flag": null, "message": null }, "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.peers(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityPeers]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "peers_list", "type": "list[str]", "description": "A list of equity peers based on sector, exchange and market cap.", "default": "", "optional": true, "choices": null } ], "fmp": [] }, "model": "EquityPeers", "openapi_extra": { "model": "EquityPeers" } }, "/equity/compare/company_facts": { "deprecated": { "flag": null, "message": null }, "description": "Compare reported company facts and fundamental data points.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.compare.company_facts(provider='sec')\nobb.equity.compare.company_facts(provider='sec', fact='PaymentsForRepurchaseOfCommonStock', year=2023)\nobb.equity.compare.company_facts(provider='sec', symbol='NVDA,AAPL,AMZN,MSFT,GOOG,SMCI', fact='RevenueFromContractWithCustomerExcludingAssessedTax', year=2024)\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): sec.", "default": null, "optional": true, "choices": null }, { "name": "fact", "type": "str", "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.", "default": "", "optional": true, "choices": null } ], "sec": [ { "name": "fact", "type": "Literal['AccountsPayableCurrent', 'AccountsReceivableNet', 'AccountsReceivableNetCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrent', 'AccrualForTaxesOtherThanIncomeTaxesCurrentAndNoncurrent', 'AccruedIncomeTaxesCurrent', 'AccruedIncomeTaxesNoncurrent', 'AccruedInsuranceCurrent', 'AccruedLiabilitiesCurrent', 'AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment', 'AccumulatedOtherComprehensiveIncomeLossNetOfTax', 'AcquisitionsNetOfCashAcquiredAndPurchasesOfIntangibleAndOtherAssets', 'AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue', 'AdvertisingExpense', 'AllocatedShareBasedCompensationExpense', 'AntidilutiveSecuritiesExcludedFromComputationOfEarningsPerShareAmount', 'Assets', 'AssetsCurrent', 'AssetsNoncurrent', 'NoncurrentAssets', 'AssetImpairmentCharges', 'BuildingsAndImprovementsGross', 'CapitalLeaseObligationsCurrent', 'CapitalLeaseObligationsNoncurrent', 'Cash', 'CashAndCashEquivalentsAtCarryingValue', 'CashCashEquivalentsAndShortTermInvestments', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalents', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsIncludingDisposalGroupAndDiscontinuedOperations', 'CashCashEquivalentsRestrictedCashAndRestrictedCashEquivalentsPeriodIncreaseDecreaseIncludingExchangeRateEffect', 'CommitmentsAndContingencies', 'CommercialPaper', 'CommonStockDividendsPerShareDeclared', 'CommonStockDividendsPerShareCashPaid', 'CommonStocksIncludingAdditionalPaidInCapital', 'ComprehensiveIncomeNetOfTax', 'ComprehensiveIncomeNetOfTaxAttributableToNoncontrollingInterest', 'ComprehensiveIncomeNetOfTaxIncludingPortionAttributableToNoncontrollingInterest', 'ConstructionInProgressGross', 'ContractWithCustomerAssetNet', 'ContractWithCustomerLiability', 'ContractWithCustomerLiabilityCurrent', 'ContractWithCustomerLiabilityNoncurrent', 'CostOfRevenue', 'CostOfGoodsAndServicesSold', 'CurrentFederalTaxExpenseBenefit', 'CurrentForeignTaxExpenseBenefit', 'CurrentIncomeTaxExpenseBenefit', 'CurrentStateAndLocalTaxExpenseBenefit', 'DebtInstrumentFaceAmount', 'DebtInstrumentFairValue', 'DebtLongtermAndShorttermCombinedAmount', 'DeferredFederalIncomeTaxExpenseBenefit', 'DeferredForeignIncomeTaxExpenseBenefit', 'DeferredIncomeTaxExpenseBenefit', 'DeferredIncomeTaxesAndTaxCredits', 'DeferredIncomeTaxLiabilities', 'DeferredIncomeTaxLiabilitiesNet', 'DeferredRevenue', 'DeferredTaxAssetsGross', 'DeferredTaxAssetsLiabilitiesNet', 'DeferredTaxAssetsNet', 'DeferredTaxLiabilities', 'DefinedContributionPlanCostRecognized', 'Depreciation', 'DepreciationAmortizationAndAccretionNet', 'DepreciationAmortizationAndOther', 'DepreciationAndAmortization', 'DepreciationDepletionAndAmortization', 'DerivativeCollateralObligationToReturnCash', 'DerivativeCollateralRightToReclaimCash', 'DerivativeFairValueOfDerivativeNet', 'DerivativeLiabilityCollateralRightToReclaimCashOffset', 'DerivativeNotionalAmount', 'Dividends', 'DividendsCash', 'DividendsPayableAmountPerShare', 'DividendsPayableCurrent', 'DistributedEarnings', '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', 'InterestAndDebtExpense', 'IncomeTaxExpenseBenefit', 'IncomeTaxesPaid', 'IncomeTaxesPaidNet', 'IncreaseDecreaseInAccountsAndOtherReceivables', 'IncreaseDecreaseInAccountsPayable', 'IncreaseDecreaseInAccountsReceivable', 'IncreaseDecreaseInAccruedLiabilities', 'IncreaseDecreaseInAccruedIncomeTaxesPayable', 'IncreaseDecreaseInAccruedTaxesPayable', 'IncreaseDecreaseInContractWithCustomerLiability', 'IncreaseDecreaseInDeferredIncomeTaxes', 'IncreaseDecreaseInInventories', 'IncreaseDecreaseInOtherCurrentAssets', 'IncreaseDecreaseInOtherCurrentLiabilities', 'IncreaseDecreaseInOtherNoncurrentAssets', 'IncreaseDecreaseInOtherNoncurrentLiabilities', 'IncreaseDecreaseInPensionPlanObligations', 'IncrementalCommonSharesAttributableToShareBasedPaymentArrangements', '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', 'NonoperatingIncomeExpense', 'NoninterestIncome', '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', 'PaymentsOfDividends', 'PaymentsOfDividendsMinorityInterest', 'PaymentsForProceedsFromBusinessesAndInterestInAffiliates', 'PaymentsForProceedsFromOtherInvestingActivities', 'PaymentsForRent', 'PaymentsForRepurchaseOfCommonStock', 'PaymentsOfDebtExtinguishmentCosts', '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', 'Revenues', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'SecuredLongTermDebt', 'SellingAndMarketingExpense', 'SellingGeneralAndAdministrativeExpense', 'ShareBasedCompensation', 'ShortTermBorrowings', 'ShortTermInvestments', 'StockholdersEquity', 'StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest', 'StockholdersEquityOther', 'StockIssuedDuringPeriodValueNewIssues', 'StockOptionPlanExpense', 'StockRedeemedOrCalledDuringPeriodValue', 'StockRepurchasedDuringPeriodValue', 'StockRepurchasedAndRetiredDuringPeriodValue', 'TaxesPayableCurrent', 'TradingSecuritiesDebt', 'TreasuryStockAcquiredAverageCostPerShare', 'TreasuryStockSharesAcquired', 'UnrealizedGainLossOnInvestments', 'UnrecognizedTaxBenefits', 'UnsecuredDebt', 'VariableLeaseCost', 'WeightedAverageNumberOfDilutedSharesOutstanding', 'WeightedAverageNumberOfSharesOutstandingBasic', 'WeightedAverageNumberDilutedSharesOutstandingAdjustment']", "description": "Fact or concept from the SEC taxonomy, in UpperCamelCase. Defaults to, 'Revenues'. AAPL, MSFT, GOOG, BRK-A currently report revenue as, 'RevenueFromContractWithCustomerExcludingAssessedTax'. In previous years, they have reported as 'Revenues'.", "default": "Revenues", "optional": true, "choices": null }, { "name": "year", "type": "int", "description": "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.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", "description": "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.", "default": null, "optional": true, "choices": [ "fy", "q1", "q2", "q3", "q4" ] }, { "name": "instantaneous", "type": "bool", "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe 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.", "default": false, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether to use cache for the request. Defaults to True.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CompareCompanyFacts]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The reported value of the fact or concept.", "default": "", "optional": false, "choices": null }, { "name": "reported_date", "type": "date", "description": "The date when the report was filed.", "default": null, "optional": true, "choices": null }, { "name": "period_beginning", "type": "date", "description": "The start date of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the fiscal year.", "default": null, "optional": true, "choices": null } ], "sec": [ { "name": "cik", "type": "Union[str, int]", "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false, "choices": null }, { "name": "location", "type": "str", "description": "Geographic location of the reporting entity.", "default": null, "optional": true, "choices": null }, { "name": "form", "type": "str", "description": "The SEC form associated with the fact or concept.", "default": null, "optional": true, "choices": null }, { "name": "frame", "type": "str", "description": "The frame ID associated with the fact or concept, if applicable.", "default": null, "optional": true, "choices": null }, { "name": "accession", "type": "str", "description": "SEC filing accession number associated with the reported fact or concept.", "default": "", "optional": false, "choices": null }, { "name": "fact", "type": "str", "description": "The display name of the fact or concept.", "default": "", "optional": false, "choices": null }, { "name": "unit", "type": "str", "description": "The unit of measurement for the fact or concept.", "default": null, "optional": true, "choices": null } ] }, "model": "CompareCompanyFacts", "openapi_extra": { "model": "CompareCompanyFacts" } }, "/equity/estimates/price_target": { "deprecated": { "flag": null, "message": null }, "description": "Get analyst price targets by company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.price_target(provider='benzinga')\n# Get price targets for Microsoft using 'benzinga' as provider.\nobb.equity.estimates.price_target(start_date=2020-01-01, end_date=2024-02-16, limit=10, symbol='msft', provider='benzinga', action=downgrades)\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga, fmp.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 200, "optional": true, "choices": null } ], "benzinga": [ { "name": "page", "type": "int", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", "default": 0, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "Date for calendar data, shorthand for date_from and date_to.", "default": null, "optional": true, "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": "updated", "type": "Union[date, int]", "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", "default": null, "optional": true, "choices": null }, { "name": "importance", "type": "int", "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", "default": null, "optional": true, "choices": null }, { "name": "action", "type": "Literal['downgrades', 'maintains', 'reinstates', 'reiterates', 'upgrades', 'assumes', 'initiates', 'terminates', 'removes', 'suspends', 'firm_dissolved']", "description": "Filter by a specific action_company.", "default": null, "optional": true, "choices": [ "downgrades", "maintains", "reinstates", "reiterates", "upgrades", "assumes", "initiates", "terminates", "removes", "suspends", "firm_dissolved" ] }, { "name": "analyst_ids", "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, "choices": null }, { "name": "firm_ids", "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, "choices": null }, { "name": "fields", "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, "choices": null } ], "fmp": [ { "name": "with_grade", "type": "bool", "description": "Include upgrades and downgrades in the response.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PriceTarget]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['benzinga', 'fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "published_date", "type": "Union[date, datetime]", "description": "Published date of the price target.", "default": "", "optional": false, "choices": null }, { "name": "published_time", "type": "datetime.time", "description": "Time of the original rating, UTC.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the company is traded.", "default": null, "optional": true, "choices": null }, { "name": "company_name", "type": "str", "description": "Name of company that is the subject of rating.", "default": null, "optional": true, "choices": null }, { "name": "analyst_name", "type": "str", "description": "Analyst name.", "default": null, "optional": true, "choices": null }, { "name": "analyst_firm", "type": "str", "description": "Name of the analyst firm that published the price target.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency the data is denominated in.", "default": null, "optional": true, "choices": null }, { "name": "price_target", "type": "float", "description": "The current price target.", "default": null, "optional": true, "choices": null }, { "name": "adj_price_target", "type": "float", "description": "Adjusted price target for splits and stock dividends.", "default": null, "optional": true, "choices": null }, { "name": "price_target_previous", "type": "float", "description": "Previous price target.", "default": null, "optional": true, "choices": null }, { "name": "previous_adj_price_target", "type": "float", "description": "Previous adjusted price target.", "default": null, "optional": true, "choices": null }, { "name": "price_when_posted", "type": "float", "description": "Price when posted.", "default": null, "optional": true, "choices": null }, { "name": "rating_current", "type": "str", "description": "The analyst's rating for the company.", "default": null, "optional": true, "choices": null }, { "name": "rating_previous", "type": "str", "description": "Previous analyst rating for the company.", "default": null, "optional": true, "choices": null }, { "name": "action", "type": "str", "description": "Description of the change in rating from firm's last rating.", "default": null, "optional": true, "choices": null } ], "benzinga": [ { "name": "action", "type": "Literal['Downgrades', 'Maintains', 'Reinstates', 'Reiterates', 'Upgrades', 'Assumes', 'Initiates Coverage On', 'Terminates Coverage On', 'Removes', 'Suspends', 'Firm Dissolved']", "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined.", "default": null, "optional": true, "choices": null }, { "name": "action_change", "type": "Literal['Announces', 'Maintains', 'Lowers', 'Raises', 'Removes', 'Adjusts']", "description": "Description of the change in price target from firm's last price target.", "default": null, "optional": true, "choices": null }, { "name": "importance", "type": "Literal[0, 1, 2, 3, 4, 5]", "description": "Subjective Basis of How Important Event is to Market. 5 = High", "default": null, "optional": true, "choices": null }, { "name": "notes", "type": "str", "description": "Notes of the price target.", "default": null, "optional": true, "choices": null }, { "name": "analyst_id", "type": "str", "description": "Id of the analyst.", "default": null, "optional": true, "choices": null }, { "name": "url_news", "type": "str", "description": "URL for analyst ratings news articles for this ticker on Benzinga.com.", "default": null, "optional": true, "choices": null }, { "name": "url_analyst", "type": "str", "description": "URL for analyst ratings page for this ticker on Benzinga.com.", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "Unique ID of this entry.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "Last updated timestamp, UTC.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "news_url", "type": "str", "description": "News URL of the price target.", "default": null, "optional": true, "choices": null }, { "name": "news_title", "type": "str", "description": "News title of the price target.", "default": null, "optional": true, "choices": null }, { "name": "news_publisher", "type": "str", "description": "News publisher of the price target.", "default": null, "optional": true, "choices": null }, { "name": "news_base_url", "type": "str", "description": "News base URL of the price target.", "default": null, "optional": true, "choices": null } ] }, "model": "PriceTarget", "openapi_extra": { "model": "PriceTarget" } }, "/equity/estimates/historical": { "deprecated": { "flag": null, "message": null }, "description": "Get historical analyst estimates for earnings and revenue.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.historical(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[AnalystEstimates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "estimated_revenue_low", "type": "int", "description": "Estimated revenue low.", "default": null, "optional": true, "choices": null }, { "name": "estimated_revenue_high", "type": "int", "description": "Estimated revenue high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_revenue_avg", "type": "int", "description": "Estimated revenue average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_sga_expense_low", "type": "int", "description": "Estimated SGA expense low.", "default": null, "optional": true, "choices": null }, { "name": "estimated_sga_expense_high", "type": "int", "description": "Estimated SGA expense high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_sga_expense_avg", "type": "int", "description": "Estimated SGA expense average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebitda_low", "type": "int", "description": "Estimated EBITDA low.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebitda_high", "type": "int", "description": "Estimated EBITDA high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebitda_avg", "type": "int", "description": "Estimated EBITDA average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebit_low", "type": "int", "description": "Estimated EBIT low.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebit_high", "type": "int", "description": "Estimated EBIT high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_ebit_avg", "type": "int", "description": "Estimated EBIT average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_net_income_low", "type": "int", "description": "Estimated net income low.", "default": null, "optional": true, "choices": null }, { "name": "estimated_net_income_high", "type": "int", "description": "Estimated net income high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_net_income_avg", "type": "int", "description": "Estimated net income average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_eps_avg", "type": "float", "description": "Estimated EPS average.", "default": null, "optional": true, "choices": null }, { "name": "estimated_eps_high", "type": "float", "description": "Estimated EPS high.", "default": null, "optional": true, "choices": null }, { "name": "estimated_eps_low", "type": "float", "description": "Estimated EPS low.", "default": null, "optional": true, "choices": null }, { "name": "number_analyst_estimated_revenue", "type": "int", "description": "Number of analysts who estimated revenue.", "default": null, "optional": true, "choices": null }, { "name": "number_analysts_estimated_eps", "type": "int", "description": "Number of analysts who estimated EPS.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "model": "AnalystEstimates", "openapi_extra": { "model": "AnalystEstimates" } }, "/equity/estimates/consensus": { "deprecated": { "flag": null, "message": null }, "description": "Get consensus price target and recommendation.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.consensus(symbol='AAPL', provider='fmp')\nobb.equity.estimates.consensus(symbol='AAPL,MSFT', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "industry_group_number", "type": "int", "description": "The Zacks industry group number.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PriceTargetConsensus]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "The company name", "default": null, "optional": true, "choices": null }, { "name": "target_high", "type": "float", "description": "High target of the price target consensus.", "default": null, "optional": true, "choices": null }, { "name": "target_low", "type": "float", "description": "Low target of the price target consensus.", "default": null, "optional": true, "choices": null }, { "name": "target_consensus", "type": "float", "description": "Consensus target of the price target consensus.", "default": null, "optional": true, "choices": null }, { "name": "target_median", "type": "float", "description": "Median target of the price target consensus.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "standard_deviation", "type": "float", "description": "The standard deviation of target price estimates.", "default": null, "optional": true, "choices": null }, { "name": "total_anaylsts", "type": "int", "description": "The total number of target price estimates in consensus.", "default": null, "optional": true, "choices": null }, { "name": "raised", "type": "int", "description": "The number of analysts that have raised their target price estimates.", "default": null, "optional": true, "choices": null }, { "name": "lowered", "type": "int", "description": "The number of analysts that have lowered their target price estimates.", "default": null, "optional": true, "choices": null }, { "name": "most_recent_date", "type": "date", "description": "The date of the most recent estimate.", "default": null, "optional": true, "choices": null }, { "name": "industry_group_number", "type": "int", "description": "The Zacks industry group number.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "recommendation", "type": "str", "description": "Recommendation - buy, sell, etc.", "default": null, "optional": true, "choices": null }, { "name": "recommendation_mean", "type": "float", "description": "Mean recommendation score where 1 is strong buy and 5 is strong sell.", "default": null, "optional": true, "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing opinions.", "default": null, "optional": true, "choices": null }, { "name": "current_price", "type": "float", "description": "Current price of the stock.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency the stock is priced in.", "default": null, "optional": true, "choices": null } ] }, "model": "PriceTargetConsensus", "openapi_extra": { "model": "PriceTargetConsensus" } }, "/equity/estimates/analyst_search": { "deprecated": { "flag": null, "message": null }, "description": "Search for specific analysts and get their forecast track record.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.analyst_search(provider='benzinga')\nobb.equity.estimates.analyst_search(firm_name='Wedbush', provider='benzinga')\n```\n\n", "parameters": { "standard": [ { "name": "analyst_name", "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, "choices": null }, { "name": "firm_name", "type": "Union[str, list[str]]", "description": "Firm names to return. Omitting will return all available firms. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, "choices": null } ], "benzinga": [ { "name": "analyst_ids", "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]]", "description": "Firm IDs to return. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "Number of results returned. Limit 1000.", "default": 100, "optional": true, "choices": null }, { "name": "page", "type": "int", "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.", "default": 0, "optional": true, "choices": null }, { "name": "fields", "type": "Union[str, list[str]]", "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple items allowed for provider(s): benzinga.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[AnalystSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['benzinga']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "last_updated", "type": "datetime", "description": "Date of the last update.", "default": null, "optional": true, "choices": null }, { "name": "firm_name", "type": "str", "description": "Firm name of the analyst.", "default": null, "optional": true, "choices": null }, { "name": "name_first", "type": "str", "description": "Analyst first name.", "default": null, "optional": true, "choices": null }, { "name": "name_last", "type": "str", "description": "Analyst last name.", "default": null, "optional": true, "choices": null }, { "name": "name_full", "type": "str", "description": "Analyst full name.", "default": "", "optional": false, "choices": null } ], "benzinga": [ { "name": "analyst_id", "type": "str", "description": "ID of the analyst.", "default": null, "optional": true, "choices": null }, { "name": "firm_id", "type": "str", "description": "ID of the analyst firm.", "default": null, "optional": true, "choices": null }, { "name": "smart_score", "type": "float", "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate", "default": null, "optional": true, "choices": null }, { "name": "overall_success_rate", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", "default": null, "optional": true, "choices": null }, { "name": "overall_avg_return_percentile", "type": "float", "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", "default": null, "optional": true, "choices": null }, { "name": "total_ratings_percentile", "type": "float", "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", "default": null, "optional": true, "choices": null }, { "name": "total_ratings", "type": "int", "description": "Number of recommendations made by this analyst.", "default": null, "optional": true, "choices": null }, { "name": "overall_gain_count", "type": "int", "description": "The number of ratings that have gained value since the date of recommendation", "default": null, "optional": true, "choices": null }, { "name": "overall_loss_count", "type": "int", "description": "The number of ratings that have lost value since the date of recommendation", "default": null, "optional": true, "choices": null }, { "name": "overall_average_return", "type": "float", "description": "The average percent (normalized) price difference per rating since the date of recommendation", "default": null, "optional": true, "choices": null }, { "name": "overall_std_dev", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", "default": null, "optional": true, "choices": null }, { "name": "gain_count_1m", "type": "int", "description": "The number of ratings that have gained value over the last month", "default": null, "optional": true, "choices": null }, { "name": "loss_count_1m", "type": "int", "description": "The number of ratings that have lost value over the last month", "default": null, "optional": true, "choices": null }, { "name": "average_return_1m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last month", "default": null, "optional": true, "choices": null }, { "name": "std_dev_1m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", "default": null, "optional": true, "choices": null }, { "name": "smart_score_1m", "type": "float", "description": "A weighted average smart score over the last month.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_1m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", "default": null, "optional": true, "choices": null }, { "name": "gain_count_3m", "type": "int", "description": "The number of ratings that have gained value over the last 3 months", "default": null, "optional": true, "choices": null }, { "name": "loss_count_3m", "type": "int", "description": "The number of ratings that have lost value over the last 3 months", "default": null, "optional": true, "choices": null }, { "name": "average_return_3m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 3 months", "default": null, "optional": true, "choices": null }, { "name": "std_dev_3m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", "default": null, "optional": true, "choices": null }, { "name": "smart_score_3m", "type": "float", "description": "A weighted average smart score over the last 3 months.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_3m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", "default": null, "optional": true, "choices": null }, { "name": "gain_count_6m", "type": "int", "description": "The number of ratings that have gained value over the last 6 months", "default": null, "optional": true, "choices": null }, { "name": "loss_count_6m", "type": "int", "description": "The number of ratings that have lost value over the last 6 months", "default": null, "optional": true, "choices": null }, { "name": "average_return_6m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 6 months", "default": null, "optional": true, "choices": null }, { "name": "std_dev_6m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", "default": null, "optional": true, "choices": null }, { "name": "gain_count_9m", "type": "int", "description": "The number of ratings that have gained value over the last 9 months", "default": null, "optional": true, "choices": null }, { "name": "loss_count_9m", "type": "int", "description": "The number of ratings that have lost value over the last 9 months", "default": null, "optional": true, "choices": null }, { "name": "average_return_9m", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 9 months", "default": null, "optional": true, "choices": null }, { "name": "std_dev_9m", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", "default": null, "optional": true, "choices": null }, { "name": "smart_score_9m", "type": "float", "description": "A weighted average smart score over the last 9 months.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_9m", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", "default": null, "optional": true, "choices": null }, { "name": "gain_count_1y", "type": "int", "description": "The number of ratings that have gained value over the last 1 year", "default": null, "optional": true, "choices": null }, { "name": "loss_count_1y", "type": "int", "description": "The number of ratings that have lost value over the last 1 year", "default": null, "optional": true, "choices": null }, { "name": "average_return_1y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 1 year", "default": null, "optional": true, "choices": null }, { "name": "std_dev_1y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", "default": null, "optional": true, "choices": null }, { "name": "smart_score_1y", "type": "float", "description": "A weighted average smart score over the last 1 year.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_1y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", "default": null, "optional": true, "choices": null }, { "name": "gain_count_2y", "type": "int", "description": "The number of ratings that have gained value over the last 2 years", "default": null, "optional": true, "choices": null }, { "name": "loss_count_2y", "type": "int", "description": "The number of ratings that have lost value over the last 2 years", "default": null, "optional": true, "choices": null }, { "name": "average_return_2y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 2 years", "default": null, "optional": true, "choices": null }, { "name": "std_dev_2y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", "default": null, "optional": true, "choices": null }, { "name": "smart_score_2y", "type": "float", "description": "A weighted average smart score over the last 3 years.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_2y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", "default": null, "optional": true, "choices": null }, { "name": "gain_count_3y", "type": "int", "description": "The number of ratings that have gained value over the last 3 years", "default": null, "optional": true, "choices": null }, { "name": "loss_count_3y", "type": "int", "description": "The number of ratings that have lost value over the last 3 years", "default": null, "optional": true, "choices": null }, { "name": "average_return_3y", "type": "float", "description": "The average percent (normalized) price difference per rating over the last 3 years", "default": null, "optional": true, "choices": null }, { "name": "std_dev_3y", "type": "float", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", "default": null, "optional": true, "choices": null }, { "name": "smart_score_3y", "type": "float", "description": "A weighted average smart score over the last 3 years.", "default": null, "optional": true, "choices": null }, { "name": "success_rate_3y", "type": "float", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", "default": null, "optional": true, "choices": null } ] }, "model": "AnalystSearch", "openapi_extra": { "model": "AnalystSearch" } }, "/equity/estimates/forward_sales": { "deprecated": { "flag": null, "message": null }, "description": "Get forward sales estimates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_sales(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_sales(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "fiscal_year", "type": "int", "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true, "choices": null }, { "name": "calendar_year", "type": "int", "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "Literal['q1', 'q2', 'q3', 'q4']", "description": "The future calendar period to retrieve estimates for.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ForwardSalesEstimates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Fiscal quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "str", "description": "Calendar quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "low_estimate", "type": "int", "description": "The sales estimate low for the period.", "default": null, "optional": true, "choices": null }, { "name": "high_estimate", "type": "int", "description": "The sales estimate high for the period.", "default": null, "optional": true, "choices": null }, { "name": "mean", "type": "int", "description": "The sales estimate mean for the period.", "default": null, "optional": true, "choices": null }, { "name": "median", "type": "int", "description": "The sales estimate median for the period.", "default": null, "optional": true, "choices": null }, { "name": "standard_deviation", "type": "int", "description": "The sales estimate standard deviation for the period.", "default": null, "optional": true, "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "revisions_1w_up", "type": "int", "description": "Number of revisions up in the last week.", "default": null, "optional": true, "choices": null }, { "name": "revisions_1w_down", "type": "int", "description": "Number of revisions down in the last week.", "default": null, "optional": true, "choices": null }, { "name": "revisions_1w_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 1 week.", "default": null, "optional": true, "choices": null }, { "name": "revisions_1m_up", "type": "int", "description": "Number of revisions up in the last month.", "default": null, "optional": true, "choices": null }, { "name": "revisions_1m_down", "type": "int", "description": "Number of revisions down in the last month.", "default": null, "optional": true, "choices": null }, { "name": "revisions_1m_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 1 month.", "default": null, "optional": true, "choices": null }, { "name": "revisions_3m_up", "type": "int", "description": "Number of revisions up in the last 3 months.", "default": null, "optional": true, "choices": null }, { "name": "revisions_3m_down", "type": "int", "description": "Number of revisions down in the last 3 months.", "default": null, "optional": true, "choices": null }, { "name": "revisions_3m_change_percent", "type": "float", "description": "The analyst revisions percent change in estimate for the period of 3 months.", "default": null, "optional": true, "choices": null } ] }, "model": "ForwardSalesEstimates", "openapi_extra": { "model": "ForwardSalesEstimates" } }, "/equity/estimates/forward_ebitda": { "deprecated": { "flag": null, "message": null }, "description": "Get forward EBITDA estimates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_ebitda(provider='intrinio')\nobb.equity.estimates.forward_ebitda(symbol='AAPL', fiscal_period=annual, provider='intrinio')\nobb.equity.estimates.forward_ebitda(symbol='AAPL,MSFT', fiscal_period=quarter, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "fiscal_period", "type": "Literal['annual', 'quarter']", "description": "The future fiscal period to retrieve estimates for.", "default": "annual", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, "optional": true, "choices": null }, { "name": "include_historical", "type": "bool", "description": "If True, the data will include all past data and the limit will be ignored.", "default": false, "optional": true, "choices": null } ], "intrinio": [ { "name": "fiscal_period", "type": "Literal['quarter', 'annual']", "description": "Filter for only full-year or quarterly estimates.", "default": null, "optional": true, "choices": null }, { "name": "estimate_type", "type": "Literal['ebitda', 'ebit', 'enterprise_value', 'cash_flow_per_share', 'pretax_income']", "description": "Limit the EBITDA estimates to this type.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ForwardEbitdaEstimates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "date", "description": "The date of the last update.", "default": null, "optional": true, "choices": null }, { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Fiscal quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "Union[int, str]", "description": "Calendar quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "low_estimate", "type": "int", "description": "The EBITDA estimate low for the period.", "default": null, "optional": true, "choices": null }, { "name": "high_estimate", "type": "int", "description": "The EBITDA estimate high for the period.", "default": null, "optional": true, "choices": null }, { "name": "mean", "type": "int", "description": "The EBITDA estimate mean for the period.", "default": null, "optional": true, "choices": null }, { "name": "median", "type": "int", "description": "The EBITDA estimate median for the period.", "default": null, "optional": true, "choices": null }, { "name": "standard_deviation", "type": "int", "description": "The EBITDA estimate standard deviation for the period.", "default": null, "optional": true, "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "conensus_type", "type": "Literal['ebitda', 'ebit', 'enterprise_value', 'cash_flow_per_share', 'pretax_income']", "description": "The type of estimate.", "default": null, "optional": true, "choices": null } ] }, "model": "ForwardEbitdaEstimates", "openapi_extra": { "model": "ForwardEbitdaEstimates" } }, "/equity/estimates/forward_eps": { "deprecated": { "flag": null, "message": null }, "description": "Get forward EPS estimates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_eps(symbol='AAPL', provider='intrinio')\nobb.equity.estimates.forward_eps(fiscal_year=2025, fiscal_period=fy, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "fiscal_period", "type": "Literal['annual', 'quarter']", "description": "The future fiscal period to retrieve estimates for.", "default": "annual", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, "optional": true, "choices": null }, { "name": "include_historical", "type": "bool", "description": "If True, the data will include all past data and the limit will be ignored.", "default": false, "optional": true, "choices": null } ], "intrinio": [ { "name": "fiscal_year", "type": "int", "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "Literal['fy', 'q1', 'q2', 'q3', 'q4']", "description": "The future fiscal period to retrieve estimates for.", "default": null, "optional": true, "choices": null }, { "name": "calendar_year", "type": "int", "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "Literal['q1', 'q2', 'q3', 'q4']", "description": "The future calendar period to retrieve estimates for.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ForwardEpsEstimates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Fiscal quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "str", "description": "Calendar quarter for the estimate.", "default": null, "optional": true, "choices": null }, { "name": "low_estimate", "type": "float", "description": "Estimated EPS low for the period.", "default": null, "optional": true, "choices": null }, { "name": "high_estimate", "type": "float", "description": "Estimated EPS high for the period.", "default": null, "optional": true, "choices": null }, { "name": "mean", "type": "float", "description": "Estimated EPS mean for the period.", "default": null, "optional": true, "choices": null }, { "name": "median", "type": "float", "description": "Estimated EPS median for the period.", "default": null, "optional": true, "choices": null }, { "name": "standard_deviation", "type": "float", "description": "Estimated EPS standard deviation for the period.", "default": null, "optional": true, "choices": null }, { "name": "number_of_analysts", "type": "int", "description": "Number of analysts providing estimates for the period.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "revisions_change_percent", "type": "float", "description": "The earnings per share (EPS) percent change in estimate for the period.", "default": null, "optional": true, "choices": null }, { "name": "mean_1w", "type": "float", "description": "The mean estimate for the period one week ago.", "default": null, "optional": true, "choices": null }, { "name": "mean_1m", "type": "float", "description": "The mean estimate for the period one month ago.", "default": null, "optional": true, "choices": null }, { "name": "mean_2m", "type": "float", "description": "The mean estimate for the period two months ago.", "default": null, "optional": true, "choices": null }, { "name": "mean_3m", "type": "float", "description": "The mean estimate for the period three months ago.", "default": null, "optional": true, "choices": null } ] }, "model": "ForwardEpsEstimates", "openapi_extra": { "model": "ForwardEpsEstimates" } }, "/equity/estimates/forward_pe": { "deprecated": { "flag": null, "message": null }, "description": "Get forward PE estimates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.estimates.forward_pe(provider='intrinio')\nobb.equity.estimates.forward_pe(symbol='AAPL,MSFT,GOOG', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ForwardPeEstimates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "year1", "type": "float", "description": "Estimated PE ratio for the next fiscal year.", "default": null, "optional": true, "choices": null }, { "name": "year2", "type": "float", "description": "Estimated PE ratio two fiscal years from now.", "default": null, "optional": true, "choices": null }, { "name": "year3", "type": "float", "description": "Estimated PE ratio three fiscal years from now.", "default": null, "optional": true, "choices": null }, { "name": "year4", "type": "float", "description": "Estimated PE ratio four fiscal years from now.", "default": null, "optional": true, "choices": null }, { "name": "year5", "type": "float", "description": "Estimated PE ratio five fiscal years from now.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "peg_ratio_year1", "type": "float", "description": "Estimated Forward PEG ratio for the next fiscal year.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "The latest trailing twelve months earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "date", "description": "The date the data was last updated.", "default": null, "optional": true, "choices": null } ] }, "model": "ForwardPeEstimates", "openapi_extra": { "model": "ForwardPeEstimates" } }, "/equity/discovery/gainers": { "deprecated": { "flag": null, "message": null }, "description": "Get the top price gainers in the stock market.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.gainers(provider='yfinance')\nobb.equity.discovery.gainers(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityGainers]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityGainers", "openapi_extra": { "model": "EquityGainers" } }, "/equity/discovery/losers": { "deprecated": { "flag": null, "message": null }, "description": "Get the top price losers in the stock market.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.losers(provider='yfinance')\nobb.equity.discovery.losers(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityLosers]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityLosers", "openapi_extra": { "model": "EquityLosers" } }, "/equity/discovery/active": { "deprecated": { "flag": null, "message": null }, "description": "Get the most actively traded stocks based on volume.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.active(provider='yfinance')\nobb.equity.discovery.active(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityActive]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityActive", "openapi_extra": { "model": "EquityActive" } }, "/equity/discovery/undervalued_large_caps": { "deprecated": { "flag": null, "message": null }, "description": "Get potentially undervalued large cap stocks.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_large_caps(provider='yfinance')\nobb.equity.discovery.undervalued_large_caps(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityUndervaluedLargeCaps]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityUndervaluedLargeCaps", "openapi_extra": { "model": "EquityUndervaluedLargeCaps" } }, "/equity/discovery/undervalued_growth": { "deprecated": { "flag": null, "message": null }, "description": "Get potentially undervalued growth stocks.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.undervalued_growth(provider='yfinance')\nobb.equity.discovery.undervalued_growth(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityUndervaluedGrowth]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityUndervaluedGrowth", "openapi_extra": { "model": "EquityUndervaluedGrowth" } }, "/equity/discovery/aggressive_small_caps": { "deprecated": { "flag": null, "message": null }, "description": "Get top small cap stocks based on earnings growth.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.aggressive_small_caps(provider='yfinance')\nobb.equity.discovery.aggressive_small_caps(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results. Default is all.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityAggressiveSmallCaps]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityAggressiveSmallCaps", "openapi_extra": { "model": "EquityAggressiveSmallCaps" } }, "/equity/discovery/growth_tech": { "deprecated": { "flag": null, "message": null }, "description": "Get top tech stocks based on revenue and earnings growth.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.growth_tech(provider='yfinance')\nobb.equity.discovery.growth_tech(sort='desc', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.", "default": "desc", "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "Limit the number of results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[GrowthTechEquities]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "Last price.", "default": "", "optional": false, "choices": null }, { "name": "change", "type": "float", "description": "Change in price.", "default": "", "optional": false, "choices": null }, { "name": "percent_change", "type": "float", "description": "Percent change.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "GrowthTechEquities", "openapi_extra": { "model": "GrowthTechEquities" } }, "/equity/discovery/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.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.filings(provider='fmp')\n# Get filings for the year 2023, limited to 100 results\nobb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31', limit=100, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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": "str", "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, "optional": true, "choices": null } ], "fmp": [ { "name": "is_done", "type": "bool", "description": "Flag for whether or not the filing is done.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[DiscoveryFilings]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the filing.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "form_type", "type": "str", "description": "The form type of the filing", "default": "", "optional": false, "choices": null }, { "name": "link", "type": "str", "description": "URL to the filing page on the SEC site.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "DiscoveryFilings", "openapi_extra": { "model": "DiscoveryFilings" } }, "/equity/discovery/latest_financial_reports": { "deprecated": { "flag": null, "message": null }, "description": "Get the newest quarterly, annual, and current reports for all companies.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.discovery.latest_financial_reports(provider='sec')\nobb.equity.discovery.latest_financial_reports(provider='sec', date=2024-09-30)\n```\n\n", "parameters": { "standard": [], "sec": [ { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for. Defaults to today.", "default": null, "optional": true, "choices": null }, { "name": "report_type", "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, "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" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[LatestFinancialReports]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "filing_date", "type": "date", "description": "The date of the filing.", "default": "", "optional": false, "choices": null }, { "name": "period_ending", "type": "date", "description": "Report for the period ending.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the company.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "sic", "type": "str", "description": "Standard Industrial Classification code.", "default": null, "optional": true, "choices": null }, { "name": "report_type", "type": "str", "description": "Type of filing.", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "Description of the report.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "URL to the filing page.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "items", "type": "str", "description": "Item codes associated with the filing.", "default": null, "optional": true, "choices": null }, { "name": "index_headers", "type": "str", "description": "URL to the index headers file.", "default": "", "optional": false, "choices": null }, { "name": "complete_submission", "type": "str", "description": "URL to the complete submission text file.", "default": "", "optional": false, "choices": null }, { "name": "metadata", "type": "str", "description": "URL to the MetaLinks.json file, if available.", "default": null, "optional": true, "choices": null }, { "name": "financial_report", "type": "str", "description": "URL to the Financial_Report.xlsx file, if available.", "default": null, "optional": true, "choices": null } ] }, "model": "LatestFinancialReports", "openapi_extra": { "model": "LatestFinancialReports" } }, "/equity/fundamental/multiples": { "deprecated": { "flag": null, "message": null }, "description": "Get equity valuation multiples for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.multiples(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityValuationMultiples]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "revenue_per_share_ttm", "type": "float", "description": "Revenue per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "net_income_per_share_ttm", "type": "float", "description": "Net income per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "operating_cash_flow_per_share_ttm", "type": "float", "description": "Operating cash flow per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_per_share_ttm", "type": "float", "description": "Free cash flow per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "cash_per_share_ttm", "type": "float", "description": "Cash per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "book_value_per_share_ttm", "type": "float", "description": "Book value per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "tangible_book_value_per_share_ttm", "type": "float", "description": "Tangible book value per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "shareholders_equity_per_share_ttm", "type": "float", "description": "Shareholders equity per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "interest_debt_per_share_ttm", "type": "float", "description": "Interest debt per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "market_cap_ttm", "type": "float", "description": "Market capitalization calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value_ttm", "type": "float", "description": "Enterprise value calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "pe_ratio_ttm", "type": "float", "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "price_to_sales_ratio_ttm", "type": "float", "description": "Price-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "pocf_ratio_ttm", "type": "float", "description": "Price-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "pfcf_ratio_ttm", "type": "float", "description": "Price-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "pb_ratio_ttm", "type": "float", "description": "Price-to-book ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "ptb_ratio_ttm", "type": "float", "description": "Price-to-tangible book ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "ev_to_sales_ttm", "type": "float", "description": "Enterprise value-to-sales ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value_over_ebitda_ttm", "type": "float", "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "ev_to_operating_cash_flow_ttm", "type": "float", "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "ev_to_free_cash_flow_ttm", "type": "float", "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "earnings_yield_ttm", "type": "float", "description": "Earnings yield calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_yield_ttm", "type": "float", "description": "Free cash flow yield calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "debt_to_equity_ttm", "type": "float", "description": "Debt-to-equity ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "debt_to_assets_ttm", "type": "float", "description": "Debt-to-assets ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "net_debt_to_ebitda_ttm", "type": "float", "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "current_ratio_ttm", "type": "float", "description": "Current ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "interest_coverage_ttm", "type": "float", "description": "Interest coverage calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "income_quality_ttm", "type": "float", "description": "Income quality calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield_ttm", "type": "float", "description": "Dividend yield calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield_percentage_ttm", "type": "float", "description": "Dividend yield percentage calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "dividend_to_market_cap_ttm", "type": "float", "description": "Dividend to market capitalization ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "dividend_per_share_ttm", "type": "float", "description": "Dividend per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "payout_ratio_ttm", "type": "float", "description": "Payout ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "sales_general_and_administrative_to_revenue_ttm", "type": "float", "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "research_and_development_to_revenue_ttm", "type": "float", "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "intangibles_to_total_assets_ttm", "type": "float", "description": "Intangibles-to-total assets ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "capex_to_operating_cash_flow_ttm", "type": "float", "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "capex_to_revenue_ttm", "type": "float", "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "capex_to_depreciation_ttm", "type": "float", "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "stock_based_compensation_to_revenue_ttm", "type": "float", "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "graham_number_ttm", "type": "float", "description": "Graham number calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "roic_ttm", "type": "float", "description": "Return on invested capital calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "return_on_tangible_assets_ttm", "type": "float", "description": "Return on tangible assets calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "graham_net_net_ttm", "type": "float", "description": "Graham net-net working capital calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "working_capital_ttm", "type": "float", "description": "Working capital calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "tangible_asset_value_ttm", "type": "float", "description": "Tangible asset value calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "net_current_asset_value_ttm", "type": "float", "description": "Net current asset value calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "invested_capital_ttm", "type": "float", "description": "Invested capital calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "average_receivables_ttm", "type": "float", "description": "Average receivables calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "average_payables_ttm", "type": "float", "description": "Average payables calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "average_inventory_ttm", "type": "float", "description": "Average inventory calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "days_sales_outstanding_ttm", "type": "float", "description": "Days sales outstanding calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "days_payables_outstanding_ttm", "type": "float", "description": "Days payables outstanding calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "days_of_inventory_on_hand_ttm", "type": "float", "description": "Days of inventory on hand calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "receivables_turnover_ttm", "type": "float", "description": "Receivables turnover calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "payables_turnover_ttm", "type": "float", "description": "Payables turnover calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "inventory_turnover_ttm", "type": "float", "description": "Inventory turnover calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "roe_ttm", "type": "float", "description": "Return on equity calculated as trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "capex_per_share_ttm", "type": "float", "description": "Capital expenditures per share calculated as trailing twelve months.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "model": "EquityValuationMultiples", "openapi_extra": { "model": "EquityValuationMultiples" } }, "/equity/fundamental/balance": { "deprecated": { "flag": null, "message": null }, "description": "Get the balance sheet for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance(symbol='AAPL', period=annual, limit=5, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ], "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": true, "optional": true, "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null }, { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BalanceSheet]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "filing_date", "type": "date", "description": "The date when the filing was made.", "default": null, "optional": true, "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date and time when the filing was accepted.", "default": null, "optional": true, "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true, "choices": null }, { "name": "cash_and_cash_equivalents", "type": "float", "description": "Cash and cash equivalents.", "default": null, "optional": true, "choices": null }, { "name": "short_term_investments", "type": "float", "description": "Short term investments.", "default": null, "optional": true, "choices": null }, { "name": "cash_and_short_term_investments", "type": "float", "description": "Cash and short term investments.", "default": null, "optional": true, "choices": null }, { "name": "net_receivables", "type": "float", "description": "Net receivables.", "default": null, "optional": true, "choices": null }, { "name": "inventory", "type": "float", "description": "Inventory.", "default": null, "optional": true, "choices": null }, { "name": "other_current_assets", "type": "float", "description": "Other current assets.", "default": null, "optional": true, "choices": null }, { "name": "total_current_assets", "type": "float", "description": "Total current assets.", "default": null, "optional": true, "choices": null }, { "name": "plant_property_equipment_net", "type": "float", "description": "Plant property equipment net.", "default": null, "optional": true, "choices": null }, { "name": "goodwill", "type": "float", "description": "Goodwill.", "default": null, "optional": true, "choices": null }, { "name": "intangible_assets", "type": "float", "description": "Intangible assets.", "default": null, "optional": true, "choices": null }, { "name": "goodwill_and_intangible_assets", "type": "float", "description": "Goodwill and intangible assets.", "default": null, "optional": true, "choices": null }, { "name": "long_term_investments", "type": "float", "description": "Long term investments.", "default": null, "optional": true, "choices": null }, { "name": "tax_assets", "type": "float", "description": "Tax assets.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_assets", "type": "float", "description": "Other non current assets.", "default": null, "optional": true, "choices": null }, { "name": "non_current_assets", "type": "float", "description": "Total non current assets.", "default": null, "optional": true, "choices": null }, { "name": "other_assets", "type": "float", "description": "Other assets.", "default": null, "optional": true, "choices": null }, { "name": "total_assets", "type": "float", "description": "Total assets.", "default": null, "optional": true, "choices": null }, { "name": "accounts_payable", "type": "float", "description": "Accounts payable.", "default": null, "optional": true, "choices": null }, { "name": "short_term_debt", "type": "float", "description": "Short term debt.", "default": null, "optional": true, "choices": null }, { "name": "tax_payables", "type": "float", "description": "Tax payables.", "default": null, "optional": true, "choices": null }, { "name": "current_deferred_revenue", "type": "float", "description": "Current deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "other_current_liabilities", "type": "float", "description": "Other current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "total_current_liabilities", "type": "float", "description": "Total current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt", "type": "float", "description": "Long term debt.", "default": null, "optional": true, "choices": null }, { "name": "deferred_revenue_non_current", "type": "float", "description": "Non current deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "deferred_tax_liabilities_non_current", "type": "float", "description": "Deferred tax liabilities non current.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_liabilities", "type": "float", "description": "Other non current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "total_non_current_liabilities", "type": "float", "description": "Total non current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "other_liabilities", "type": "float", "description": "Other liabilities.", "default": null, "optional": true, "choices": null }, { "name": "capital_lease_obligations", "type": "float", "description": "Capital lease obligations.", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities", "type": "float", "description": "Total liabilities.", "default": null, "optional": true, "choices": null }, { "name": "preferred_stock", "type": "float", "description": "Preferred stock.", "default": null, "optional": true, "choices": null }, { "name": "common_stock", "type": "float", "description": "Common stock.", "default": null, "optional": true, "choices": null }, { "name": "retained_earnings", "type": "float", "description": "Retained earnings.", "default": null, "optional": true, "choices": null }, { "name": "accumulated_other_comprehensive_income", "type": "float", "description": "Accumulated other comprehensive income (loss).", "default": null, "optional": true, "choices": null }, { "name": "other_shareholders_equity", "type": "float", "description": "Other shareholders equity.", "default": null, "optional": true, "choices": null }, { "name": "other_total_shareholders_equity", "type": "float", "description": "Other total shareholders equity.", "default": null, "optional": true, "choices": null }, { "name": "total_common_equity", "type": "float", "description": "Total common equity.", "default": null, "optional": true, "choices": null }, { "name": "total_equity_non_controlling_interests", "type": "float", "description": "Total equity non controlling interests.", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities_and_shareholders_equity", "type": "float", "description": "Total liabilities and shareholders equity.", "default": null, "optional": true, "choices": null }, { "name": "minority_interest", "type": "float", "description": "Minority interest.", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities_and_total_equity", "type": "float", "description": "Total liabilities and total equity.", "default": null, "optional": true, "choices": null }, { "name": "total_investments", "type": "float", "description": "Total investments.", "default": null, "optional": true, "choices": null }, { "name": "total_debt", "type": "float", "description": "Total debt.", "default": null, "optional": true, "choices": null }, { "name": "net_debt", "type": "float", "description": "Net debt.", "default": null, "optional": true, "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, "optional": true, "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true, "choices": null }, { "name": "cash_and_cash_equivalents", "type": "float", "description": "Cash and cash equivalents.", "default": null, "optional": true, "choices": null }, { "name": "cash_and_due_from_banks", "type": "float", "description": "Cash and due from banks.", "default": null, "optional": true, "choices": null }, { "name": "restricted_cash", "type": "float", "description": "Restricted cash.", "default": null, "optional": true, "choices": null }, { "name": "short_term_investments", "type": "float", "description": "Short term investments.", "default": null, "optional": true, "choices": null }, { "name": "federal_funds_sold", "type": "float", "description": "Federal funds sold.", "default": null, "optional": true, "choices": null }, { "name": "accounts_receivable", "type": "float", "description": "Accounts receivable.", "default": null, "optional": true, "choices": null }, { "name": "note_and_lease_receivable", "type": "float", "description": "Note and lease receivable. (Vendor non-trade receivables)", "default": null, "optional": true, "choices": null }, { "name": "inventories", "type": "float", "description": "Net Inventories.", "default": null, "optional": true, "choices": null }, { "name": "customer_and_other_receivables", "type": "float", "description": "Customer and other receivables.", "default": null, "optional": true, "choices": null }, { "name": "interest_bearing_deposits_at_other_banks", "type": "float", "description": "Interest bearing deposits at other banks.", "default": null, "optional": true, "choices": null }, { "name": "time_deposits_placed_and_other_short_term_investments", "type": "float", "description": "Time deposits placed and other short term investments.", "default": null, "optional": true, "choices": null }, { "name": "trading_account_securities", "type": "float", "description": "Trading account securities.", "default": null, "optional": true, "choices": null }, { "name": "loans_and_leases", "type": "float", "description": "Loans and leases.", "default": null, "optional": true, "choices": null }, { "name": "allowance_for_loan_and_lease_losses", "type": "float", "description": "Allowance for loan and lease losses.", "default": null, "optional": true, "choices": null }, { "name": "current_deferred_refundable_income_taxes", "type": "float", "description": "Current deferred refundable income taxes.", "default": null, "optional": true, "choices": null }, { "name": "other_current_assets", "type": "float", "description": "Other current assets.", "default": null, "optional": true, "choices": null }, { "name": "loans_and_leases_net_of_allowance", "type": "float", "description": "Loans and leases net of allowance.", "default": null, "optional": true, "choices": null }, { "name": "accrued_investment_income", "type": "float", "description": "Accrued investment income.", "default": null, "optional": true, "choices": null }, { "name": "other_current_non_operating_assets", "type": "float", "description": "Other current non-operating assets.", "default": null, "optional": true, "choices": null }, { "name": "loans_held_for_sale", "type": "float", "description": "Loans held for sale.", "default": null, "optional": true, "choices": null }, { "name": "prepaid_expenses", "type": "float", "description": "Prepaid expenses.", "default": null, "optional": true, "choices": null }, { "name": "total_current_assets", "type": "float", "description": "Total current assets.", "default": null, "optional": true, "choices": null }, { "name": "plant_property_equipment_gross", "type": "float", "description": "Plant property equipment gross.", "default": null, "optional": true, "choices": null }, { "name": "accumulated_depreciation", "type": "float", "description": "Accumulated depreciation.", "default": null, "optional": true, "choices": null }, { "name": "premises_and_equipment_net", "type": "float", "description": "Net premises and equipment.", "default": null, "optional": true, "choices": null }, { "name": "plant_property_equipment_net", "type": "float", "description": "Net plant property equipment.", "default": null, "optional": true, "choices": null }, { "name": "long_term_investments", "type": "float", "description": "Long term investments.", "default": null, "optional": true, "choices": null }, { "name": "mortgage_servicing_rights", "type": "float", "description": "Mortgage servicing rights.", "default": null, "optional": true, "choices": null }, { "name": "unearned_premiums_asset", "type": "float", "description": "Unearned premiums asset.", "default": null, "optional": true, "choices": null }, { "name": "non_current_note_lease_receivables", "type": "float", "description": "Non-current note lease receivables.", "default": null, "optional": true, "choices": null }, { "name": "deferred_acquisition_cost", "type": "float", "description": "Deferred acquisition cost.", "default": null, "optional": true, "choices": null }, { "name": "goodwill", "type": "float", "description": "Goodwill.", "default": null, "optional": true, "choices": null }, { "name": "separate_account_business_assets", "type": "float", "description": "Separate account business assets.", "default": null, "optional": true, "choices": null }, { "name": "non_current_deferred_refundable_income_taxes", "type": "float", "description": "Noncurrent deferred refundable income taxes.", "default": null, "optional": true, "choices": null }, { "name": "intangible_assets", "type": "float", "description": "Intangible assets.", "default": null, "optional": true, "choices": null }, { "name": "employee_benefit_assets", "type": "float", "description": "Employee benefit assets.", "default": null, "optional": true, "choices": null }, { "name": "other_assets", "type": "float", "description": "Other assets.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_operating_assets", "type": "float", "description": "Other noncurrent operating assets.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_non_operating_assets", "type": "float", "description": "Other noncurrent non-operating assets.", "default": null, "optional": true, "choices": null }, { "name": "interest_bearing_deposits", "type": "float", "description": "Interest bearing deposits.", "default": null, "optional": true, "choices": null }, { "name": "total_non_current_assets", "type": "float", "description": "Total noncurrent assets.", "default": null, "optional": true, "choices": null }, { "name": "total_assets", "type": "float", "description": "Total assets.", "default": null, "optional": true, "choices": null }, { "name": "non_interest_bearing_deposits", "type": "float", "description": "Non interest bearing deposits.", "default": null, "optional": true, "choices": null }, { "name": "federal_funds_purchased_and_securities_sold", "type": "float", "description": "Federal funds purchased and securities sold.", "default": null, "optional": true, "choices": null }, { "name": "bankers_acceptance_outstanding", "type": "float", "description": "Bankers acceptance outstanding.", "default": null, "optional": true, "choices": null }, { "name": "short_term_debt", "type": "float", "description": "Short term debt.", "default": null, "optional": true, "choices": null }, { "name": "accounts_payable", "type": "float", "description": "Accounts payable.", "default": null, "optional": true, "choices": null }, { "name": "current_deferred_revenue", "type": "float", "description": "Current deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "current_deferred_payable_income_tax_liabilities", "type": "float", "description": "Current deferred payable income tax liabilities.", "default": null, "optional": true, "choices": null }, { "name": "accrued_interest_payable", "type": "float", "description": "Accrued interest payable.", "default": null, "optional": true, "choices": null }, { "name": "accrued_expenses", "type": "float", "description": "Accrued expenses.", "default": null, "optional": true, "choices": null }, { "name": "other_short_term_payables", "type": "float", "description": "Other short term payables.", "default": null, "optional": true, "choices": null }, { "name": "customer_deposits", "type": "float", "description": "Customer deposits.", "default": null, "optional": true, "choices": null }, { "name": "dividends_payable", "type": "float", "description": "Dividends payable.", "default": null, "optional": true, "choices": null }, { "name": "claims_and_claim_expense", "type": "float", "description": "Claims and claim expense.", "default": null, "optional": true, "choices": null }, { "name": "future_policy_benefits", "type": "float", "description": "Future policy benefits.", "default": null, "optional": true, "choices": null }, { "name": "current_employee_benefit_liabilities", "type": "float", "description": "Current employee benefit liabilities.", "default": null, "optional": true, "choices": null }, { "name": "unearned_premiums_liability", "type": "float", "description": "Unearned premiums liability.", "default": null, "optional": true, "choices": null }, { "name": "other_taxes_payable", "type": "float", "description": "Other taxes payable.", "default": null, "optional": true, "choices": null }, { "name": "policy_holder_funds", "type": "float", "description": "Policy holder funds.", "default": null, "optional": true, "choices": null }, { "name": "other_current_liabilities", "type": "float", "description": "Other current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "other_current_non_operating_liabilities", "type": "float", "description": "Other current non-operating liabilities.", "default": null, "optional": true, "choices": null }, { "name": "separate_account_business_liabilities", "type": "float", "description": "Separate account business liabilities.", "default": null, "optional": true, "choices": null }, { "name": "total_current_liabilities", "type": "float", "description": "Total current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt", "type": "float", "description": "Long term debt.", "default": null, "optional": true, "choices": null }, { "name": "other_long_term_liabilities", "type": "float", "description": "Other long term liabilities.", "default": null, "optional": true, "choices": null }, { "name": "non_current_deferred_revenue", "type": "float", "description": "Non-current deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "non_current_deferred_payable_income_tax_liabilities", "type": "float", "description": "Non-current deferred payable income tax liabilities.", "default": null, "optional": true, "choices": null }, { "name": "non_current_employee_benefit_liabilities", "type": "float", "description": "Non-current employee benefit liabilities.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_operating_liabilities", "type": "float", "description": "Other non-current operating liabilities.", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_non_operating_liabilities", "type": "float", "description": "Other non-current, non-operating liabilities.", "default": null, "optional": true, "choices": null }, { "name": "total_non_current_liabilities", "type": "float", "description": "Total non-current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "capital_lease_obligations", "type": "float", "description": "Capital lease obligations.", "default": null, "optional": true, "choices": null }, { "name": "asset_retirement_reserve_litigation_obligation", "type": "float", "description": "Asset retirement reserve litigation obligation.", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities", "type": "float", "description": "Total liabilities.", "default": null, "optional": true, "choices": null }, { "name": "commitments_contingencies", "type": "float", "description": "Commitments contingencies.", "default": null, "optional": true, "choices": null }, { "name": "redeemable_non_controlling_interest", "type": "float", "description": "Redeemable non-controlling interest.", "default": null, "optional": true, "choices": null }, { "name": "preferred_stock", "type": "float", "description": "Preferred stock.", "default": null, "optional": true, "choices": null }, { "name": "common_stock", "type": "float", "description": "Common stock.", "default": null, "optional": true, "choices": null }, { "name": "retained_earnings", "type": "float", "description": "Retained earnings.", "default": null, "optional": true, "choices": null }, { "name": "treasury_stock", "type": "float", "description": "Treasury stock.", "default": null, "optional": true, "choices": null }, { "name": "accumulated_other_comprehensive_income", "type": "float", "description": "Accumulated other comprehensive income.", "default": null, "optional": true, "choices": null }, { "name": "participating_policy_holder_equity", "type": "float", "description": "Participating policy holder equity.", "default": null, "optional": true, "choices": null }, { "name": "other_equity_adjustments", "type": "float", "description": "Other equity adjustments.", "default": null, "optional": true, "choices": null }, { "name": "total_common_equity", "type": "float", "description": "Total common equity.", "default": null, "optional": true, "choices": null }, { "name": "total_preferred_common_equity", "type": "float", "description": "Total preferred common equity.", "default": null, "optional": true, "choices": null }, { "name": "non_controlling_interest", "type": "float", "description": "Non-controlling interest.", "default": null, "optional": true, "choices": null }, { "name": "total_equity_non_controlling_interests", "type": "float", "description": "Total equity non-controlling interests.", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities_shareholders_equity", "type": "float", "description": "Total liabilities and shareholders equity.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "accounts_receivable", "type": "float", "description": "Accounts receivable", "default": null, "optional": true, "choices": null }, { "name": "marketable_securities", "type": "float", "description": "Marketable securities", "default": null, "optional": true, "choices": null }, { "name": "prepaid_expenses", "type": "float", "description": "Prepaid expenses", "default": null, "optional": true, "choices": null }, { "name": "other_current_assets", "type": "float", "description": "Other current assets", "default": null, "optional": true, "choices": null }, { "name": "total_current_assets", "type": "float", "description": "Total current assets", "default": null, "optional": true, "choices": null }, { "name": "property_plant_equipment_net", "type": "float", "description": "Property plant and equipment net", "default": null, "optional": true, "choices": null }, { "name": "inventory", "type": "float", "description": "Inventory", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_assets", "type": "float", "description": "Other non-current assets", "default": null, "optional": true, "choices": null }, { "name": "total_non_current_assets", "type": "float", "description": "Total non-current assets", "default": null, "optional": true, "choices": null }, { "name": "intangible_assets", "type": "float", "description": "Intangible assets", "default": null, "optional": true, "choices": null }, { "name": "total_assets", "type": "float", "description": "Total assets", "default": null, "optional": true, "choices": null }, { "name": "accounts_payable", "type": "float", "description": "Accounts payable", "default": null, "optional": true, "choices": null }, { "name": "employee_wages", "type": "float", "description": "Employee wages", "default": null, "optional": true, "choices": null }, { "name": "other_current_liabilities", "type": "float", "description": "Other current liabilities", "default": null, "optional": true, "choices": null }, { "name": "total_current_liabilities", "type": "float", "description": "Total current liabilities", "default": null, "optional": true, "choices": null }, { "name": "other_non_current_liabilities", "type": "float", "description": "Other non-current liabilities", "default": null, "optional": true, "choices": null }, { "name": "total_non_current_liabilities", "type": "float", "description": "Total non-current liabilities", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt", "type": "float", "description": "Long term debt", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities", "type": "float", "description": "Total liabilities", "default": null, "optional": true, "choices": null }, { "name": "minority_interest", "type": "float", "description": "Minority interest", "default": null, "optional": true, "choices": null }, { "name": "temporary_equity_attributable_to_parent", "type": "float", "description": "Temporary equity attributable to parent", "default": null, "optional": true, "choices": null }, { "name": "equity_attributable_to_parent", "type": "float", "description": "Equity attributable to parent", "default": null, "optional": true, "choices": null }, { "name": "temporary_equity", "type": "float", "description": "Temporary equity", "default": null, "optional": true, "choices": null }, { "name": "preferred_stock", "type": "float", "description": "Preferred stock", "default": null, "optional": true, "choices": null }, { "name": "redeemable_non_controlling_interest", "type": "float", "description": "Redeemable non-controlling interest", "default": null, "optional": true, "choices": null }, { "name": "redeemable_non_controlling_interest_other", "type": "float", "description": "Redeemable non-controlling interest other", "default": null, "optional": true, "choices": null }, { "name": "total_shareholders_equity", "type": "float", "description": "Total stock holders equity", "default": null, "optional": true, "choices": null }, { "name": "total_equity", "type": "float", "description": "Total equity", "default": null, "optional": true, "choices": null }, { "name": "total_liabilities_and_shareholders_equity", "type": "float", "description": "Total liabilities and stockholders equity", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "BalanceSheet", "openapi_extra": { "model": "BalanceSheet" } }, "/equity/fundamental/balance_growth": { "deprecated": { "flag": null, "message": null }, "description": "Get the growth of a company's balance sheet items over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.balance_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.balance_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BalanceSheetGrowth]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "growth_cash_and_cash_equivalents", "type": "float", "description": "Growth rate of cash and cash equivalents.", "default": null, "optional": true, "choices": null }, { "name": "growth_short_term_investments", "type": "float", "description": "Growth rate of short-term investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_cash_and_short_term_investments", "type": "float", "description": "Growth rate of cash and short-term investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_receivables", "type": "float", "description": "Growth rate of net receivables.", "default": null, "optional": true, "choices": null }, { "name": "growth_inventory", "type": "float", "description": "Growth rate of inventory.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_current_assets", "type": "float", "description": "Growth rate of other current assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_current_assets", "type": "float", "description": "Growth rate of total current assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_property_plant_equipment_net", "type": "float", "description": "Growth rate of net property, plant, and equipment.", "default": "", "optional": false, "choices": null }, { "name": "growth_goodwill", "type": "float", "description": "Growth rate of goodwill.", "default": "", "optional": false, "choices": null }, { "name": "growth_intangible_assets", "type": "float", "description": "Growth rate of intangible assets.", "default": "", "optional": false, "choices": null }, { "name": "growth_goodwill_and_intangible_assets", "type": "float", "description": "Growth rate of goodwill and intangible assets.", "default": "", "optional": false, "choices": null }, { "name": "growth_long_term_investments", "type": "float", "description": "Growth rate of long-term investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_tax_assets", "type": "float", "description": "Growth rate of tax assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_non_current_assets", "type": "float", "description": "Growth rate of other non-current assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_non_current_assets", "type": "float", "description": "Growth rate of total non-current assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_assets", "type": "float", "description": "Growth rate of other assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_assets", "type": "float", "description": "Growth rate of total assets.", "default": null, "optional": true, "choices": null }, { "name": "growth_account_payables", "type": "float", "description": "Growth rate of accounts payable.", "default": null, "optional": true, "choices": null }, { "name": "growth_short_term_debt", "type": "float", "description": "Growth rate of short-term debt.", "default": null, "optional": true, "choices": null }, { "name": "growth_tax_payables", "type": "float", "description": "Growth rate of tax payables.", "default": null, "optional": true, "choices": null }, { "name": "growth_deferred_revenue", "type": "float", "description": "Growth rate of deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_current_liabilities", "type": "float", "description": "Growth rate of other current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_current_liabilities", "type": "float", "description": "Growth rate of total current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "growth_long_term_debt", "type": "float", "description": "Growth rate of long-term debt.", "default": null, "optional": true, "choices": null }, { "name": "growth_deferred_revenue_non_current", "type": "float", "description": "Growth rate of non-current deferred revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_deferrred_tax_liabilities_non_current", "type": "float", "description": "Growth rate of non-current deferred tax liabilities.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_non_current_liabilities", "type": "float", "description": "Growth rate of other non-current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_non_current_liabilities", "type": "float", "description": "Growth rate of total non-current liabilities.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_liabilities", "type": "float", "description": "Growth rate of other liabilities.", "default": "", "optional": false, "choices": null }, { "name": "growth_total_liabilities", "type": "float", "description": "Growth rate of total liabilities.", "default": "", "optional": false, "choices": null }, { "name": "growth_common_stock", "type": "float", "description": "Growth rate of common stock.", "default": "", "optional": false, "choices": null }, { "name": "growth_retained_earnings", "type": "float", "description": "Growth rate of retained earnings.", "default": "", "optional": false, "choices": null }, { "name": "growth_accumulated_other_comprehensive_income", "type": "float", "description": "Growth rate of accumulated other comprehensive income/loss.", "default": "", "optional": false, "choices": null }, { "name": "growth_other_total_shareholders_equity", "type": "float", "description": "Growth rate of other total stockholders' equity.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_shareholders_equity", "type": "float", "description": "Growth rate of total stockholders' equity.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_liabilities_and_shareholders_equity", "type": "float", "description": "Growth rate of total liabilities and stockholders' equity.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_investments", "type": "float", "description": "Growth rate of total investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_debt", "type": "float", "description": "Growth rate of total debt.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_debt", "type": "float", "description": "Growth rate of net debt.", "default": null, "optional": true, "choices": null } ] }, "model": "BalanceSheetGrowth", "openapi_extra": { "model": "BalanceSheetGrowth" } }, "/equity/fundamental/cash": { "deprecated": { "flag": null, "message": null }, "description": "Get the cash flow statement for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash(symbol='AAPL', period=annual, limit=5, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ], "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm", "ytd" ] }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm" ] }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": false, "optional": true, "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null }, { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CashFlowStatement]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null }, { "name": "filing_date", "type": "date", "description": "The date of the filing.", "default": null, "optional": true, "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date the filing was accepted.", "default": null, "optional": true, "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the cash flow statement was reported.", "default": null, "optional": true, "choices": null }, { "name": "net_income", "type": "float", "description": "Net income.", "default": null, "optional": true, "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and amortization.", "default": null, "optional": true, "choices": null }, { "name": "deferred_income_tax", "type": "float", "description": "Deferred income tax.", "default": null, "optional": true, "choices": null }, { "name": "stock_based_compensation", "type": "float", "description": "Stock-based compensation.", "default": null, "optional": true, "choices": null }, { "name": "change_in_working_capital", "type": "float", "description": "Change in working capital.", "default": null, "optional": true, "choices": null }, { "name": "change_in_account_receivables", "type": "float", "description": "Change in account receivables.", "default": null, "optional": true, "choices": null }, { "name": "change_in_inventory", "type": "float", "description": "Change in inventory.", "default": null, "optional": true, "choices": null }, { "name": "change_in_account_payable", "type": "float", "description": "Change in account payable.", "default": null, "optional": true, "choices": null }, { "name": "change_in_other_working_capital", "type": "float", "description": "Change in other working capital.", "default": null, "optional": true, "choices": null }, { "name": "change_in_other_non_cash_items", "type": "float", "description": "Change in other non-cash items.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_operating_activities", "type": "float", "description": "Net cash from operating activities.", "default": null, "optional": true, "choices": null }, { "name": "purchase_of_property_plant_and_equipment", "type": "float", "description": "Purchase of property, plant and equipment.", "default": null, "optional": true, "choices": null }, { "name": "acquisitions", "type": "float", "description": "Acquisitions.", "default": null, "optional": true, "choices": null }, { "name": "purchase_of_investment_securities", "type": "float", "description": "Purchase of investment securities.", "default": null, "optional": true, "choices": null }, { "name": "sale_and_maturity_of_investments", "type": "float", "description": "Sale and maturity of investments.", "default": null, "optional": true, "choices": null }, { "name": "other_investing_activities", "type": "float", "description": "Other investing activities.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_investing_activities", "type": "float", "description": "Net cash from investing activities.", "default": null, "optional": true, "choices": null }, { "name": "repayment_of_debt", "type": "float", "description": "Repayment of debt.", "default": null, "optional": true, "choices": null }, { "name": "issuance_of_common_equity", "type": "float", "description": "Issuance of common equity.", "default": null, "optional": true, "choices": null }, { "name": "repurchase_of_common_equity", "type": "float", "description": "Repurchase of common equity.", "default": null, "optional": true, "choices": null }, { "name": "payment_of_dividends", "type": "float", "description": "Payment of dividends.", "default": null, "optional": true, "choices": null }, { "name": "other_financing_activities", "type": "float", "description": "Other financing activities.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_financing_activities", "type": "float", "description": "Net cash from financing activities.", "default": null, "optional": true, "choices": null }, { "name": "effect_of_exchange_rate_changes_on_cash", "type": "float", "description": "Effect of exchange rate changes on cash.", "default": null, "optional": true, "choices": null }, { "name": "net_change_in_cash_and_equivalents", "type": "float", "description": "Net change in cash and equivalents.", "default": null, "optional": true, "choices": null }, { "name": "cash_at_beginning_of_period", "type": "float", "description": "Cash at beginning of period.", "default": null, "optional": true, "choices": null }, { "name": "cash_at_end_of_period", "type": "float", "description": "Cash at end of period.", "default": null, "optional": true, "choices": null }, { "name": "operating_cash_flow", "type": "float", "description": "Operating cash flow.", "default": null, "optional": true, "choices": null }, { "name": "capital_expenditure", "type": "float", "description": "Capital expenditure.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow", "type": "float", "description": "None", "default": null, "optional": true, "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, "optional": true, "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true, "choices": null }, { "name": "net_income_continuing_operations", "type": "float", "description": "Net Income (Continuing Operations)", "default": null, "optional": true, "choices": null }, { "name": "net_income_discontinued_operations", "type": "float", "description": "Net Income (Discontinued Operations)", "default": null, "optional": true, "choices": null }, { "name": "net_income", "type": "float", "description": "Consolidated Net Income.", "default": null, "optional": true, "choices": null }, { "name": "provision_for_loan_losses", "type": "float", "description": "Provision for Loan Losses", "default": null, "optional": true, "choices": null }, { "name": "provision_for_credit_losses", "type": "float", "description": "Provision for credit losses", "default": null, "optional": true, "choices": null }, { "name": "depreciation_expense", "type": "float", "description": "Depreciation Expense.", "default": null, "optional": true, "choices": null }, { "name": "amortization_expense", "type": "float", "description": "Amortization Expense.", "default": null, "optional": true, "choices": null }, { "name": "share_based_compensation", "type": "float", "description": "Share-based compensation.", "default": null, "optional": true, "choices": null }, { "name": "non_cash_adjustments_to_reconcile_net_income", "type": "float", "description": "Non-Cash Adjustments to Reconcile Net Income.", "default": null, "optional": true, "choices": null }, { "name": "changes_in_operating_assets_and_liabilities", "type": "float", "description": "Changes in Operating Assets and Liabilities (Net)", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_continuing_operating_activities", "type": "float", "description": "Net Cash from Continuing Operating Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_discontinued_operating_activities", "type": "float", "description": "Net Cash from Discontinued Operating Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_operating_activities", "type": "float", "description": "Net Cash from Operating Activities", "default": null, "optional": true, "choices": null }, { "name": "divestitures", "type": "float", "description": "Divestitures", "default": null, "optional": true, "choices": null }, { "name": "sale_of_property_plant_and_equipment", "type": "float", "description": "Sale of Property, Plant, and Equipment", "default": null, "optional": true, "choices": null }, { "name": "acquisitions", "type": "float", "description": "Acquisitions", "default": null, "optional": true, "choices": null }, { "name": "purchase_of_investments", "type": "float", "description": "Purchase of Investments", "default": null, "optional": true, "choices": null }, { "name": "purchase_of_investment_securities", "type": "float", "description": "Purchase of Investment Securities", "default": null, "optional": true, "choices": null }, { "name": "sale_and_maturity_of_investments", "type": "float", "description": "Sale and Maturity of Investments", "default": null, "optional": true, "choices": null }, { "name": "loans_held_for_sale", "type": "float", "description": "Loans Held for Sale (Net)", "default": null, "optional": true, "choices": null }, { "name": "purchase_of_property_plant_and_equipment", "type": "float", "description": "Purchase of Property, Plant, and Equipment", "default": null, "optional": true, "choices": null }, { "name": "other_investing_activities", "type": "float", "description": "Other Investing Activities (Net)", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_continuing_investing_activities", "type": "float", "description": "Net Cash from Continuing Investing Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_discontinued_investing_activities", "type": "float", "description": "Net Cash from Discontinued Investing Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_investing_activities", "type": "float", "description": "Net Cash from Investing Activities", "default": null, "optional": true, "choices": null }, { "name": "payment_of_dividends", "type": "float", "description": "Payment of Dividends", "default": null, "optional": true, "choices": null }, { "name": "repurchase_of_common_equity", "type": "float", "description": "Repurchase of Common Equity", "default": null, "optional": true, "choices": null }, { "name": "repurchase_of_preferred_equity", "type": "float", "description": "Repurchase of Preferred Equity", "default": null, "optional": true, "choices": null }, { "name": "issuance_of_common_equity", "type": "float", "description": "Issuance of Common Equity", "default": null, "optional": true, "choices": null }, { "name": "issuance_of_preferred_equity", "type": "float", "description": "Issuance of Preferred Equity", "default": null, "optional": true, "choices": null }, { "name": "issuance_of_debt", "type": "float", "description": "Issuance of Debt", "default": null, "optional": true, "choices": null }, { "name": "repayment_of_debt", "type": "float", "description": "Repayment of Debt", "default": null, "optional": true, "choices": null }, { "name": "other_financing_activities", "type": "float", "description": "Other Financing Activities (Net)", "default": null, "optional": true, "choices": null }, { "name": "cash_interest_received", "type": "float", "description": "Cash Interest Received", "default": null, "optional": true, "choices": null }, { "name": "net_change_in_deposits", "type": "float", "description": "Net Change in Deposits", "default": null, "optional": true, "choices": null }, { "name": "net_increase_in_fed_funds_sold", "type": "float", "description": "Net Increase in Fed Funds Sold", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_continuing_financing_activities", "type": "float", "description": "Net Cash from Continuing Financing Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_discontinued_financing_activities", "type": "float", "description": "Net Cash from Discontinued Financing Activities", "default": null, "optional": true, "choices": null }, { "name": "net_cash_from_financing_activities", "type": "float", "description": "Net Cash from Financing Activities", "default": null, "optional": true, "choices": null }, { "name": "effect_of_exchange_rate_changes", "type": "float", "description": "Effect of Exchange Rate Changes", "default": null, "optional": true, "choices": null }, { "name": "other_net_changes_in_cash", "type": "float", "description": "Other Net Changes in Cash", "default": null, "optional": true, "choices": null }, { "name": "net_change_in_cash_and_equivalents", "type": "float", "description": "Net Change in Cash and Equivalents", "default": null, "optional": true, "choices": null }, { "name": "cash_income_taxes_paid", "type": "float", "description": "Cash Income Taxes Paid", "default": null, "optional": true, "choices": null }, { "name": "cash_interest_paid", "type": "float", "description": "Cash Interest Paid", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "net_cash_flow_from_operating_activities_continuing", "type": "float", "description": "Net cash flow from operating activities continuing.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_operating_activities_discontinued", "type": "float", "description": "Net cash flow from operating activities discontinued.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_operating_activities", "type": "float", "description": "Net cash flow from operating activities.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_investing_activities_continuing", "type": "float", "description": "Net cash flow from investing activities continuing.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_investing_activities_discontinued", "type": "float", "description": "Net cash flow from investing activities discontinued.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_investing_activities", "type": "float", "description": "Net cash flow from investing activities.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_financing_activities_continuing", "type": "float", "description": "Net cash flow from financing activities continuing.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_financing_activities_discontinued", "type": "float", "description": "Net cash flow from financing activities discontinued.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_from_financing_activities", "type": "float", "description": "Net cash flow from financing activities.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_continuing", "type": "float", "description": "Net cash flow continuing.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow_discontinued", "type": "float", "description": "Net cash flow discontinued.", "default": null, "optional": true, "choices": null }, { "name": "exchange_gains_losses", "type": "float", "description": "Exchange gains losses.", "default": null, "optional": true, "choices": null }, { "name": "net_cash_flow", "type": "float", "description": "Net cash flow.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "CashFlowStatement", "openapi_extra": { "model": "CashFlowStatement" } }, "/equity/fundamental/reported_financials": { "deprecated": { "flag": null, "message": null }, "description": "Get financial statements as reported by the company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.reported_financials(symbol='AAPL', provider='intrinio')\n# Get AAPL balance sheet with a limit of 10 items.\nobb.equity.fundamental.reported_financials(symbol='AAPL', period='annual', statement_type='balance', limit=10, provider='intrinio')\n# Get reported income statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income', provider='intrinio')\n# Get reported cash flow statement\nobb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "period", "type": "str", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": null }, { "name": "statement_type", "type": "str", "description": "The type of financial statement - i.e, balance, income, cash.", "default": "balance", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", "default": 100, "optional": true, "choices": null } ], "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "None", "default": "annual", "optional": true, "choices": null }, { "name": "statement_type", "type": "Literal['balance', 'income', 'cash']", "description": "Cash flow statements are reported as YTD, Q4 is the same as FY.", "default": "income", "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ReportedFinancials]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The ending date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report (e.g. FY, Q1, etc.).", "default": "", "optional": false, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "model": "ReportedFinancials", "openapi_extra": { "model": "ReportedFinancials" } }, "/equity/fundamental/cash_growth": { "deprecated": { "flag": null, "message": null }, "description": "Get the growth of a company's cash flow statement items over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.cash_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.cash_growth(symbol='AAPL', limit=10, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CashFlowStatementGrowth]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "growth_net_income", "type": "float", "description": "Growth rate of net income.", "default": null, "optional": true, "choices": null }, { "name": "growth_depreciation_and_amortization", "type": "float", "description": "Growth rate of depreciation and amortization.", "default": null, "optional": true, "choices": null }, { "name": "growth_deferred_income_tax", "type": "float", "description": "Growth rate of deferred income tax.", "default": null, "optional": true, "choices": null }, { "name": "growth_stock_based_compensation", "type": "float", "description": "Growth rate of stock-based compensation.", "default": null, "optional": true, "choices": null }, { "name": "growth_change_in_working_capital", "type": "float", "description": "Growth rate of change in working capital.", "default": null, "optional": true, "choices": null }, { "name": "growth_account_receivables", "type": "float", "description": "Growth rate of accounts receivables.", "default": null, "optional": true, "choices": null }, { "name": "growth_inventory", "type": "float", "description": "Growth rate of inventory.", "default": null, "optional": true, "choices": null }, { "name": "growth_account_payable", "type": "float", "description": "Growth rate of account payable.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_working_capital", "type": "float", "description": "Growth rate of other working capital.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_non_cash_items", "type": "float", "description": "Growth rate of other non-cash items.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_cash_from_operating_activities", "type": "float", "description": "Growth rate of net cash provided by operating activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_purchase_of_property_plant_and_equipment", "type": "float", "description": "Growth rate of investments in property, plant, and equipment.", "default": null, "optional": true, "choices": null }, { "name": "growth_acquisitions", "type": "float", "description": "Growth rate of net acquisitions.", "default": null, "optional": true, "choices": null }, { "name": "growth_purchase_of_investment_securities", "type": "float", "description": "Growth rate of purchases of investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_sale_and_maturity_of_investments", "type": "float", "description": "Growth rate of sales maturities of investments.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_investing_activities", "type": "float", "description": "Growth rate of other investing activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_cash_from_investing_activities", "type": "float", "description": "Growth rate of net cash used for investing activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_repayment_of_debt", "type": "float", "description": "Growth rate of debt repayment.", "default": null, "optional": true, "choices": null }, { "name": "growth_common_stock_issued", "type": "float", "description": "Growth rate of common stock issued.", "default": null, "optional": true, "choices": null }, { "name": "growth_common_stock_repurchased", "type": "float", "description": "Growth rate of common stock repurchased.", "default": null, "optional": true, "choices": null }, { "name": "growth_dividends_paid", "type": "float", "description": "Growth rate of dividends paid.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_financing_activities", "type": "float", "description": "Growth rate of other financing activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_cash_from_financing_activities", "type": "float", "description": "Growth rate of net cash used/provided by financing activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_effect_of_exchange_rate_changes_on_cash", "type": "float", "description": "Growth rate of the effect of foreign exchange changes on cash.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_change_in_cash_and_equivalents", "type": "float", "description": "Growth rate of net change in cash.", "default": null, "optional": true, "choices": null }, { "name": "growth_cash_at_beginning_of_period", "type": "float", "description": "Growth rate of cash at the beginning of the period.", "default": null, "optional": true, "choices": null }, { "name": "growth_cash_at_end_of_period", "type": "float", "description": "Growth rate of cash at the end of the period.", "default": null, "optional": true, "choices": null }, { "name": "growth_operating_cash_flow", "type": "float", "description": "Growth rate of operating cash flow.", "default": null, "optional": true, "choices": null }, { "name": "growth_capital_expenditure", "type": "float", "description": "Growth rate of capital expenditure.", "default": null, "optional": true, "choices": null }, { "name": "growth_free_cash_flow", "type": "float", "description": "Growth rate of free cash flow.", "default": null, "optional": true, "choices": null } ] }, "model": "CashFlowStatementGrowth", "openapi_extra": { "model": "CashFlowStatementGrowth" } }, "/equity/fundamental/dividends": { "deprecated": { "flag": null, "message": null }, "description": "Get historical dividend data for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.dividends(symbol='AAPL', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "fmp": [], "intrinio": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, "optional": true, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalDividends]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "ex_dividend_date", "type": "date", "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend.", "default": "", "optional": false, "choices": null }, { "name": "amount", "type": "float", "description": "The dividend amount per share.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "label", "type": "str", "description": "Label of the historical dividends.", "default": "", "optional": false, "choices": null }, { "name": "adj_dividend", "type": "float", "description": "Adjusted dividend of the historical dividends.", "default": "", "optional": false, "choices": null }, { "name": "record_date", "type": "date", "description": "Record date of the historical dividends.", "default": null, "optional": true, "choices": null }, { "name": "payment_date", "type": "date", "description": "Payment date of the historical dividends.", "default": null, "optional": true, "choices": null }, { "name": "declaration_date", "type": "date", "description": "Declaration date of the historical dividends.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "factor", "type": "float", "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the dividend is paid.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "float", "description": "The ratio of the stock split, if a stock split occurred.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "HistoricalDividends", "openapi_extra": { "model": "HistoricalDividends" } }, "/equity/fundamental/historical_eps": { "deprecated": { "flag": null, "message": null }, "description": "Get historical earnings per share data for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_eps(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalEps]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "announce_time", "type": "str", "description": "Timing of the earnings announcement.", "default": null, "optional": true, "choices": null }, { "name": "eps_actual", "type": "float", "description": "Actual EPS from the earnings date.", "default": null, "optional": true, "choices": null }, { "name": "eps_estimated", "type": "float", "description": "Estimated EPS for the earnings date.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "revenue_estimated", "type": "float", "description": "Estimated consensus revenue for the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "revenue_actual", "type": "float", "description": "The actual reported revenue.", "default": null, "optional": true, "choices": null }, { "name": "reporting_time", "type": "str", "description": "The reporting time - e.g. after market close.", "default": null, "optional": true, "choices": null }, { "name": "updated_at", "type": "date", "description": "The date when the data was last updated.", "default": null, "optional": true, "choices": null }, { "name": "period_ending", "type": "date", "description": "The fiscal period end date.", "default": null, "optional": true, "choices": null } ] }, "model": "HistoricalEps", "openapi_extra": { "model": "HistoricalEps" } }, "/equity/fundamental/employee_count": { "deprecated": { "flag": null, "message": null }, "description": "Get historical employee count data for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.employee_count(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalEmployees]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false, "choices": null }, { "name": "acceptance_time", "type": "datetime", "description": "Time of acceptance of the company employee.", "default": "", "optional": false, "choices": null }, { "name": "period_of_report", "type": "date", "description": "Date of reporting of the company employee.", "default": "", "optional": false, "choices": null }, { "name": "company_name", "type": "str", "description": "Registered name of the company to retrieve the historical employees of.", "default": "", "optional": false, "choices": null }, { "name": "form_type", "type": "str", "description": "Form type of the company employee.", "default": "", "optional": false, "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the company employee", "default": "", "optional": false, "choices": null }, { "name": "employee_count", "type": "int", "description": "Count of employees of the company.", "default": "", "optional": false, "choices": null }, { "name": "source", "type": "str", "description": "Source URL which retrieves this data for the company.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "HistoricalEmployees", "openapi_extra": { "model": "HistoricalEmployees" } }, "/equity/fundamental/search_attributes": { "deprecated": { "flag": null, "message": null }, "description": "Search Intrinio data tags to search in latest or historical attributes.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.search_attributes(query='ebitda', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Query to search for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 1000, "optional": true, "choices": null } ], "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SearchAttributes]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "id", "type": "str", "description": "ID of the financial attribute.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the financial attribute.", "default": "", "optional": false, "choices": null }, { "name": "tag", "type": "str", "description": "Tag of the financial attribute.", "default": "", "optional": false, "choices": null }, { "name": "statement_code", "type": "str", "description": "Code of the financial statement.", "default": "", "optional": false, "choices": null }, { "name": "statement_type", "type": "str", "description": "Type of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "parent_name", "type": "str", "description": "Parent's name of the financial attribute.", "default": null, "optional": true, "choices": null }, { "name": "sequence", "type": "int", "description": "Sequence of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "factor", "type": "str", "description": "Unit of the financial attribute.", "default": null, "optional": true, "choices": null }, { "name": "transaction", "type": "str", "description": "Transaction type (credit/debit) of the financial attribute.", "default": null, "optional": true, "choices": null }, { "name": "type", "type": "str", "description": "Type of the financial attribute.", "default": null, "optional": true, "choices": null }, { "name": "unit", "type": "str", "description": "Unit of the financial attribute.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "model": "SearchAttributes", "openapi_extra": { "model": "SearchAttributes" } }, "/equity/fundamental/latest_attributes": { "deprecated": { "flag": null, "message": null }, "description": "Get the latest value of a data tag from Intrinio.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.latest_attributes(symbol='AAPL', tag='ceo', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, "choices": null }, { "name": "tag", "type": "Union[str, list[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, "choices": null } ], "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[LatestAttributes]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "tag", "type": "str", "description": "Tag name for the fetched data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "Union[str, float]", "description": "The value of the data.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "model": "LatestAttributes", "openapi_extra": { "model": "LatestAttributes" } }, "/equity/fundamental/historical_attributes": { "deprecated": { "flag": null, "message": null }, "description": "Get the historical values of a data tag from Intrinio.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_attributes(symbol='AAPL', tag='ebitda', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, "choices": null }, { "name": "tag", "type": "Union[str, list[str]]", "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "default": "", "optional": false, "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": "frequency", "type": "Literal['daily', 'weekly', 'monthly', 'quarterly', 'yearly']", "description": "The frequency of the data.", "default": "yearly", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 1000, "optional": true, "choices": null }, { "name": "tag_type", "type": "str", "description": "Filter by type, when applicable.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order.", "default": "desc", "optional": true, "choices": null } ], "intrinio": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalAttributes]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "tag", "type": "str", "description": "Tag name for the fetched data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The value of the data.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "model": "HistoricalAttributes", "openapi_extra": { "model": "HistoricalAttributes" } }, "/equity/fundamental/income": { "deprecated": { "flag": null, "message": null }, "description": "Get the income statement for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income(symbol='AAPL', period=annual, limit=5, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ], "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm", "ytd" ] }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm" ] }, { "name": "filing_date", "type": "date", "description": "Filing date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lt", "type": "date", "description": "Filing date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_lte", "type": "date", "description": "Filing date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gt", "type": "date", "description": "Filing date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "filing_date_gte", "type": "date", "description": "Filing date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date", "type": "date", "description": "Period of report date of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lt", "type": "date", "description": "Period of report date less than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_lte", "type": "date", "description": "Period of report date less than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gt", "type": "date", "description": "Period of report date greater than the given date.", "default": null, "optional": true, "choices": null }, { "name": "period_of_report_date_gte", "type": "date", "description": "Period of report date greater than or equal to the given date.", "default": null, "optional": true, "choices": null }, { "name": "include_sources", "type": "bool", "description": "Whether to include the sources of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order of the financial statement.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['filing_date', 'period_of_report_date']", "description": "Sort of the financial statement.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 5, "optional": true, "choices": null }, { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[IncomeStatement]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "filing_date", "type": "date", "description": "The date when the filing was made.", "default": null, "optional": true, "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "The date and time when the filing was accepted.", "default": null, "optional": true, "choices": null }, { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet was reported.", "default": null, "optional": true, "choices": null }, { "name": "revenue", "type": "float", "description": "Total revenue.", "default": null, "optional": true, "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Cost of revenue.", "default": null, "optional": true, "choices": null }, { "name": "gross_profit", "type": "float", "description": "Gross profit.", "default": null, "optional": true, "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross profit margin.", "default": null, "optional": true, "choices": null }, { "name": "general_and_admin_expense", "type": "float", "description": "General and administrative expenses.", "default": null, "optional": true, "choices": null }, { "name": "research_and_development_expense", "type": "float", "description": "Research and development expenses.", "default": null, "optional": true, "choices": null }, { "name": "selling_and_marketing_expense", "type": "float", "description": "Selling and marketing expenses.", "default": null, "optional": true, "choices": null }, { "name": "selling_general_and_admin_expense", "type": "float", "description": "Selling, general and administrative expenses.", "default": null, "optional": true, "choices": null }, { "name": "other_expenses", "type": "float", "description": "Other expenses.", "default": null, "optional": true, "choices": null }, { "name": "total_operating_expenses", "type": "float", "description": "Total operating expenses.", "default": null, "optional": true, "choices": null }, { "name": "cost_and_expenses", "type": "float", "description": "Cost and expenses.", "default": null, "optional": true, "choices": null }, { "name": "interest_income", "type": "float", "description": "Interest income.", "default": null, "optional": true, "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Total interest expenses.", "default": null, "optional": true, "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and amortization.", "default": null, "optional": true, "choices": null }, { "name": "ebitda", "type": "float", "description": "EBITDA.", "default": null, "optional": true, "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "EBITDA margin.", "default": null, "optional": true, "choices": null }, { "name": "total_operating_income", "type": "float", "description": "Total operating income.", "default": null, "optional": true, "choices": null }, { "name": "operating_income_margin", "type": "float", "description": "Operating income margin.", "default": null, "optional": true, "choices": null }, { "name": "total_other_income_expenses", "type": "float", "description": "Total other income and expenses.", "default": null, "optional": true, "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Total pre-tax income.", "default": null, "optional": true, "choices": null }, { "name": "pre_tax_income_margin", "type": "float", "description": "Pre-tax income margin.", "default": null, "optional": true, "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income tax expense.", "default": null, "optional": true, "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Consolidated net income.", "default": null, "optional": true, "choices": null }, { "name": "net_income_margin", "type": "float", "description": "Net income margin.", "default": null, "optional": true, "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Basic earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Weighted average basic shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Weighted average diluted shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "link", "type": "str", "description": "Link to the filing.", "default": null, "optional": true, "choices": null }, { "name": "final_link", "type": "str", "description": "Link to the filing document.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "reported_currency", "type": "str", "description": "The currency in which the balance sheet is reported.", "default": null, "optional": true, "choices": null }, { "name": "revenue", "type": "float", "description": "Total revenue", "default": null, "optional": true, "choices": null }, { "name": "operating_revenue", "type": "float", "description": "Total operating revenue", "default": null, "optional": true, "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Total cost of revenue", "default": null, "optional": true, "choices": null }, { "name": "operating_cost_of_revenue", "type": "float", "description": "Total operating cost of revenue", "default": null, "optional": true, "choices": null }, { "name": "gross_profit", "type": "float", "description": "Total gross profit", "default": null, "optional": true, "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross margin ratio.", "default": null, "optional": true, "choices": null }, { "name": "provision_for_credit_losses", "type": "float", "description": "Provision for credit losses", "default": null, "optional": true, "choices": null }, { "name": "research_and_development_expense", "type": "float", "description": "Research and development expense", "default": null, "optional": true, "choices": null }, { "name": "selling_general_and_admin_expense", "type": "float", "description": "Selling, general, and admin expense", "default": null, "optional": true, "choices": null }, { "name": "salaries_and_employee_benefits", "type": "float", "description": "Salaries and employee benefits", "default": null, "optional": true, "choices": null }, { "name": "marketing_expense", "type": "float", "description": "Marketing expense", "default": null, "optional": true, "choices": null }, { "name": "net_occupancy_and_equipment_expense", "type": "float", "description": "Net occupancy and equipment expense", "default": null, "optional": true, "choices": null }, { "name": "other_operating_expenses", "type": "float", "description": "Other operating expenses", "default": null, "optional": true, "choices": null }, { "name": "depreciation_expense", "type": "float", "description": "Depreciation expense", "default": null, "optional": true, "choices": null }, { "name": "amortization_expense", "type": "float", "description": "Amortization expense", "default": null, "optional": true, "choices": null }, { "name": "amortization_of_deferred_policy_acquisition_costs", "type": "float", "description": "Amortization of deferred policy acquisition costs", "default": null, "optional": true, "choices": null }, { "name": "exploration_expense", "type": "float", "description": "Exploration expense", "default": null, "optional": true, "choices": null }, { "name": "depletion_expense", "type": "float", "description": "Depletion expense", "default": null, "optional": true, "choices": null }, { "name": "total_operating_expenses", "type": "float", "description": "Total operating expenses", "default": null, "optional": true, "choices": null }, { "name": "total_operating_income", "type": "float", "description": "Total operating income", "default": null, "optional": true, "choices": null }, { "name": "deposits_and_money_market_investments_interest_income", "type": "float", "description": "Deposits and money market investments interest income", "default": null, "optional": true, "choices": null }, { "name": "federal_funds_sold_and_securities_borrowed_interest_income", "type": "float", "description": "Federal funds sold and securities borrowed interest income", "default": null, "optional": true, "choices": null }, { "name": "investment_securities_interest_income", "type": "float", "description": "Investment securities interest income", "default": null, "optional": true, "choices": null }, { "name": "loans_and_leases_interest_income", "type": "float", "description": "Loans and leases interest income", "default": null, "optional": true, "choices": null }, { "name": "trading_account_interest_income", "type": "float", "description": "Trading account interest income", "default": null, "optional": true, "choices": null }, { "name": "other_interest_income", "type": "float", "description": "Other interest income", "default": null, "optional": true, "choices": null }, { "name": "total_non_interest_income", "type": "float", "description": "Total non-interest income", "default": null, "optional": true, "choices": null }, { "name": "interest_and_investment_income", "type": "float", "description": "Interest and investment income", "default": null, "optional": true, "choices": null }, { "name": "short_term_borrowings_interest_expense", "type": "float", "description": "Short-term borrowings interest expense", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt_interest_expense", "type": "float", "description": "Long-term debt interest expense", "default": null, "optional": true, "choices": null }, { "name": "capitalized_lease_obligations_interest_expense", "type": "float", "description": "Capitalized lease obligations interest expense", "default": null, "optional": true, "choices": null }, { "name": "deposits_interest_expense", "type": "float", "description": "Deposits interest expense", "default": null, "optional": true, "choices": null }, { "name": "federal_funds_purchased_and_securities_sold_interest_expense", "type": "float", "description": "Federal funds purchased and securities sold interest expense", "default": null, "optional": true, "choices": null }, { "name": "other_interest_expense", "type": "float", "description": "Other interest expense", "default": null, "optional": true, "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Total interest expense", "default": null, "optional": true, "choices": null }, { "name": "net_interest_income", "type": "float", "description": "Net interest income", "default": null, "optional": true, "choices": null }, { "name": "other_non_interest_income", "type": "float", "description": "Other non-interest income", "default": null, "optional": true, "choices": null }, { "name": "investment_banking_income", "type": "float", "description": "Investment banking income", "default": null, "optional": true, "choices": null }, { "name": "trust_fees_by_commissions", "type": "float", "description": "Trust fees by commissions", "default": null, "optional": true, "choices": null }, { "name": "premiums_earned", "type": "float", "description": "Premiums earned", "default": null, "optional": true, "choices": null }, { "name": "insurance_policy_acquisition_costs", "type": "float", "description": "Insurance policy acquisition costs", "default": null, "optional": true, "choices": null }, { "name": "current_and_future_benefits", "type": "float", "description": "Current and future benefits", "default": null, "optional": true, "choices": null }, { "name": "property_and_liability_insurance_claims", "type": "float", "description": "Property and liability insurance claims", "default": null, "optional": true, "choices": null }, { "name": "total_non_interest_expense", "type": "float", "description": "Total non-interest expense", "default": null, "optional": true, "choices": null }, { "name": "net_realized_and_unrealized_capital_gains_on_investments", "type": "float", "description": "Net realized and unrealized capital gains on investments", "default": null, "optional": true, "choices": null }, { "name": "other_gains", "type": "float", "description": "Other gains", "default": null, "optional": true, "choices": null }, { "name": "non_operating_income", "type": "float", "description": "Non-operating income", "default": null, "optional": true, "choices": null }, { "name": "other_income", "type": "float", "description": "Other income", "default": null, "optional": true, "choices": null }, { "name": "other_revenue", "type": "float", "description": "Other revenue", "default": null, "optional": true, "choices": null }, { "name": "extraordinary_income", "type": "float", "description": "Extraordinary income", "default": null, "optional": true, "choices": null }, { "name": "total_other_income", "type": "float", "description": "Total other income", "default": null, "optional": true, "choices": null }, { "name": "ebitda", "type": "float", "description": "Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true, "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization.", "default": null, "optional": true, "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Total pre-tax income", "default": null, "optional": true, "choices": null }, { "name": "ebit", "type": "float", "description": "Earnings Before Interest and Taxes.", "default": null, "optional": true, "choices": null }, { "name": "pre_tax_income_margin", "type": "float", "description": "Pre-Tax Income Margin.", "default": null, "optional": true, "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income tax expense", "default": null, "optional": true, "choices": null }, { "name": "impairment_charge", "type": "float", "description": "Impairment charge", "default": null, "optional": true, "choices": null }, { "name": "restructuring_charge", "type": "float", "description": "Restructuring charge", "default": null, "optional": true, "choices": null }, { "name": "service_charges_on_deposit_accounts", "type": "float", "description": "Service charges on deposit accounts", "default": null, "optional": true, "choices": null }, { "name": "other_service_charges", "type": "float", "description": "Other service charges", "default": null, "optional": true, "choices": null }, { "name": "other_special_charges", "type": "float", "description": "Other special charges", "default": null, "optional": true, "choices": null }, { "name": "other_cost_of_revenue", "type": "float", "description": "Other cost of revenue", "default": null, "optional": true, "choices": null }, { "name": "net_income_continuing_operations", "type": "float", "description": "Net income (continuing operations)", "default": null, "optional": true, "choices": null }, { "name": "net_income_discontinued_operations", "type": "float", "description": "Net income (discontinued operations)", "default": null, "optional": true, "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Consolidated net income", "default": null, "optional": true, "choices": null }, { "name": "other_adjustments_to_consolidated_net_income", "type": "float", "description": "Other adjustments to consolidated net income", "default": null, "optional": true, "choices": null }, { "name": "other_adjustment_to_net_income_attributable_to_common_shareholders", "type": "float", "description": "Other adjustment to net income attributable to common shareholders", "default": null, "optional": true, "choices": null }, { "name": "net_income_attributable_to_noncontrolling_interest", "type": "float", "description": "Net income attributable to noncontrolling interest", "default": null, "optional": true, "choices": null }, { "name": "net_income_attributable_to_common_shareholders", "type": "float", "description": "Net income attributable to common shareholders", "default": null, "optional": true, "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Basic earnings per share", "default": null, "optional": true, "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted earnings per share", "default": null, "optional": true, "choices": null }, { "name": "basic_and_diluted_earnings_per_share", "type": "float", "description": "Basic and diluted earnings per share", "default": null, "optional": true, "choices": null }, { "name": "cash_dividends_to_common_per_share", "type": "float", "description": "Cash dividends to common per share", "default": null, "optional": true, "choices": null }, { "name": "preferred_stock_dividends_declared", "type": "float", "description": "Preferred stock dividends declared", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Weighted average basic shares outstanding", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Weighted average diluted shares outstanding", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_basic_and_diluted_shares_outstanding", "type": "float", "description": "Weighted average basic and diluted shares outstanding", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "revenue", "type": "float", "description": "Total Revenue", "default": null, "optional": true, "choices": null }, { "name": "cost_of_revenue_goods", "type": "float", "description": "Cost of Revenue - Goods", "default": null, "optional": true, "choices": null }, { "name": "cost_of_revenue_services", "type": "float", "description": "Cost of Revenue - Services", "default": null, "optional": true, "choices": null }, { "name": "cost_of_revenue", "type": "float", "description": "Cost of Revenue", "default": null, "optional": true, "choices": null }, { "name": "gross_profit", "type": "float", "description": "Gross Profit", "default": null, "optional": true, "choices": null }, { "name": "provisions_for_loan_lease_and_other_losses", "type": "float", "description": "Provisions for loan lease and other losses", "default": null, "optional": true, "choices": null }, { "name": "depreciation_and_amortization", "type": "float", "description": "Depreciation and Amortization", "default": null, "optional": true, "choices": null }, { "name": "income_tax_expense_benefit_current", "type": "float", "description": "Income tax expense benefit current", "default": null, "optional": true, "choices": null }, { "name": "deferred_tax_benefit", "type": "float", "description": "Deferred tax benefit", "default": null, "optional": true, "choices": null }, { "name": "benefits_costs_expenses", "type": "float", "description": "Benefits, costs and expenses", "default": null, "optional": true, "choices": null }, { "name": "selling_general_and_administrative_expense", "type": "float", "description": "Selling, general and administrative expense", "default": null, "optional": true, "choices": null }, { "name": "research_and_development", "type": "float", "description": "Research and development", "default": null, "optional": true, "choices": null }, { "name": "costs_and_expenses", "type": "float", "description": "Costs and expenses", "default": null, "optional": true, "choices": null }, { "name": "other_operating_expenses", "type": "float", "description": "Other Operating Expenses", "default": null, "optional": true, "choices": null }, { "name": "operating_expenses", "type": "float", "description": "Operating expenses", "default": null, "optional": true, "choices": null }, { "name": "operating_income", "type": "float", "description": "Operating Income/Loss", "default": null, "optional": true, "choices": null }, { "name": "non_operating_income", "type": "float", "description": "Non Operating Income/Loss", "default": null, "optional": true, "choices": null }, { "name": "interest_and_dividend_income", "type": "float", "description": "Interest and Dividend Income", "default": null, "optional": true, "choices": null }, { "name": "total_interest_expense", "type": "float", "description": "Interest Expense", "default": null, "optional": true, "choices": null }, { "name": "interest_and_debt_expense", "type": "float", "description": "Interest and Debt Expense", "default": null, "optional": true, "choices": null }, { "name": "net_interest_income", "type": "float", "description": "Interest Income Net", "default": null, "optional": true, "choices": null }, { "name": "interest_income_after_provision_for_losses", "type": "float", "description": "Interest Income After Provision for Losses", "default": null, "optional": true, "choices": null }, { "name": "non_interest_expense", "type": "float", "description": "Non-Interest Expense", "default": null, "optional": true, "choices": null }, { "name": "non_interest_income", "type": "float", "description": "Non-Interest Income", "default": null, "optional": true, "choices": null }, { "name": "income_from_discontinued_operations_net_of_tax_on_disposal", "type": "float", "description": "Income From Discontinued Operations Net of Tax on Disposal", "default": null, "optional": true, "choices": null }, { "name": "income_from_discontinued_operations_net_of_tax", "type": "float", "description": "Income From Discontinued Operations Net of Tax", "default": null, "optional": true, "choices": null }, { "name": "income_before_equity_method_investments", "type": "float", "description": "Income Before Equity Method Investments", "default": null, "optional": true, "choices": null }, { "name": "income_from_equity_method_investments", "type": "float", "description": "Income From Equity Method Investments", "default": null, "optional": true, "choices": null }, { "name": "total_pre_tax_income", "type": "float", "description": "Income Before Tax", "default": null, "optional": true, "choices": null }, { "name": "income_tax_expense", "type": "float", "description": "Income Tax Expense", "default": null, "optional": true, "choices": null }, { "name": "income_after_tax", "type": "float", "description": "Income After Tax", "default": null, "optional": true, "choices": null }, { "name": "consolidated_net_income", "type": "float", "description": "Net Income/Loss", "default": null, "optional": true, "choices": null }, { "name": "net_income_attributable_noncontrolling_interest", "type": "float", "description": "Net income (loss) attributable to noncontrolling interest", "default": null, "optional": true, "choices": null }, { "name": "net_income_attributable_to_parent", "type": "float", "description": "Net income (loss) attributable to parent", "default": null, "optional": true, "choices": null }, { "name": "net_income_attributable_to_common_shareholders", "type": "float", "description": "Net Income/Loss Available To Common Stockholders Basic", "default": null, "optional": true, "choices": null }, { "name": "participating_securities_earnings", "type": "float", "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic", "default": null, "optional": true, "choices": null }, { "name": "undistributed_earnings_allocated_to_participating_securities", "type": "float", "description": "Undistributed Earnings Allocated To Participating Securities", "default": null, "optional": true, "choices": null }, { "name": "common_stock_dividends", "type": "float", "description": "Common Stock Dividends", "default": null, "optional": true, "choices": null }, { "name": "preferred_stock_dividends_and_other_adjustments", "type": "float", "description": "Preferred stock dividends and other adjustments", "default": null, "optional": true, "choices": null }, { "name": "basic_earnings_per_share", "type": "float", "description": "Earnings Per Share", "default": null, "optional": true, "choices": null }, { "name": "diluted_earnings_per_share", "type": "float", "description": "Diluted Earnings Per Share", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_basic_shares_outstanding", "type": "float", "description": "Basic Average Shares", "default": null, "optional": true, "choices": null }, { "name": "weighted_average_diluted_shares_outstanding", "type": "float", "description": "Diluted Average Shares", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "IncomeStatement", "openapi_extra": { "model": "IncomeStatement" } }, "/equity/fundamental/income_growth": { "deprecated": { "flag": null, "message": null }, "description": "Get the growth of a company's income statement items over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.income_growth(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.income_growth(symbol='AAPL', limit=10, period=annual, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[IncomeStatementGrowth]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the report.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the fiscal period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "growth_revenue", "type": "float", "description": "Growth rate of total revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_cost_of_revenue", "type": "float", "description": "Growth rate of cost of goods sold.", "default": null, "optional": true, "choices": null }, { "name": "growth_gross_profit", "type": "float", "description": "Growth rate of gross profit.", "default": null, "optional": true, "choices": null }, { "name": "growth_gross_profit_margin", "type": "float", "description": "Growth rate of gross profit as a percentage of revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_general_and_admin_expense", "type": "float", "description": "Growth rate of general and administrative expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_research_and_development_expense", "type": "float", "description": "Growth rate of expenses on research and development.", "default": null, "optional": true, "choices": null }, { "name": "growth_selling_and_marketing_expense", "type": "float", "description": "Growth rate of expenses on selling and marketing activities.", "default": null, "optional": true, "choices": null }, { "name": "growth_other_expenses", "type": "float", "description": "Growth rate of other operating expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_operating_expenses", "type": "float", "description": "Growth rate of total operating expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_cost_and_expenses", "type": "float", "description": "Growth rate of total costs and expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_interest_expense", "type": "float", "description": "Growth rate of interest expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_depreciation_and_amortization", "type": "float", "description": "Growth rate of depreciation and amortization expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_ebitda", "type": "float", "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.", "default": null, "optional": true, "choices": null }, { "name": "growth_ebitda_margin", "type": "float", "description": "Growth rate of EBITDA as a percentage of revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_operating_income", "type": "float", "description": "Growth rate of operating income.", "default": null, "optional": true, "choices": null }, { "name": "growth_operating_income_margin", "type": "float", "description": "Growth rate of operating income as a percentage of revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_total_other_income_expenses_net", "type": "float", "description": "Growth rate of net total other income and expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_income_before_tax", "type": "float", "description": "Growth rate of income before taxes.", "default": null, "optional": true, "choices": null }, { "name": "growth_income_before_tax_margin", "type": "float", "description": "Growth rate of income before taxes as a percentage of revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_income_tax_expense", "type": "float", "description": "Growth rate of income tax expenses.", "default": null, "optional": true, "choices": null }, { "name": "growth_consolidated_net_income", "type": "float", "description": "Growth rate of net income.", "default": null, "optional": true, "choices": null }, { "name": "growth_net_income_margin", "type": "float", "description": "Growth rate of net income as a percentage of revenue.", "default": null, "optional": true, "choices": null }, { "name": "growth_basic_earings_per_share", "type": "float", "description": "Growth rate of Earnings Per Share (EPS).", "default": null, "optional": true, "choices": null }, { "name": "growth_diluted_earnings_per_share", "type": "float", "description": "Growth rate of diluted Earnings Per Share (EPS).", "default": null, "optional": true, "choices": null }, { "name": "growth_weighted_average_basic_shares_outstanding", "type": "float", "description": "Growth rate of weighted average shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "growth_weighted_average_diluted_shares_outstanding", "type": "float", "description": "Growth rate of diluted weighted average shares outstanding.", "default": null, "optional": true, "choices": null } ] }, "model": "IncomeStatementGrowth", "openapi_extra": { "model": "IncomeStatementGrowth" } }, "/equity/fundamental/metrics": { "deprecated": { "flag": null, "message": null }, "description": "Get fundamental metrics for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.metrics(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.metrics(symbol='AAPL', period=annual, limit=100, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 100, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter" ] }, { "name": "with_ttm", "type": "bool", "description": "Include trailing twelve months (TTM) data.", "default": false, "optional": true, "choices": null } ], "intrinio": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[KeyMetrics]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market capitalization", "default": null, "optional": true, "choices": null }, { "name": "pe_ratio", "type": "float", "description": "Price-to-earnings ratio (P/E ratio)", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "period_ending", "type": "date", "description": "Period ending date.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Period of the data.", "default": "", "optional": false, "choices": null }, { "name": "calendar_year", "type": "int", "description": "Calendar year for the fiscal period.", "default": null, "optional": true, "choices": null }, { "name": "revenue_per_share", "type": "float", "description": "Revenue per share", "default": null, "optional": true, "choices": null }, { "name": "capex_per_share", "type": "float", "description": "Capital expenditures per share", "default": null, "optional": true, "choices": null }, { "name": "net_income_per_share", "type": "float", "description": "Net income per share", "default": null, "optional": true, "choices": null }, { "name": "operating_cash_flow_per_share", "type": "float", "description": "Operating cash flow per share", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_per_share", "type": "float", "description": "Free cash flow per share", "default": null, "optional": true, "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share", "default": null, "optional": true, "choices": null }, { "name": "book_value_per_share", "type": "float", "description": "Book value per share", "default": null, "optional": true, "choices": null }, { "name": "tangible_book_value_per_share", "type": "float", "description": "Tangible book value per share", "default": null, "optional": true, "choices": null }, { "name": "shareholders_equity_per_share", "type": "float", "description": "Shareholders equity per share", "default": null, "optional": true, "choices": null }, { "name": "interest_debt_per_share", "type": "float", "description": "Interest debt per share", "default": null, "optional": true, "choices": null }, { "name": "price_to_sales", "type": "float", "description": "Price-to-sales ratio", "default": null, "optional": true, "choices": null }, { "name": "price_to_operating_cash_flow", "type": "float", "description": "Price-to-operating cash flow ratio", "default": null, "optional": true, "choices": null }, { "name": "price_to_free_cash_flow", "type": "float", "description": "Price-to-free cash flow ratio", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price-to-book ratio", "default": null, "optional": true, "choices": null }, { "name": "price_to_tangible_book", "type": "float", "description": "Price-to-tangible book ratio", "default": null, "optional": true, "choices": null }, { "name": "ev_to_sales", "type": "float", "description": "Enterprise value-to-sales ratio", "default": null, "optional": true, "choices": null }, { "name": "ev_to_ebitda", "type": "float", "description": "Enterprise value-to-EBITDA ratio", "default": null, "optional": true, "choices": null }, { "name": "ev_to_operating_cash_flow", "type": "float", "description": "Enterprise value-to-operating cash flow ratio", "default": null, "optional": true, "choices": null }, { "name": "ev_to_free_cash_flow", "type": "float", "description": "Enterprise value-to-free cash flow ratio", "default": null, "optional": true, "choices": null }, { "name": "earnings_yield", "type": "float", "description": "Earnings yield", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_yield", "type": "float", "description": "Free cash flow yield", "default": null, "optional": true, "choices": null }, { "name": "debt_to_market_cap", "type": "float", "description": "Debt-to-market capitalization ratio", "default": null, "optional": true, "choices": null }, { "name": "debt_to_equity", "type": "float", "description": "Debt-to-equity ratio", "default": null, "optional": true, "choices": null }, { "name": "debt_to_assets", "type": "float", "description": "Debt-to-assets ratio", "default": null, "optional": true, "choices": null }, { "name": "net_debt_to_ebitda", "type": "float", "description": "Net debt-to-EBITDA ratio", "default": null, "optional": true, "choices": null }, { "name": "current_ratio", "type": "float", "description": "Current ratio", "default": null, "optional": true, "choices": null }, { "name": "interest_coverage", "type": "float", "description": "Interest coverage", "default": null, "optional": true, "choices": null }, { "name": "income_quality", "type": "float", "description": "Income quality", "default": null, "optional": true, "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio", "default": null, "optional": true, "choices": null }, { "name": "sales_general_and_administrative_to_revenue", "type": "float", "description": "Sales general and administrative expenses-to-revenue ratio", "default": null, "optional": true, "choices": null }, { "name": "research_and_development_to_revenue", "type": "float", "description": "Research and development expenses-to-revenue ratio", "default": null, "optional": true, "choices": null }, { "name": "intangibles_to_total_assets", "type": "float", "description": "Intangibles-to-total assets ratio", "default": null, "optional": true, "choices": null }, { "name": "capex_to_operating_cash_flow", "type": "float", "description": "Capital expenditures-to-operating cash flow ratio", "default": null, "optional": true, "choices": null }, { "name": "capex_to_revenue", "type": "float", "description": "Capital expenditures-to-revenue ratio", "default": null, "optional": true, "choices": null }, { "name": "capex_to_depreciation", "type": "float", "description": "Capital expenditures-to-depreciation ratio", "default": null, "optional": true, "choices": null }, { "name": "stock_based_compensation_to_revenue", "type": "float", "description": "Stock-based compensation-to-revenue ratio", "default": null, "optional": true, "choices": null }, { "name": "working_capital", "type": "float", "description": "Working capital", "default": null, "optional": true, "choices": null }, { "name": "tangible_asset_value", "type": "float", "description": "Tangible asset value", "default": null, "optional": true, "choices": null }, { "name": "net_current_asset_value", "type": "float", "description": "Net current asset value", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value", "type": "float", "description": "Enterprise value", "default": null, "optional": true, "choices": null }, { "name": "invested_capital", "type": "float", "description": "Invested capital", "default": null, "optional": true, "choices": null }, { "name": "average_receivables", "type": "float", "description": "Average receivables", "default": null, "optional": true, "choices": null }, { "name": "average_payables", "type": "float", "description": "Average payables", "default": null, "optional": true, "choices": null }, { "name": "average_inventory", "type": "float", "description": "Average inventory", "default": null, "optional": true, "choices": null }, { "name": "days_sales_outstanding", "type": "float", "description": "Days sales outstanding", "default": null, "optional": true, "choices": null }, { "name": "days_payables_outstanding", "type": "float", "description": "Days payables outstanding", "default": null, "optional": true, "choices": null }, { "name": "days_of_inventory_on_hand", "type": "float", "description": "Days of inventory on hand", "default": null, "optional": true, "choices": null }, { "name": "receivables_turnover", "type": "float", "description": "Receivables turnover", "default": null, "optional": true, "choices": null }, { "name": "payables_turnover", "type": "float", "description": "Payables turnover", "default": null, "optional": true, "choices": null }, { "name": "inventory_turnover", "type": "float", "description": "Inventory turnover", "default": null, "optional": true, "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity", "default": null, "optional": true, "choices": null }, { "name": "return_on_invested_capital", "type": "float", "description": "Return on invested capital", "default": null, "optional": true, "choices": null }, { "name": "return_on_tangible_assets", "type": "float", "description": "Return on tangible assets", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "graham_number", "type": "float", "description": "Graham number", "default": null, "optional": true, "choices": null }, { "name": "graham_net_net", "type": "float", "description": "Graham net-net working capital", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_tangible_book", "type": "float", "description": "Price to tangible book ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_revenue", "type": "float", "description": "Price to revenue ratio.", "default": null, "optional": true, "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, "optional": true, "choices": null }, { "name": "gross_margin", "type": "float", "description": "Gross margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ebit_margin", "type": "float", "description": "EBIT margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "profit_margin", "type": "float", "description": "Profit margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "eps", "type": "float", "description": "Basic earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "eps_growth", "type": "float", "description": "EPS growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "revenue_growth", "type": "float", "description": "Revenue growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ebitda_growth", "type": "float", "description": "EBITDA growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ebit_growth", "type": "float", "description": "EBIT growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "net_income_growth", "type": "float", "description": "Net income growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_to_firm_growth", "type": "float", "description": "Free cash flow to firm growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "invested_capital_growth", "type": "float", "description": "Invested capital growth, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_on_invested_capital", "type": "float", "description": "Return on invested capital, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ebitda", "type": "int", "description": "Earnings before interest, taxes, depreciation, and amortization.", "default": null, "optional": true, "choices": null }, { "name": "ebit", "type": "int", "description": "Earnings before interest and taxes.", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt", "type": "int", "description": "Long-term debt.", "default": null, "optional": true, "choices": null }, { "name": "total_debt", "type": "int", "description": "Total debt.", "default": null, "optional": true, "choices": null }, { "name": "total_capital", "type": "int", "description": "The sum of long-term debt and total shareholder equity.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value", "type": "int", "description": "Enterprise value.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_to_firm", "type": "int", "description": "Free cash flow to firm.", "default": null, "optional": true, "choices": null }, { "name": "altman_z_score", "type": "float", "description": "Altman Z-score.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "Beta relative to the broad market (rolling three-year).", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "earnings_yield", "type": "float", "description": "Earnings yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "last_price", "type": "float", "description": "Last price of the stock.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52 week high", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52 week low", "default": null, "optional": true, "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily volume.", "default": null, "optional": true, "choices": null }, { "name": "short_interest", "type": "int", "description": "Number of shares reported as sold short.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Weighted average shares outstanding (TTM).", "default": null, "optional": true, "choices": null }, { "name": "days_to_cover", "type": "float", "description": "Days to cover short interest, based on average daily volume.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "forward_pe", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "peg_ratio", "type": "float", "description": "PEG ratio (5-year expected).", "default": null, "optional": true, "choices": null }, { "name": "peg_ratio_ttm", "type": "float", "description": "PEG ratio (TTM).", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share (TTM).", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_to_ebitda", "type": "float", "description": "Enterprise value to EBITDA ratio.", "default": null, "optional": true, "choices": null }, { "name": "earnings_growth", "type": "float", "description": "Earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "earnings_growth_quarterly", "type": "float", "description": "Quarterly earnings growth (Year Over Year), as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "revenue_per_share", "type": "float", "description": "Revenue per share (TTM).", "default": null, "optional": true, "choices": null }, { "name": "revenue_growth", "type": "float", "description": "Revenue growth (Year Over Year), as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_to_revenue", "type": "float", "description": "Enterprise value to revenue ratio.", "default": null, "optional": true, "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share.", "default": null, "optional": true, "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, "optional": true, "choices": null }, { "name": "current_ratio", "type": "float", "description": "Current ratio.", "default": null, "optional": true, "choices": null }, { "name": "debt_to_equity", "type": "float", "description": "Debt-to-equity ratio.", "default": null, "optional": true, "choices": null }, { "name": "gross_margin", "type": "float", "description": "Gross margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "operating_margin", "type": "float", "description": "Operating margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "ebitda_margin", "type": "float", "description": "EBITDA margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "profit_margin", "type": "float", "description": "Profit margin, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield_5y_avg", "type": "float", "description": "5-year average dividend yield, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price-to-book ratio.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value", "type": "int", "description": "Enterprise value.", "default": null, "optional": true, "choices": null }, { "name": "overall_risk", "type": "float", "description": "Overall risk score.", "default": null, "optional": true, "choices": null }, { "name": "audit_risk", "type": "float", "description": "Audit risk score.", "default": null, "optional": true, "choices": null }, { "name": "board_risk", "type": "float", "description": "Board risk score.", "default": null, "optional": true, "choices": null }, { "name": "compensation_risk", "type": "float", "description": "Compensation risk score.", "default": null, "optional": true, "choices": null }, { "name": "shareholder_rights_risk", "type": "float", "description": "Shareholder rights risk score.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "Beta relative to the broad market (5-year monthly).", "default": null, "optional": true, "choices": null }, { "name": "price_return_1y", "type": "float", "description": "One-year price return, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency in which the data is presented.", "default": null, "optional": true, "choices": null } ] }, "model": "KeyMetrics", "openapi_extra": { "model": "KeyMetrics" } }, "/equity/fundamental/management": { "deprecated": { "flag": null, "message": null }, "description": "Get executive management team data for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[KeyExecutives]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "title", "type": "str", "description": "Designation of the key executive.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the key executive.", "default": "", "optional": false, "choices": null }, { "name": "pay", "type": "int", "description": "Pay of the key executive.", "default": null, "optional": true, "choices": null }, { "name": "currency_pay", "type": "str", "description": "Currency of the pay.", "default": null, "optional": true, "choices": null }, { "name": "gender", "type": "str", "description": "Gender of the key executive.", "default": null, "optional": true, "choices": null }, { "name": "year_born", "type": "int", "description": "Birth year of the key executive.", "default": null, "optional": true, "choices": null }, { "name": "title_since", "type": "int", "description": "Date the tile was held since.", "default": null, "optional": true, "choices": null } ], "fmp": [], "yfinance": [ { "name": "exercised_value", "type": "int", "description": "Value of shares exercised.", "default": null, "optional": true, "choices": null }, { "name": "unexercised_value", "type": "int", "description": "Value of shares not exercised.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year of the pay.", "default": null, "optional": true, "choices": null } ] }, "model": "KeyExecutives", "openapi_extra": { "model": "KeyExecutives" } }, "/equity/fundamental/management_compensation": { "deprecated": { "flag": null, "message": null }, "description": "Get executive management team compensation for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_compensation(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "year", "type": "int", "description": "Year of the compensation.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ExecutiveCompensation]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "company_name", "type": "str", "description": "The name of the company.", "default": null, "optional": true, "choices": null }, { "name": "industry", "type": "str", "description": "The industry of the company.", "default": null, "optional": true, "choices": null }, { "name": "year", "type": "int", "description": "Year of the compensation.", "default": null, "optional": true, "choices": null }, { "name": "name_and_position", "type": "str", "description": "Name and position.", "default": null, "optional": true, "choices": null }, { "name": "salary", "type": "Annotated[float, Ge(ge=0)]", "description": "Salary.", "default": null, "optional": true, "choices": null }, { "name": "bonus", "type": "Annotated[float, Ge(ge=0)]", "description": "Bonus payments.", "default": null, "optional": true, "choices": null }, { "name": "stock_award", "type": "Annotated[float, Ge(ge=0)]", "description": "Stock awards.", "default": null, "optional": true, "choices": null }, { "name": "incentive_plan_compensation", "type": "Annotated[float, Ge(ge=0)]", "description": "Incentive plan compensation.", "default": null, "optional": true, "choices": null }, { "name": "all_other_compensation", "type": "Annotated[float, Ge(ge=0)]", "description": "All other compensation.", "default": null, "optional": true, "choices": null }, { "name": "total", "type": "Annotated[float, Ge(ge=0)]", "description": "Total compensation.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "filing_date", "type": "date", "description": "Date of the filing.", "default": null, "optional": true, "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "Date the filing was accepted.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "URL to the filing data.", "default": null, "optional": true, "choices": null } ] }, "model": "ExecutiveCompensation", "openapi_extra": { "model": "ExecutiveCompensation" } }, "/equity/fundamental/ratios": { "deprecated": { "flag": null, "message": null }, "description": "Get an extensive set of financial and accounting ratios for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.ratios(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.ratios(symbol='AAPL', period=annual, limit=12, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 12, "optional": true, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm" ] } ], "intrinio": [ { "name": "period", "type": "Literal['annual', 'quarter', 'ttm', 'ytd']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "annual", "quarter", "ttm", "ytd" ] }, { "name": "fiscal_year", "type": "int", "description": "The specific fiscal year. Reports do not go beyond 2008.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FinancialRatios]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "str", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "Period of the financial ratios.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "Fiscal year.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "current_ratio", "type": "float", "description": "Current ratio.", "default": null, "optional": true, "choices": null }, { "name": "quick_ratio", "type": "float", "description": "Quick ratio.", "default": null, "optional": true, "choices": null }, { "name": "cash_ratio", "type": "float", "description": "Cash ratio.", "default": null, "optional": true, "choices": null }, { "name": "days_of_sales_outstanding", "type": "float", "description": "Days of sales outstanding.", "default": null, "optional": true, "choices": null }, { "name": "days_of_inventory_outstanding", "type": "float", "description": "Days of inventory outstanding.", "default": null, "optional": true, "choices": null }, { "name": "operating_cycle", "type": "float", "description": "Operating cycle.", "default": null, "optional": true, "choices": null }, { "name": "days_of_payables_outstanding", "type": "float", "description": "Days of payables outstanding.", "default": null, "optional": true, "choices": null }, { "name": "cash_conversion_cycle", "type": "float", "description": "Cash conversion cycle.", "default": null, "optional": true, "choices": null }, { "name": "gross_profit_margin", "type": "float", "description": "Gross profit margin.", "default": null, "optional": true, "choices": null }, { "name": "operating_profit_margin", "type": "float", "description": "Operating profit margin.", "default": null, "optional": true, "choices": null }, { "name": "pretax_profit_margin", "type": "float", "description": "Pretax profit margin.", "default": null, "optional": true, "choices": null }, { "name": "net_profit_margin", "type": "float", "description": "Net profit margin.", "default": null, "optional": true, "choices": null }, { "name": "effective_tax_rate", "type": "float", "description": "Effective tax rate.", "default": null, "optional": true, "choices": null }, { "name": "return_on_assets", "type": "float", "description": "Return on assets.", "default": null, "optional": true, "choices": null }, { "name": "return_on_equity", "type": "float", "description": "Return on equity.", "default": null, "optional": true, "choices": null }, { "name": "return_on_capital_employed", "type": "float", "description": "Return on capital employed.", "default": null, "optional": true, "choices": null }, { "name": "net_income_per_ebt", "type": "float", "description": "Net income per EBT.", "default": null, "optional": true, "choices": null }, { "name": "ebt_per_ebit", "type": "float", "description": "EBT per EBIT.", "default": null, "optional": true, "choices": null }, { "name": "ebit_per_revenue", "type": "float", "description": "EBIT per revenue.", "default": null, "optional": true, "choices": null }, { "name": "debt_ratio", "type": "float", "description": "Debt ratio.", "default": null, "optional": true, "choices": null }, { "name": "debt_equity_ratio", "type": "float", "description": "Debt equity ratio.", "default": null, "optional": true, "choices": null }, { "name": "long_term_debt_to_capitalization", "type": "float", "description": "Long term debt to capitalization.", "default": null, "optional": true, "choices": null }, { "name": "total_debt_to_capitalization", "type": "float", "description": "Total debt to capitalization.", "default": null, "optional": true, "choices": null }, { "name": "interest_coverage", "type": "float", "description": "Interest coverage.", "default": null, "optional": true, "choices": null }, { "name": "cash_flow_to_debt_ratio", "type": "float", "description": "Cash flow to debt ratio.", "default": null, "optional": true, "choices": null }, { "name": "company_equity_multiplier", "type": "float", "description": "Company equity multiplier.", "default": null, "optional": true, "choices": null }, { "name": "receivables_turnover", "type": "float", "description": "Receivables turnover.", "default": null, "optional": true, "choices": null }, { "name": "payables_turnover", "type": "float", "description": "Payables turnover.", "default": null, "optional": true, "choices": null }, { "name": "inventory_turnover", "type": "float", "description": "Inventory turnover.", "default": null, "optional": true, "choices": null }, { "name": "fixed_asset_turnover", "type": "float", "description": "Fixed asset turnover.", "default": null, "optional": true, "choices": null }, { "name": "asset_turnover", "type": "float", "description": "Asset turnover.", "default": null, "optional": true, "choices": null }, { "name": "operating_cash_flow_per_share", "type": "float", "description": "Operating cash flow per share.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_per_share", "type": "float", "description": "Free cash flow per share.", "default": null, "optional": true, "choices": null }, { "name": "cash_per_share", "type": "float", "description": "Cash per share.", "default": null, "optional": true, "choices": null }, { "name": "payout_ratio", "type": "float", "description": "Payout ratio.", "default": null, "optional": true, "choices": null }, { "name": "operating_cash_flow_sales_ratio", "type": "float", "description": "Operating cash flow sales ratio.", "default": null, "optional": true, "choices": null }, { "name": "free_cash_flow_operating_cash_flow_ratio", "type": "float", "description": "Free cash flow operating cash flow ratio.", "default": null, "optional": true, "choices": null }, { "name": "cash_flow_coverage_ratios", "type": "float", "description": "Cash flow coverage ratios.", "default": null, "optional": true, "choices": null }, { "name": "short_term_coverage_ratios", "type": "float", "description": "Short term coverage ratios.", "default": null, "optional": true, "choices": null }, { "name": "capital_expenditure_coverage_ratio", "type": "float", "description": "Capital expenditure coverage ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_paid_and_capex_coverage_ratio", "type": "float", "description": "Dividend paid and capex coverage ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_payout_ratio", "type": "float", "description": "Dividend payout ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_book_value_ratio", "type": "float", "description": "Price book value ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book_ratio", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_sales_ratio", "type": "float", "description": "Price to sales ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_earnings_ratio", "type": "float", "description": "Price earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_free_cash_flows_ratio", "type": "float", "description": "Price to free cash flows ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_to_operating_cash_flows_ratio", "type": "float", "description": "Price to operating cash flows ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_cash_flow_ratio", "type": "float", "description": "Price cash flow ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_earnings_to_growth_ratio", "type": "float", "description": "Price earnings to growth ratio.", "default": null, "optional": true, "choices": null }, { "name": "price_sales_ratio", "type": "float", "description": "Price sales ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield_percentage", "type": "float", "description": "Dividend yield percentage.", "default": null, "optional": true, "choices": null }, { "name": "dividend_per_share", "type": "float", "description": "Dividend per share.", "default": null, "optional": true, "choices": null }, { "name": "enterprise_value_multiple", "type": "float", "description": "Enterprise value multiple.", "default": null, "optional": true, "choices": null }, { "name": "price_fair_value", "type": "float", "description": "Price fair value.", "default": null, "optional": true, "choices": null } ], "intrinio": [] }, "model": "FinancialRatios", "openapi_extra": { "model": "FinancialRatios" } }, "/equity/fundamental/revenue_per_geography": { "deprecated": { "flag": null, "message": null }, "description": "Get the geographic breakdown of revenue for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_geography(symbol='AAPL', period=quarter, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "quarter", "annual" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[RevenueGeographic]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "filing_date", "type": "date", "description": "The filing date of the report.", "default": null, "optional": true, "choices": null }, { "name": "region", "type": "str", "description": "The region represented by the revenue data.", "default": null, "optional": true, "choices": null }, { "name": "revenue", "type": "Union[int, float]", "description": "The total revenue attributed to the region.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "RevenueGeographic", "openapi_extra": { "model": "RevenueGeographic" } }, "/equity/fundamental/revenue_per_segment": { "deprecated": { "flag": null, "message": null }, "description": "Get the revenue breakdown by business segment for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', provider='fmp')\nobb.equity.fundamental.revenue_per_segment(symbol='AAPL', period=quarter, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "period", "type": "Literal['quarter', 'annual']", "description": "Time period of the data to return.", "default": "annual", "optional": true, "choices": [ "quarter", "annual" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[RevenueBusinessLine]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": "", "optional": false, "choices": null }, { "name": "fiscal_period", "type": "str", "description": "The fiscal period of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year", "type": "int", "description": "The fiscal year of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "filing_date", "type": "date", "description": "The filing date of the report.", "default": null, "optional": true, "choices": null }, { "name": "business_line", "type": "str", "description": "The business line represented by the revenue data.", "default": null, "optional": true, "choices": null }, { "name": "revenue", "type": "Union[int, float]", "description": "The total revenue attributed to the business line.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "RevenueBusinessLine", "openapi_extra": { "model": "RevenueBusinessLine" } }, "/equity/fundamental/filings": { "deprecated": { "flag": null, "message": null }, "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": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "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": "SEC form type to filter by. Multiple items allowed for provider(s): sec.", "default": null, "optional": true, "choices": [ "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" ] }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": null, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache. If True, cache will store for one day.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CompanyFilings]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "filing_date", "type": "date", "description": "The date of the filing.", "default": "", "optional": false, "choices": null }, { "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 }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "accepted_date", "type": "datetime", "description": "Accepted date of the filing.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "id", "type": "str", "description": "Intrinio ID of the filing.", "default": "", "optional": false, "choices": null }, { "name": "period_end_date", "type": "date", "description": "Ending date of the fiscal period for the filing.", "default": null, "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", "description": "SEC unique ID of the filing.", "default": "", "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", "description": "URL for the XBRL filing for the report.", "default": null, "optional": true, "choices": null }, { "name": "industry_group", "type": "str", "description": "Industry group of the company.", "default": "", "optional": false, "choices": null }, { "name": "industry_category", "type": "str", "description": "Industry category of the company.", "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": [ { "name": "report_date", "type": "date", "description": "The date of the filing.", "default": null, "optional": true, "choices": null }, { "name": "act", "type": "Union[int, str]", "description": "The SEC Act number.", "default": null, "optional": true, "choices": null }, { "name": "items", "type": "Union[str, float]", "description": "The SEC Item numbers.", "default": null, "optional": true, "choices": null }, { "name": "primary_doc_description", "type": "str", "description": "The description of the primary document.", "default": null, "optional": true, "choices": null }, { "name": "primary_doc", "type": "str", "description": "The filename of the primary document.", "default": null, "optional": true, "choices": null }, { "name": "accession_number", "type": "Union[int, str]", "description": "The accession number.", "default": null, "optional": true, "choices": null }, { "name": "file_number", "type": "Union[int, str]", "description": "The file number.", "default": null, "optional": true, "choices": null }, { "name": "film_number", "type": "Union[int, str]", "description": "The film number.", "default": null, "optional": true, "choices": null }, { "name": "is_inline_xbrl", "type": "Union[int, str]", "description": "Whether the filing is an inline XBRL filing.", "default": null, "optional": true, "choices": null }, { "name": "is_xbrl", "type": "Union[int, str]", "description": "Whether the filing is an XBRL filing.", "default": null, "optional": true, "choices": null }, { "name": "size", "type": "Union[int, str]", "description": "The size of the filing.", "default": null, "optional": true, "choices": null }, { "name": "complete_submission_url", "type": "str", "description": "The URL to the complete filing submission.", "default": null, "optional": true, "choices": null }, { "name": "filing_detail_url", "type": "str", "description": "The URL to the filing details.", "default": null, "optional": true, "choices": null } ] }, "model": "CompanyFilings", "openapi_extra": { "model": "CompanyFilings" } }, "/equity/fundamental/historical_splits": { "deprecated": { "flag": null, "message": null }, "description": "Get historical stock splits for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.historical_splits(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalSplits]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "numerator", "type": "float", "description": "Numerator of the split.", "default": null, "optional": true, "choices": null }, { "name": "denominator", "type": "float", "description": "Denominator of the split.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "str", "description": "Split ratio.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "model": "HistoricalSplits", "openapi_extra": { "model": "HistoricalSplits" } }, "/equity/fundamental/transcript": { "deprecated": { "flag": null, "message": null }, "description": "Get earnings call transcripts for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.transcript(symbol='AAPL', year='2020', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null }, { "name": "year", "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, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EarningsCallTranscript]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "quarter", "type": "int", "description": "Quarter of the earnings call transcript.", "default": "", "optional": false, "choices": null }, { "name": "year", "type": "int", "description": "Year of the earnings call transcript.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "content", "type": "str", "description": "Content of the earnings call transcript.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "EarningsCallTranscript", "openapi_extra": { "model": "EarningsCallTranscript" } }, "/equity/fundamental/trailing_dividend_yield": { "deprecated": { "flag": null, "message": null }, "description": "Get the 1 year trailing dividend yield for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', provider='tiingo')\nobb.equity.fundamental.trailing_dividend_yield(symbol='AAPL', limit=252, provider='tiingo')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", "default": 252, "optional": true, "choices": null } ], "tiingo": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[TrailingDividendYield]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['tiingo']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "trailing_dividend_yield", "type": "float", "description": "Trailing dividend yield.", "default": "", "optional": false, "choices": null } ], "tiingo": [] }, "model": "TrailingDividendYield", "openapi_extra": { "model": "TrailingDividendYield" } }, "/equity/fundamental/management_discussion_analysis": { "deprecated": { "flag": null, "message": null }, "description": "Get the Management Discussion & Analysis section from the financial statements for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.fundamental.management_discussion_analysis(symbol='AAPL', provider='sec')\n# Get the Management Discussion & Analysis section by calendar year and period.\nobb.equity.fundamental.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec')\n# Setting 'include_tables' to True will attempt to extract all tables in valid Markdown.\nobb.equity.fundamental.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec', include_tables=True)\n# Setting 'raw_html' to True will bypass extraction and return the raw HTML file, as is. Use this for custom parsing or to access the entire HTML filing.\nobb.equity.fundamental.management_discussion_analysis(symbol='AAPL', calendar_year=2020, calendar_period='Q4', provider='sec', raw_html=True)\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "calendar_year", "type": "int", "description": "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.", "default": null, "optional": true, "choices": null }, { "name": "calendar_period", "type": "Literal['Q1', 'Q2', 'Q3', 'Q4']", "description": "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.", "default": null, "optional": true, "choices": null } ], "sec": [ { "name": "strategy", "type": "Literal['inscriptis', 'trafilatura']", "description": "The strategy to use for extracting the text. Default is 'trafilatura'.", "default": "trafilatura", "optional": true, "choices": null }, { "name": "wrap_length", "type": "int", "description": "The length to wrap the extracted text, excluding tables. Default is 120.", "default": 120, "optional": true, "choices": null }, { "name": "include_tables", "type": "bool", "description": "Return tables formatted as markdown in the text. Default is False. Tables may reveal 'missing' content, but will likely need some level of manual cleaning, post-request, to display properly. In some cases, tables may not be recoverable due to the nature of the document.", "default": false, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "When True, the file will be cached for use later. Default is True.", "default": true, "optional": true, "choices": null }, { "name": "raw_html", "type": "bool", "description": "When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ManagementDiscussionAnalysis]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "calendar_year", "type": "int", "description": "The calendar year of the report.", "default": "", "optional": false, "choices": null }, { "name": "calendar_period", "type": "int", "description": "The calendar period of the report.", "default": "", "optional": false, "choices": null }, { "name": "period_ending", "type": "date", "description": "The end date of the reporting period.", "default": null, "optional": true, "choices": null }, { "name": "content", "type": "str", "description": "The content of the management discussion and analysis.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "url", "type": "str", "description": "The URL of the filing from which the data was extracted.", "default": "", "optional": false, "choices": null } ] }, "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": { "flag": null, "message": null }, "description": "Get data about major holders for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')\nobb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null }, { "name": "page", "type": "int", "description": "Page number of the data to fetch.", "default": 0, "optional": true, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityOwnership]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": "", "optional": false, "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "investor_name", "type": "str", "description": "Investor name of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "security_name", "type": "str", "description": "Security name of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "type_of_security", "type": "str", "description": "Type of security of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "security_cusip", "type": "str", "description": "Security cusip of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "shares_type", "type": "str", "description": "Shares type of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "put_call_share", "type": "str", "description": "Put call share of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "investment_discretion", "type": "str", "description": "Investment discretion of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "industry_title", "type": "str", "description": "Industry title of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "weight", "type": "float", "description": "Weight of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "last_weight", "type": "float", "description": "Last weight of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_weight", "type": "float", "description": "Change in weight of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_weight_percentage", "type": "float", "description": "Change in weight percentage of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "market_value", "type": "int", "description": "Market value of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "last_market_value", "type": "int", "description": "Last market value of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_market_value", "type": "int", "description": "Change in market value of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_market_value_percentage", "type": "float", "description": "Change in market value percentage of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "shares_number", "type": "int", "description": "Shares number of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "last_shares_number", "type": "int", "description": "Last shares number of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_shares_number", "type": "float", "description": "Change in shares number of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_shares_number_percentage", "type": "float", "description": "Change in shares number percentage of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "quarter_end_price", "type": "float", "description": "Quarter end price of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "avg_price_paid", "type": "float", "description": "Average price paid of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "is_new", "type": "bool", "description": "Is the stock ownership new.", "default": "", "optional": false, "choices": null }, { "name": "is_sold_out", "type": "bool", "description": "Is the stock ownership sold out.", "default": "", "optional": false, "choices": null }, { "name": "ownership", "type": "float", "description": "How much is the ownership.", "default": "", "optional": false, "choices": null }, { "name": "last_ownership", "type": "float", "description": "Last ownership amount.", "default": "", "optional": false, "choices": null }, { "name": "change_in_ownership", "type": "float", "description": "Change in ownership amount.", "default": "", "optional": false, "choices": null }, { "name": "change_in_ownership_percentage", "type": "float", "description": "Change in ownership percentage.", "default": "", "optional": false, "choices": null }, { "name": "holding_period", "type": "int", "description": "Holding period of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "first_added", "type": "date", "description": "First added date of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "performance", "type": "float", "description": "Performance of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "performance_percentage", "type": "float", "description": "Performance percentage of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "last_performance", "type": "float", "description": "Last performance of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "change_in_performance", "type": "float", "description": "Change in performance of the stock ownership.", "default": "", "optional": false, "choices": null }, { "name": "is_counted_for_performance", "type": "bool", "description": "Is the stock ownership counted for performance.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "EquityOwnership", "openapi_extra": { "model": "EquityOwnership" } }, "/equity/ownership/institutional": { "deprecated": { "flag": null, "message": null }, "description": "Get data about institutional ownership for a given company over time.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.institutional(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "include_current_quarter", "type": "bool", "description": "Include current quarter data.", "default": false, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[InstitutionalOwnership]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "investors_holding", "type": "int", "description": "Number of investors holding the stock.", "default": "", "optional": false, "choices": null }, { "name": "last_investors_holding", "type": "int", "description": "Number of investors holding the stock in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "investors_holding_change", "type": "int", "description": "Change in the number of investors holding the stock.", "default": "", "optional": false, "choices": null }, { "name": "number_of_13f_shares", "type": "int", "description": "Number of 13F shares.", "default": null, "optional": true, "choices": null }, { "name": "last_number_of_13f_shares", "type": "int", "description": "Number of 13F shares in the last quarter.", "default": null, "optional": true, "choices": null }, { "name": "number_of_13f_shares_change", "type": "int", "description": "Change in the number of 13F shares.", "default": null, "optional": true, "choices": null }, { "name": "total_invested", "type": "float", "description": "Total amount invested.", "default": "", "optional": false, "choices": null }, { "name": "last_total_invested", "type": "float", "description": "Total amount invested in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "total_invested_change", "type": "float", "description": "Change in the total amount invested.", "default": "", "optional": false, "choices": null }, { "name": "ownership_percent", "type": "float", "description": "Ownership percent.", "default": "", "optional": false, "choices": null }, { "name": "last_ownership_percent", "type": "float", "description": "Ownership percent in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "ownership_percent_change", "type": "float", "description": "Change in the ownership percent.", "default": "", "optional": false, "choices": null }, { "name": "new_positions", "type": "int", "description": "Number of new positions.", "default": "", "optional": false, "choices": null }, { "name": "last_new_positions", "type": "int", "description": "Number of new positions in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "new_positions_change", "type": "int", "description": "Change in the number of new positions.", "default": "", "optional": false, "choices": null }, { "name": "increased_positions", "type": "int", "description": "Number of increased positions.", "default": "", "optional": false, "choices": null }, { "name": "last_increased_positions", "type": "int", "description": "Number of increased positions in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "increased_positions_change", "type": "int", "description": "Change in the number of increased positions.", "default": "", "optional": false, "choices": null }, { "name": "closed_positions", "type": "int", "description": "Number of closed positions.", "default": "", "optional": false, "choices": null }, { "name": "last_closed_positions", "type": "int", "description": "Number of closed positions in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "closed_positions_change", "type": "int", "description": "Change in the number of closed positions.", "default": "", "optional": false, "choices": null }, { "name": "reduced_positions", "type": "int", "description": "Number of reduced positions.", "default": "", "optional": false, "choices": null }, { "name": "last_reduced_positions", "type": "int", "description": "Number of reduced positions in the last quarter.", "default": "", "optional": false, "choices": null }, { "name": "reduced_positions_change", "type": "int", "description": "Change in the number of reduced positions.", "default": "", "optional": false, "choices": null }, { "name": "total_calls", "type": "int", "description": "Total number of call options contracts traded for Apple Inc. on the specified date.", "default": "", "optional": false, "choices": null }, { "name": "last_total_calls", "type": "int", "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date.", "default": "", "optional": false, "choices": null }, { "name": "total_calls_change", "type": "int", "description": "Change in the total number of call options contracts traded between the current and previous reporting dates.", "default": "", "optional": false, "choices": null }, { "name": "total_puts", "type": "int", "description": "Total number of put options contracts traded for Apple Inc. on the specified date.", "default": "", "optional": false, "choices": null }, { "name": "last_total_puts", "type": "int", "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date.", "default": "", "optional": false, "choices": null }, { "name": "total_puts_change", "type": "int", "description": "Change in the total number of put options contracts traded between the current and previous reporting dates.", "default": "", "optional": false, "choices": null }, { "name": "put_call_ratio", "type": "float", "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.", "default": "", "optional": false, "choices": null }, { "name": "last_put_call_ratio", "type": "float", "description": "Put-call ratio on the previous reporting date.", "default": "", "optional": false, "choices": null }, { "name": "put_call_ratio_change", "type": "float", "description": "Change in the put-call ratio between the current and previous reporting dates.", "default": "", "optional": false, "choices": null } ] }, "model": "InstitutionalOwnership", "openapi_extra": { "model": "InstitutionalOwnership" } }, "/equity/ownership/insider_trading": { "deprecated": { "flag": null, "message": null }, "description": "Get data about trading by a company's management team and board of directors.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')\nobb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 500, "optional": true, "choices": null } ], "fmp": [ { "name": "transaction_type", "type": "Literal['award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']", "description": "Type of the transaction.", "default": null, "optional": true, "choices": [ "award", "conversion", "return", "expire_short", "in_kind", "gift", "expire_long", "discretionary", "other", "small", "exempt", "otm", "purchase", "sale", "tender", "will", "itm", "trust" ] } ], "intrinio": [ { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": "", "optional": false, "choices": null }, { "name": "end_date", "type": "Union[date, str]", "description": "End date of the data, in YYYY-MM-DD format.", "default": "", "optional": false, "choices": null }, { "name": "ownership_type", "type": "Literal['D', 'I']", "description": "Type of ownership.", "default": null, "optional": true, "choices": null }, { "name": "sort_by", "type": "Literal['filing_date', 'updated_on']", "description": "Field to sort by.", "default": "updated_on", "optional": true, "choices": null } ], "sec": [ { "name": "start_date", "type": "Union[date, str]", "description": "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.", "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 is today.", "default": null, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[InsiderTrading]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "company_cik", "type": "Union[int, str]", "description": "CIK number of the company.", "default": null, "optional": true, "choices": null }, { "name": "filing_date", "type": "Union[date, datetime]", "description": "Filing date of the trade.", "default": null, "optional": true, "choices": null }, { "name": "transaction_date", "type": "date", "description": "Date of the transaction.", "default": null, "optional": true, "choices": null }, { "name": "owner_cik", "type": "Union[int, str]", "description": "Reporting individual's CIK.", "default": null, "optional": true, "choices": null }, { "name": "owner_name", "type": "str", "description": "Name of the reporting individual.", "default": null, "optional": true, "choices": null }, { "name": "owner_title", "type": "str", "description": "The title held by the reporting individual.", "default": null, "optional": true, "choices": null }, { "name": "transaction_type", "type": "str", "description": "Type of transaction being reported.", "default": null, "optional": true, "choices": null }, { "name": "acquisition_or_disposition", "type": "str", "description": "Acquisition or disposition of the shares.", "default": null, "optional": true, "choices": null }, { "name": "security_type", "type": "str", "description": "The type of security transacted.", "default": null, "optional": true, "choices": null }, { "name": "securities_owned", "type": "float", "description": "Number of securities owned by the reporting individual.", "default": null, "optional": true, "choices": null }, { "name": "securities_transacted", "type": "float", "description": "Number of securities transacted by the reporting individual.", "default": null, "optional": true, "choices": null }, { "name": "transaction_price", "type": "float", "description": "The price of the transaction.", "default": null, "optional": true, "choices": null }, { "name": "filing_url", "type": "str", "description": "Link to the filing.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "form_type", "type": "str", "description": "Form type of the insider trading.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "filing_url", "type": "str", "description": "URL of the filing.", "default": null, "optional": true, "choices": null }, { "name": "company_name", "type": "str", "description": "Name of the company.", "default": "", "optional": false, "choices": null }, { "name": "conversion_exercise_price", "type": "float", "description": "Conversion/Exercise price of the shares.", "default": null, "optional": true, "choices": null }, { "name": "deemed_execution_date", "type": "date", "description": "Deemed execution date of the trade.", "default": null, "optional": true, "choices": null }, { "name": "exercise_date", "type": "date", "description": "Exercise date of the trade.", "default": null, "optional": true, "choices": null }, { "name": "expiration_date", "type": "date", "description": "Expiration date of the derivative.", "default": null, "optional": true, "choices": null }, { "name": "underlying_security_title", "type": "str", "description": "Name of the underlying non-derivative security related to this derivative transaction.", "default": null, "optional": true, "choices": null }, { "name": "underlying_shares", "type": "Union[int, float]", "description": "Number of underlying shares related to this derivative transaction.", "default": null, "optional": true, "choices": null }, { "name": "nature_of_ownership", "type": "str", "description": "Nature of ownership of the insider trading.", "default": null, "optional": true, "choices": null }, { "name": "director", "type": "bool", "description": "Whether the owner is a director.", "default": null, "optional": true, "choices": null }, { "name": "officer", "type": "bool", "description": "Whether the owner is an officer.", "default": null, "optional": true, "choices": null }, { "name": "ten_percent_owner", "type": "bool", "description": "Whether the owner is a 10% owner.", "default": null, "optional": true, "choices": null }, { "name": "other_relation", "type": "bool", "description": "Whether the owner is having another relation.", "default": null, "optional": true, "choices": null }, { "name": "derivative_transaction", "type": "bool", "description": "Whether the owner is having a derivative transaction.", "default": null, "optional": true, "choices": null }, { "name": "report_line_number", "type": "int", "description": "Report line number of the insider trading.", "default": null, "optional": true, "choices": null } ], "sec": [ { "name": "company_name", "type": "str", "description": "Name of the company.", "default": null, "optional": true, "choices": null }, { "name": "form", "type": "Union[int, str]", "description": "Form type.", "default": null, "optional": true, "choices": null }, { "name": "director", "type": "bool", "description": "Whether the owner is a director.", "default": null, "optional": true, "choices": null }, { "name": "officer", "type": "bool", "description": "Whether the owner is an officer.", "default": null, "optional": true, "choices": null }, { "name": "ten_percent_owner", "type": "bool", "description": "Whether the owner is a 10% owner.", "default": null, "optional": true, "choices": null }, { "name": "other", "type": "bool", "description": "Whether the owner is classified as other.", "default": null, "optional": true, "choices": null }, { "name": "other_text", "type": "str", "description": "Text for other classification.", "default": null, "optional": true, "choices": null }, { "name": "transaction_timeliness", "type": "str", "description": "Timeliness of the transaction.", "default": null, "optional": true, "choices": null }, { "name": "ownership_type", "type": "str", "description": "Type of ownership, direct or indirect.", "default": null, "optional": true, "choices": null }, { "name": "nature_of_ownership", "type": "str", "description": "Nature of the ownership.", "default": null, "optional": true, "choices": null }, { "name": "exercise_date", "type": "date", "description": "Date of exercise.", "default": null, "optional": true, "choices": null }, { "name": "expiration_date", "type": "date", "description": "Date of expiration for the derivative.", "default": null, "optional": true, "choices": null }, { "name": "deemed_execution_date", "type": "date", "description": "Deemed execution date.", "default": null, "optional": true, "choices": null }, { "name": "underlying_security_title", "type": "str", "description": "Title of the underlying security.", "default": null, "optional": true, "choices": null }, { "name": "underlying_security_shares", "type": "float", "description": "Number of underlying shares associated with the derivative.", "default": null, "optional": true, "choices": null }, { "name": "underlying_security_value", "type": "float", "description": "Value of the underlying security.", "default": null, "optional": true, "choices": null }, { "name": "conversion_exercise_price", "type": "float", "description": "Price of conversion or exercise of the securities.", "default": null, "optional": true, "choices": null }, { "name": "transaction_value", "type": "float", "description": "Total value of the transaction.", "default": null, "optional": true, "choices": null }, { "name": "value_owned", "type": "float", "description": "Value of the securities owned after the transaction.", "default": null, "optional": true, "choices": null }, { "name": "footnote", "type": "str", "description": "Footnote for the transaction.", "default": null, "optional": true, "choices": null } ] }, "model": "InsiderTrading", "openapi_extra": { "model": "InsiderTrading" } }, "/equity/ownership/share_statistics": { "deprecated": { "flag": null, "message": null }, "description": "Get data about share float for a given company.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): yfinance.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ShareStatistics]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "free_float", "type": "float", "description": "Percentage of unrestricted shares of a publicly-traded company.", "default": null, "optional": true, "choices": null }, { "name": "float_shares", "type": "float", "description": "Number of shares available for trading by the general public.", "default": null, "optional": true, "choices": null }, { "name": "outstanding_shares", "type": "float", "description": "Total number of shares of a publicly-traded company.", "default": null, "optional": true, "choices": null }, { "name": "source", "type": "str", "description": "Source of the received data.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "adjusted_outstanding_shares", "type": "float", "description": "Total number of shares of a publicly-traded company, adjusted for splits.", "default": null, "optional": true, "choices": null }, { "name": "public_float", "type": "float", "description": "Aggregate market value of the shares of a publicly-traded company.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "implied_shares_outstanding", "type": "int", "description": "Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true, "choices": null }, { "name": "short_interest", "type": "int", "description": "Number of shares that are reported short.", "default": null, "optional": true, "choices": null }, { "name": "short_percent_of_float", "type": "float", "description": "Percentage of shares that are reported short, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "days_to_cover", "type": "float", "description": "Number of days to repurchase the shares as a ratio of average daily volume", "default": null, "optional": true, "choices": null }, { "name": "short_interest_prev_month", "type": "int", "description": "Number of shares that were reported short in the previous month.", "default": null, "optional": true, "choices": null }, { "name": "short_interest_prev_date", "type": "date", "description": "Date of the previous month's report.", "default": null, "optional": true, "choices": null }, { "name": "insider_ownership", "type": "float", "description": "Percentage of shares held by insiders, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "institution_ownership", "type": "float", "description": "Percentage of shares held by institutions, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "institution_float_ownership", "type": "float", "description": "Percentage of float held by institutions, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "institutions_count", "type": "int", "description": "Number of institutions holding shares.", "default": null, "optional": true, "choices": null } ] }, "model": "ShareStatistics", "openapi_extra": { "model": "ShareStatistics" } }, "/equity/ownership/form_13f": { "deprecated": { "flag": null, "message": null }, "description": "Get the form 13F.\n\nThe Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.form_13f(symbol='NVDA', provider='sec')\n# Enter a date (calendar quarter ending) for a specific report.\nobb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')\n# Example finding Michael Burry's filings.\ncik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik\n# Use the `limit` parameter to return N number of reports from the most recent.\nobb.equity.ownership.form_13f(cik, limit=2).to_df()\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for. A CIK or Symbol can be used.", "default": "", "optional": false, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", "default": 1, "optional": true, "choices": null } ], "sec": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[Form13FHR]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "period_ending", "type": "date", "description": "The end-of-quarter date of the filing.", "default": "", "optional": false, "choices": null }, { "name": "issuer", "type": "str", "description": "The name of the issuer.", "default": "", "optional": false, "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the security.", "default": "", "optional": false, "choices": null }, { "name": "asset_class", "type": "str", "description": "The title of the asset class for the security.", "default": "", "optional": false, "choices": null }, { "name": "security_type", "type": "Literal['SH', 'PRN']", "description": "Whether the principal amount represents the number of shares or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.", "default": null, "optional": true, "choices": null }, { "name": "option_type", "type": "Literal['call', 'put']", "description": "Defined when the holdings being reported are put or call options. Only long positions are reported.", "default": null, "optional": true, "choices": null }, { "name": "investment_discretion", "type": "str", "description": "The investment discretion held by the Manager. Sole, shared-defined (DFN), or shared-other (OTR).", "default": null, "optional": true, "choices": null }, { "name": "voting_authority_sole", "type": "int", "description": "The number of shares for which the Manager exercises sole voting authority.", "default": null, "optional": true, "choices": null }, { "name": "voting_authority_shared", "type": "int", "description": "The number of shares for which the Manager exercises a defined shared voting authority.", "default": null, "optional": true, "choices": null }, { "name": "voting_authority_none", "type": "int", "description": "The number of shares for which the Manager exercises no voting authority.", "default": null, "optional": true, "choices": null }, { "name": "principal_amount", "type": "int", "description": "The total number of shares of the class of security or the principal amount of such class. Defined by the 'security_type'. Only long positions are reported", "default": "", "optional": false, "choices": null }, { "name": "value", "type": "int", "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "weight", "type": "float", "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", "default": "", "optional": false, "choices": null } ] }, "model": "Form13FHR", "openapi_extra": { "model": "Form13FHR" } }, "/equity/ownership/government_trades": { "deprecated": { "flag": null, "message": null }, "description": "Obtain government transaction data, including data from the Senate\nand the House of Representatives.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.ownership.government_trades(symbol='AAPL', chamber='all', provider='fmp')\nobb.equity.ownership.government_trades(limit=500, chamber='all', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": null, "optional": true, "choices": null }, { "name": "chamber", "type": "Literal['house', 'senate', 'all']", "description": "Government Chamber.", "default": "all", "optional": true, "choices": null }, { "name": "limit", "type": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 100, "optional": true, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[GovernmentTrades]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "transaction_date", "type": "date", "description": "Date of Transaction.", "default": null, "optional": true, "choices": null }, { "name": "representative", "type": "str", "description": "Name of Representative.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "chamber", "type": "Literal['house', 'senate']", "description": "Government Chamber - House or Senate.", "default": "", "optional": false, "choices": null }, { "name": "owner", "type": "str", "description": "Ownership status (e.g., Spouse, Joint).", "default": null, "optional": true, "choices": null }, { "name": "asset_type", "type": "str", "description": "Type of asset involved in the transaction.", "default": null, "optional": true, "choices": null }, { "name": "asset_description", "type": "str", "description": "Description of the asset.", "default": null, "optional": true, "choices": null }, { "name": "transaction_type", "type": "str", "description": "Type of transaction (e.g., Sale, Purchase).", "default": null, "optional": true, "choices": null }, { "name": "amount", "type": "str", "description": "Transaction amount range.", "default": null, "optional": true, "choices": null }, { "name": "comment", "type": "str", "description": "Additional comments on the transaction.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "Link to the transaction document.", "default": null, "optional": true, "choices": null } ] }, "model": "GovernmentTrades", "openapi_extra": { "model": "GovernmentTrades" } }, "/equity/price/quote": { "deprecated": { "flag": null, "message": null }, "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.quote(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [ { "name": "symbol", "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false, "choices": null }, { "name": "source", "type": "Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip']", "description": "Source of the data.", "default": "iex", "optional": true, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityQuote]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "asset_type", "type": "str", "description": "Type of asset - i.e, stock, ETF, etc.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the company or asset.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The name or symbol of the venue where the data is from.", "default": null, "optional": true, "choices": null }, { "name": "bid", "type": "float", "description": "Price of the top bid order.", "default": null, "optional": true, "choices": null }, { "name": "bid_size", "type": "int", "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, "optional": true, "choices": null }, { "name": "bid_exchange", "type": "str", "description": "The specific trading venue where the purchase order was placed.", "default": null, "optional": true, "choices": null }, { "name": "ask", "type": "float", "description": "Price of the top ask order.", "default": null, "optional": true, "choices": null }, { "name": "ask_size", "type": "int", "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price.", "default": null, "optional": true, "choices": null }, { "name": "ask_exchange", "type": "str", "description": "The specific trading venue where the sale order was placed.", "default": null, "optional": true, "choices": null }, { "name": "quote_conditions", "type": "Union[str, int, list[str], list[int]]", "description": "Conditions or condition codes applicable to the quote.", "default": null, "optional": true, "choices": null }, { "name": "quote_indicators", "type": "Union[str, int, list[str], list[int]]", "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO.", "default": null, "optional": true, "choices": null }, { "name": "sales_conditions", "type": "Union[str, int, list[str], list[int]]", "description": "Conditions or condition codes applicable to the sale.", "default": null, "optional": true, "choices": null }, { "name": "sequence_number", "type": "int", "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).", "default": null, "optional": true, "choices": null }, { "name": "market_center", "type": "str", "description": "The ID of the UTP participant that originated the message.", "default": null, "optional": true, "choices": null }, { "name": "participant_timestamp", "type": "datetime", "description": "Timestamp for when the quote was generated by the exchange.", "default": null, "optional": true, "choices": null }, { "name": "trf_timestamp", "type": "datetime", "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message.", "default": null, "optional": true, "choices": null }, { "name": "sip_timestamp", "type": "datetime", "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange.", "default": null, "optional": true, "choices": null }, { "name": "last_price", "type": "float", "description": "Price of the last trade.", "default": null, "optional": true, "choices": null }, { "name": "last_tick", "type": "str", "description": "Whether the last sale was an up or down tick.", "default": null, "optional": true, "choices": null }, { "name": "last_size", "type": "int", "description": "Size of the last trade.", "default": null, "optional": true, "choices": null }, { "name": "last_timestamp", "type": "datetime", "description": "Date and Time when the last price was recorded.", "default": null, "optional": true, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, "optional": true, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "exchange_volume", "type": "Union[int, float]", "description": "Volume of shares exchanged during the trading day on the specific exchange.", "default": null, "optional": true, "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in price from previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in price as a normalized percentage.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The one year high (52W High).", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The one year low (52W Low).", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "price_avg50", "type": "float", "description": "50 day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "price_avg200", "type": "float", "description": "200 day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "avg_volume", "type": "int", "description": "Average volume over the last 10 trading days.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market cap of the company.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Number of shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "eps", "type": "float", "description": "Earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe", "type": "float", "description": "Price earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "earnings_announcement", "type": "datetime", "description": "Upcoming earnings announcement date.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "is_darkpool", "type": "bool", "description": "Whether or not the current trade is from a darkpool.", "default": null, "optional": true, "choices": null }, { "name": "source", "type": "str", "description": "Source of the Intrinio data.", "default": null, "optional": true, "choices": null }, { "name": "updated_on", "type": "datetime", "description": "Date and Time when the data was last updated.", "default": "", "optional": false, "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "Security details related to the quote.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "ma_50d", "type": "float", "description": "50-day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "ma_200d", "type": "float", "description": "200-day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "volume_average", "type": "float", "description": "Average daily trading volume.", "default": null, "optional": true, "choices": null }, { "name": "volume_average_10d", "type": "float", "description": "Average daily trading volume in the last 10 days.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityQuote", "openapi_extra": { "model": "EquityQuote" } }, "/equity/price/nbbo": { "deprecated": { "flag": null, "message": null }, "description": "Get the National Best Bid and Offer for a given stock.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.nbbo(symbol='AAPL', provider='polygon')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "polygon": [ { "name": "limit", "type": "int", "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols.", "default": 50000, "optional": true, "choices": null }, { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges.", "default": null, "optional": true, "choices": null }, { "name": "timestamp_lt", "type": "Union[datetime, str]", "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true, "choices": null }, { "name": "timestamp_gt", "type": "Union[datetime, str]", "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true, "choices": null }, { "name": "timestamp_lte", "type": "Union[datetime, str]", "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true, "choices": null }, { "name": "timestamp_gte", "type": "Union[datetime, str]", "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityNBBO]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['polygon']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "ask_exchange", "type": "str", "description": "The exchange ID for the ask.", "default": "", "optional": false, "choices": null }, { "name": "ask", "type": "float", "description": "The last ask price.", "default": "", "optional": false, "choices": null }, { "name": "ask_size", "type": "int", "description": "The ask size. This represents the number of round lot orders at the given ask price.\n The normal round lot size is 100 shares.\n An ask size of 2 means there are 200 shares available to purchase at the given ask price.", "default": "", "optional": false, "choices": null }, { "name": "bid_size", "type": "int", "description": "The bid size in round lots.", "default": "", "optional": false, "choices": null }, { "name": "bid", "type": "float", "description": "The last bid price.", "default": "", "optional": false, "choices": null }, { "name": "bid_exchange", "type": "str", "description": "The exchange ID for the bid.", "default": "", "optional": false, "choices": null } ], "polygon": [ { "name": "tape", "type": "str", "description": "The exchange tape.", "default": null, "optional": true, "choices": null }, { "name": "conditions", "type": "Union[str, list[int], list[str]]", "description": "A list of condition codes.", "default": null, "optional": true, "choices": null }, { "name": "indicators", "type": "list[int]", "description": "A list of indicator codes.", "default": null, "optional": true, "choices": null }, { "name": "sequence_num", "type": "int", "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)", "default": null, "optional": true, "choices": null }, { "name": "participant_timestamp", "type": "datetime", "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.", "default": null, "optional": true, "choices": null }, { "name": "sip_timestamp", "type": "datetime", "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", "default": null, "optional": true, "choices": null }, { "name": "trf_timestamp", "type": "datetime", "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityNBBO", "openapi_extra": { "model": "EquityNBBO" } }, "/equity/price/historical": { "deprecated": { "flag": null, "message": null }, "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.historical(symbol='AAPL', provider='fmp')\nobb.equity.price.historical(symbol='AAPL', interval=1d, provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "fmp": [ { "name": "interval", "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ] } ], "intrinio": [ { "name": "symbol", "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false, "choices": null }, { "name": "interval", "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "10m", "15m", "30m", "60m", "1h", "1d", "1W", "1M", "1Q", "1Y" ] }, { "name": "start_time", "type": "datetime.time", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true, "choices": null }, { "name": "end_time", "type": "datetime.time", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true, "choices": null }, { "name": "timezone", "type": "str", "description": "Timezone of the data, in the IANA format (Continent/City).", "default": "America/New_York", "optional": true, "choices": null }, { "name": "source", "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", "description": "The source of the data.", "default": "realtime", "optional": true, "choices": null } ], "polygon": [ { "name": "interval", "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", "optional": true, "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'unadjusted']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", "optional": true, "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, "optional": true, "choices": null } ], "tiingo": [ { "name": "interval", "type": "Union[Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '1W', '1M', '1Y'], str]", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "90m", "1h", "2h", "4h", "1d", "1W", "1M", "1Y" ] } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1W", "1M", "1Q" ] }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, "optional": true, "choices": null }, { "name": "include_actions", "type": "bool", "description": "Include dividends and stock splits in results.", "default": true, "optional": true, "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[Union[date, datetime], str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", "optional": false, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", "optional": false, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", "optional": false, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "unadjusted_volume", "type": "float", "description": "Unadjusted volume of the symbol.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "average", "type": "float", "description": "Average trade price of an individual equity during the interval.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price of the symbol from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Percent change in the price of the symbol from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, "optional": true, "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, "optional": true, "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, "optional": true, "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, "optional": true, "choices": null }, { "name": "fifty_two_week_high", "type": "float", "description": "52 week high price for the symbol.", "default": null, "optional": true, "choices": null }, { "name": "fifty_two_week_low", "type": "float", "description": "52 week low price for the symbol.", "default": null, "optional": true, "choices": null }, { "name": "factor", "type": "float", "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true, "choices": null }, { "name": "close_time", "type": "datetime", "description": "The timestamp that represents the end of the interval span.", "default": null, "optional": true, "choices": null }, { "name": "interval", "type": "str", "description": "The data time frequency.", "default": null, "optional": true, "choices": null }, { "name": "intra_period", "type": "bool", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "transactions", "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null } ], "tiingo": [ { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, "optional": true, "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, "optional": true, "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, "optional": true, "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityHistorical", "openapi_extra": { "model": "EquityHistorical" } }, "/equity/price/performance": { "deprecated": { "flag": null, "message": null }, "description": "Get price performance data for a given stock. This includes price changes for different time periods.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.price.performance(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PricePerformance]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "one_day", "type": "float", "description": "One-day return.", "default": null, "optional": true, "choices": null }, { "name": "wtd", "type": "float", "description": "Week to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_week", "type": "float", "description": "One-week return.", "default": null, "optional": true, "choices": null }, { "name": "mtd", "type": "float", "description": "Month to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_month", "type": "float", "description": "One-month return.", "default": null, "optional": true, "choices": null }, { "name": "qtd", "type": "float", "description": "Quarter to date return.", "default": null, "optional": true, "choices": null }, { "name": "three_month", "type": "float", "description": "Three-month return.", "default": null, "optional": true, "choices": null }, { "name": "six_month", "type": "float", "description": "Six-month return.", "default": null, "optional": true, "choices": null }, { "name": "ytd", "type": "float", "description": "Year to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_year", "type": "float", "description": "One-year return.", "default": null, "optional": true, "choices": null }, { "name": "two_year", "type": "float", "description": "Two-year return.", "default": null, "optional": true, "choices": null }, { "name": "three_year", "type": "float", "description": "Three-year return.", "default": null, "optional": true, "choices": null }, { "name": "four_year", "type": "float", "description": "Four-year", "default": null, "optional": true, "choices": null }, { "name": "five_year", "type": "float", "description": "Five-year return.", "default": null, "optional": true, "choices": null }, { "name": "ten_year", "type": "float", "description": "Ten-year return.", "default": null, "optional": true, "choices": null }, { "name": "max", "type": "float", "description": "Return from the beginning of the time series.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "The ticker symbol.", "default": "", "optional": false, "choices": null } ] }, "model": "PricePerformance", "openapi_extra": { "model": "PricePerformance" } }, "/equity/shorts/fails_to_deliver": { "deprecated": { "flag": null, "message": null }, "description": "Get reported Fail-to-deliver (FTD) data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.shorts.fails_to_deliver(symbol='AAPL', provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "limit", "type": "int", "description": "Limit the number of reports to parse, from most recent.\n Approximately 24 reports per year, going back to 2009.", "default": 24, "optional": true, "choices": null }, { "name": "skip_reports", "type": "int", "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.", "default": 0, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityFTD]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "settlement_date", "type": "date", "description": "The settlement date of the fail.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP of the Security.", "default": null, "optional": true, "choices": null }, { "name": "quantity", "type": "int", "description": "The number of fails on that settlement date.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "The price at the previous closing price from the settlement date.", "default": null, "optional": true, "choices": null }, { "name": "description", "type": "str", "description": "The description of the Security.", "default": null, "optional": true, "choices": null } ], "sec": [] }, "model": "EquityFTD", "openapi_extra": { "model": "EquityFTD" } }, "/equity/search": { "deprecated": { "flag": null, "message": null }, "description": "Search for stock symbol, CIK, LEI, or company name.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.search(provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null }, { "name": "is_symbol", "type": "bool", "description": "Whether to search by ticker symbol.", "default": false, "optional": true, "choices": null } ], "intrinio": [ { "name": "active", "type": "bool", "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.", "default": true, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10000, "optional": true, "choices": null } ], "sec": [ { "name": "use_cache", "type": "bool", "description": "Whether to use the cache or not.", "default": true, "optional": true, "choices": null }, { "name": "is_fund", "type": "bool", "description": "Whether to direct the search to the list of mutual funds and ETFs.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquitySearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['intrinio', 'sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the company.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "cik", "type": "str", "description": "", "default": "", "optional": false, "choices": null }, { "name": "lei", "type": "str", "description": "The Legal Entity Identifier (LEI) of the company.", "default": "", "optional": false, "choices": null }, { "name": "intrinio_id", "type": "str", "description": "The Intrinio ID of the company.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "cik", "type": "str", "description": "Central Index Key", "default": "", "optional": false, "choices": null } ] }, "model": "EquitySearch", "openapi_extra": { "model": "EquitySearch" } }, "/equity/screener": { "deprecated": { "flag": null, "message": null }, "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.screener(provider='fmp')\n```\n\n", "parameters": { "standard": [], "fmp": [ { "name": "mktcap_min", "type": "int", "description": "Filter by market cap greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "mktcap_max", "type": "int", "description": "Filter by market cap less than this value.", "default": null, "optional": true, "choices": null }, { "name": "price_min", "type": "float", "description": "Filter by price greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "price_max", "type": "float", "description": "Filter by price less than this value.", "default": null, "optional": true, "choices": null }, { "name": "beta_min", "type": "float", "description": "Filter by a beta greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "beta_max", "type": "float", "description": "Filter by a beta less than this value.", "default": null, "optional": true, "choices": null }, { "name": "volume_min", "type": "int", "description": "Filter by volume greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "volume_max", "type": "int", "description": "Filter by volume less than this value.", "default": null, "optional": true, "choices": null }, { "name": "dividend_min", "type": "float", "description": "Filter by dividend amount greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "dividend_max", "type": "float", "description": "Filter by dividend amount less than this value.", "default": null, "optional": true, "choices": null }, { "name": "is_etf", "type": "bool", "description": "If true, returns only ETFs.", "default": false, "optional": true, "choices": null }, { "name": "is_active", "type": "bool", "description": "If false, returns only inactive tickers.", "default": true, "optional": true, "choices": null }, { "name": "sector", "type": "Literal['consumer_cyclical', 'energy', 'technology', 'industrials', 'financial_services', 'basic_materials', 'communication_services', 'consumer_defensive', 'healthcare', 'real_estate', 'utilities', 'industrial_goods', 'financial', 'services']", "description": "Filter by sector.", "default": null, "optional": true, "choices": [ "consumer_cyclical", "energy", "technology", "industrials", "financial_services", "basic_materials", "communication_services", "consumer_defensive", "healthcare", "real_estate", "utilities", "industrial_goods", "financial", "services" ] }, { "name": "industry", "type": "str", "description": "Filter by industry.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "Filter by country, as a two-letter country code.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", "description": "Filter by exchange.", "default": null, "optional": true, "choices": [ "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" ] }, { "name": "limit", "type": "int", "description": "Limit the number of results to return.", "default": 50000, "optional": true, "choices": null } ], "yfinance": [ { "name": "country", "type": "str", "description": "Filter by country, as a two-letter country code. Default is, 'us'. Use, 'all', for all countries.", "default": "us", "optional": true, "choices": [ "all", "ar", "at", "au", "be", "br", "ca", "ch", "cl", "cn", "cz", "de", "dk", "ee", "eg", "es", "fi", "fr", "gb", "gr", "hk", "hu", "id", "ie", "il", "in", "is", "it", "jp", "kr", "kw", "lk", "lt", "lv", "mx", "my", "nl", "no", "nz", "pe", "ph", "pk", "pl", "pt", "qa", "ro", "ru", "sa", "se", "sg", "sr", "th", "tr", "tw", "us", "ve", "vn", "za" ] }, { "name": "exchange", "type": "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']", "description": "Filter by exchange.", "default": null, "optional": true, "choices": [ "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" ] }, { "name": "sector", "type": "Literal['basic_materials', 'communication_services', 'consumer_cyclical', 'consumer_defensive', 'energy', 'financial_services', 'healthcare', 'industrials', 'real_estate', 'technology', 'utilities']", "description": "Filter by sector.", "default": null, "optional": true, "choices": [ "basic_materials", "communication_services", "consumer_cyclical", "consumer_defensive", "energy", "financial_services", "healthcare", "industrials", "real_estate", "technology", "utilities" ] }, { "name": "industry", "type": "str", "description": "Filter by industry.", "default": null, "optional": true, "choices": [ "advertising_agencies", "aerospace_defense", "agricultural_inputs", "airlines", "airports_air_services", "aluminum", "apparel_manufacturing", "apparel_retail", "asset_management", "auto_components", "auto_manufacturers", "auto_parts", "auto_truck_dealerships", "automobiles", "banks", "biotechnology", "broadcasting", "building_materials", "building_products", "building_products_equipment", "business_equipment_supplies", "capital_markets", "chemicals", "coking_coal", "commercial_services", "communication_equipment", "computer_hardware", "confectioners", "construction_engineering", "construction_materials", "consulting_services", "consumer_durables", "consumer_electronics", "consumer_services", "copper", "credit_services", "department_stores", "diagnostics_research", "discount_stores", "diversified_financials", "education_training_services", "electrical_equipment", "electrical_equipment_parts", "electronic_components", "electronic_gaming_multimedia", "electronics_computer_distribution", "energy_services", "engineering_construction", "entertainment", "farm_heavy_construction_machinery", "farm_products", "financial_conglomerates", "financial_data_stock_exchanges", "food_distribution", "footwear_accessories", "furnishings_fixtures_appliances", "gambling", "gold", "grocery_stores", "health_information_services", "healthcare_plans", "home_builders", "home_improvement_retail", "household_products", "household_personal_products", "industrial_conglomerates", "industrial_distribution", "information_technology_services", "infrastructure_operations", "insurance", "integrated_freight_logistics", "internet_content_information", "internet_retail", "leisure", "lodging", "lumber_wood_production", "luxury_goods", "machinery", "marine_shipping", "media", "medical_care_facilities", "medical_devices", "medical_distribution", "medical_instruments_supplies", "metal_fabrication", "mortgage_finance", "oil_gas_drilling", "oil_gas_e_p", "oil_gas_equipment_services", "oil_gas_integrated", "oil_gas_midstream", "oil_gas_producers", "oil_gas_refining_marketing", "other_industrial_metals_mining", "other_precious_metals_mining", "packaged_foods", "packaging_containers", "paper_forestry", "paper_paper_products", "personal_services", "pharmaceuticals", "pharmaceutical_retailers", "pollution_treatment_controls", "precious_metals", "publishing", "railroads", "real_estate", "recreational_vehicles", "refiners_pipelines", "rental_leasing_services", "residential_construction", "resorts_casinos", "restaurants", "retailing", "scientific_technical_instruments", "security_protection_services", "semiconductor_equipment_materials", "semiconductors", "shell_companies", "silver", "software_and_services", "solar", "specialty_business_services", "specialty_chemicals", "specialty_industrial_machinery", "specialty_retail", "staffing_employment_services", "steel", "technology_hardware", "telecom_services", "textiles_apparel", "textile_manufacturing", "thermal_coal", "tobacco", "tools_accessories", "traders_distributors", "transportation", "transportation_infrastructure", "travel_services", "trucking", "uranium", "utilities", "waste_management" ] }, { "name": "mktcap_min", "type": "int", "description": "Filter by market cap greater than this value. Default is 500M.", "default": 500000000, "optional": true, "choices": null }, { "name": "mktcap_max", "type": "int", "description": "Filter by market cap less than this value.", "default": null, "optional": true, "choices": null }, { "name": "price_min", "type": "float", "description": "Filter by price greater than this value. Default is, 5", "default": 5, "optional": true, "choices": null }, { "name": "price_max", "type": "float", "description": "Filter by price less than this value.", "default": null, "optional": true, "choices": null }, { "name": "volume_min", "type": "int", "description": "Filter by volume greater than this value. Default is, 10K", "default": 10000, "optional": true, "choices": null }, { "name": "volume_max", "type": "int", "description": "Filter by volume less than this value.", "default": null, "optional": true, "choices": null }, { "name": "beta_min", "type": "float", "description": "Filter by a beta greater than this value.", "default": null, "optional": true, "choices": null }, { "name": "beta_max", "type": "float", "description": "Filter by a beta less than this value.", "default": null, "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "Limit the number of results returned. Default is, 200. Set to, 0, for all results.", "default": 200, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityScreener]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the company.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "market_cap", "type": "int", "description": "The market cap of ticker.", "default": null, "optional": true, "choices": null }, { "name": "sector", "type": "str", "description": "The sector the ticker belongs to.", "default": null, "optional": true, "choices": null }, { "name": "industry", "type": "str", "description": "The industry ticker belongs to.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "The current price.", "default": null, "optional": true, "choices": null }, { "name": "last_annual_dividend", "type": "float", "description": "The last annual amount dividend paid.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The current trading volume.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the asset trades on.", "default": null, "optional": true, "choices": null }, { "name": "exchange_name", "type": "str", "description": "The full name of the primary exchange.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The two-letter country abbreviation where the head office is located.", "default": null, "optional": true, "choices": null }, { "name": "is_etf", "type": "Literal[True, False]", "description": "Whether the ticker is an ETF.", "default": null, "optional": true, "choices": null }, { "name": "actively_trading", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "open", "type": "float", "description": "Open price for the day.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "High price for the day.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "Low price for the day.", "default": null, "optional": true, "choices": null }, { "name": "previous_close", "type": "float", "description": "Previous close price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "52-week low.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "Market Cap.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "float", "description": "Shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "book_value", "type": "float", "description": "Book value per share.", "default": null, "optional": true, "choices": null }, { "name": "price_to_book", "type": "float", "description": "Price to book ratio.", "default": null, "optional": true, "choices": null }, { "name": "eps_ttm", "type": "float", "description": "Earnings per share over the trailing twelve months.", "default": null, "optional": true, "choices": null }, { "name": "eps_forward", "type": "float", "description": "Forward earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe_forward", "type": "float", "description": "Forward price-to-earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "Trailing twelve month dividend yield.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "Exchange where the stock is listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "Timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "datetime", "description": "Most recent earnings date.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency of the price data.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityScreener", "openapi_extra": { "model": "EquityScreener" } }, "/equity/profile": { "deprecated": { "flag": null, "message": null }, "description": "Get general information about a company. This includes company name, industry, sector and price data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.profile(symbol='AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EquityInfo]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Common name of the company.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP identifier for the company.", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "International Securities Identification Number.", "default": null, "optional": true, "choices": null }, { "name": "lei", "type": "str", "description": "Legal Entity Identifier assigned to the company.", "default": null, "optional": true, "choices": null }, { "name": "legal_name", "type": "str", "description": "Official legal name of the company.", "default": null, "optional": true, "choices": null }, { "name": "stock_exchange", "type": "str", "description": "Stock exchange where the company is traded.", "default": null, "optional": true, "choices": null }, { "name": "sic", "type": "int", "description": "Standard Industrial Classification code for the company.", "default": null, "optional": true, "choices": null }, { "name": "short_description", "type": "str", "description": "Short description of the company.", "default": null, "optional": true, "choices": null }, { "name": "long_description", "type": "str", "description": "Long description of the company.", "default": null, "optional": true, "choices": null }, { "name": "ceo", "type": "str", "description": "Chief Executive Officer of the company.", "default": null, "optional": true, "choices": null }, { "name": "company_url", "type": "str", "description": "URL of the company's website.", "default": null, "optional": true, "choices": null }, { "name": "business_address", "type": "str", "description": "Address of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "mailing_address", "type": "str", "description": "Mailing address of the company.", "default": null, "optional": true, "choices": null }, { "name": "business_phone_no", "type": "str", "description": "Phone number of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_address1", "type": "str", "description": "Address of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_address2", "type": "str", "description": "Address of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_address_city", "type": "str", "description": "City of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_address_postal_code", "type": "str", "description": "Zip code of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_state", "type": "str", "description": "State of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "hq_country", "type": "str", "description": "Country of the company's headquarters.", "default": null, "optional": true, "choices": null }, { "name": "inc_state", "type": "str", "description": "State in which the company is incorporated.", "default": null, "optional": true, "choices": null }, { "name": "inc_country", "type": "str", "description": "Country in which the company is incorporated.", "default": null, "optional": true, "choices": null }, { "name": "employees", "type": "int", "description": "Number of employees working for the company.", "default": null, "optional": true, "choices": null }, { "name": "entity_legal_form", "type": "str", "description": "Legal form of the company.", "default": null, "optional": true, "choices": null }, { "name": "entity_status", "type": "str", "description": "Status of the company.", "default": null, "optional": true, "choices": null }, { "name": "latest_filing_date", "type": "date", "description": "Date of the company's latest filing.", "default": null, "optional": true, "choices": null }, { "name": "irs_number", "type": "str", "description": "IRS number assigned to the company.", "default": null, "optional": true, "choices": null }, { "name": "sector", "type": "str", "description": "Sector in which the company operates.", "default": null, "optional": true, "choices": null }, { "name": "industry_category", "type": "str", "description": "Category of industry in which the company operates.", "default": null, "optional": true, "choices": null }, { "name": "industry_group", "type": "str", "description": "Group of industry in which the company operates.", "default": null, "optional": true, "choices": null }, { "name": "template", "type": "str", "description": "Template used to standardize the company's financial statements.", "default": null, "optional": true, "choices": null }, { "name": "standardized_active", "type": "bool", "description": "Whether the company is active or not.", "default": null, "optional": true, "choices": null }, { "name": "first_fundamental_date", "type": "date", "description": "Date of the company's first fundamental.", "default": null, "optional": true, "choices": null }, { "name": "last_fundamental_date", "type": "date", "description": "Date of the company's last fundamental.", "default": null, "optional": true, "choices": null }, { "name": "first_stock_price_date", "type": "date", "description": "Date of the company's first stock price.", "default": null, "optional": true, "choices": null }, { "name": "last_stock_price_date", "type": "date", "description": "Date of the company's last stock price.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "is_etf", "type": "bool", "description": "If the symbol is an ETF.", "default": "", "optional": false, "choices": null }, { "name": "is_actively_trading", "type": "bool", "description": "If the company is actively trading.", "default": "", "optional": false, "choices": null }, { "name": "is_adr", "type": "bool", "description": "If the stock is an ADR.", "default": "", "optional": false, "choices": null }, { "name": "is_fund", "type": "bool", "description": "If the company is a fund.", "default": "", "optional": false, "choices": null }, { "name": "image", "type": "str", "description": "Image of the company.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency in which the stock is traded.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "int", "description": "Market capitalization of the company.", "default": null, "optional": true, "choices": null }, { "name": "last_price", "type": "float", "description": "The last traded price.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The one-year high of the price.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The one-year low of the price.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily trading volume.", "default": null, "optional": true, "choices": null }, { "name": "annualized_dividend_amount", "type": "float", "description": "The annualized dividend payment based on the most recent regular dividend payment.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "Beta of the stock relative to the market.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "id", "type": "str", "description": "Intrinio ID for the company.", "default": null, "optional": true, "choices": null }, { "name": "thea_enabled", "type": "bool", "description": "Whether the company has been enabled for Thea.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "exchange_timezone", "type": "str", "description": "The timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "issue_type", "type": "str", "description": "The issuance type of the asset.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the asset is traded.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "int", "description": "The market capitalization of the asset.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "The number of listed shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "shares_float", "type": "int", "description": "The number of shares in the public float.", "default": null, "optional": true, "choices": null }, { "name": "shares_implied_outstanding", "type": "int", "description": "Implied shares outstanding of common equityassuming the conversion of all convertible subsidiary equity into common.", "default": null, "optional": true, "choices": null }, { "name": "shares_short", "type": "int", "description": "The reported number of shares short.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "The dividend yield of the asset, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the asset relative to the broad market.", "default": null, "optional": true, "choices": null } ] }, "model": "EquityInfo", "openapi_extra": { "model": "EquityInfo" } }, "/equity/market_snapshots": { "deprecated": { "flag": null, "message": null }, "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.market_snapshots(provider='fmp')\n```\n\n", "parameters": { "standard": [], "fmp": [ { "name": "market", "type": "Literal['amex', 'ams', 'ase', 'asx', 'ath', 'bme', 'bru', 'bud', 'bue', 'cai', 'cnq', 'cph', 'dfm', 'doh', 'etf', 'euronext', 'hel', 'hkse', 'ice', 'iob', 'ist', 'jkt', 'jnb', 'jpx', 'kls', 'koe', 'ksc', 'kuw', 'lse', 'mex', 'mutual_fund', 'nasdaq', 'neo', 'nse', 'nyse', 'nze', 'osl', 'otc', 'pnk', 'pra', 'ris', 'sao', 'sau', 'set', 'sgo', 'shh', 'shz', 'six', 'sto', 'tai', 'tlv', 'tsx', 'two', 'vie', 'wse', 'xetra']", "description": "The market to fetch data for.", "default": "nasdaq", "optional": true, "choices": [ "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" ] } ], "intrinio": [ { "name": "date", "type": "Union[Union[date, datetime, str], str]", "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400'", "default": null, "optional": true, "choices": null } ], "polygon": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[MarketSnapshots]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": null, "optional": true, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous close price.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "The change in price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "The change in price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "last_price", "type": "float", "description": "The last price of the stock.", "default": null, "optional": true, "choices": null }, { "name": "last_price_timestamp", "type": "Union[date, datetime]", "description": "The timestamp of the last price.", "default": null, "optional": true, "choices": null }, { "name": "ma50", "type": "float", "description": "The 50-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "ma200", "type": "float", "description": "The 200-day moving average.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg", "type": "int", "description": "Average daily trading volume.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "int", "description": "Market cap of the stock.", "default": null, "optional": true, "choices": null }, { "name": "eps", "type": "float", "description": "Earnings per share.", "default": null, "optional": true, "choices": null }, { "name": "pe", "type": "float", "description": "Price to earnings ratio.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "Number of shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "The company name associated with the symbol.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange of the stock.", "default": null, "optional": true, "choices": null }, { "name": "earnings_date", "type": "Union[date, datetime]", "description": "The upcoming earnings announcement date.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "last_price", "type": "float", "description": "The last trade price.", "default": null, "optional": true, "choices": null }, { "name": "last_size", "type": "int", "description": "The last trade size.", "default": null, "optional": true, "choices": null }, { "name": "last_volume", "type": "int", "description": "The last trade volume.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_timestamp", "type": "datetime", "description": "The timestamp of the last trade.", "default": null, "optional": true, "choices": null }, { "name": "bid_size", "type": "int", "description": "The size of the last bid price. Bid price and size is not always available.", "default": null, "optional": true, "choices": null }, { "name": "bid_price", "type": "float", "description": "The last bid price. Bid price and size is not always available.", "default": null, "optional": true, "choices": null }, { "name": "ask_price", "type": "float", "description": "The last ask price. Ask price and size is not always available.", "default": null, "optional": true, "choices": null }, { "name": "ask_size", "type": "int", "description": "The size of the last ask price. Ask price and size is not always available.", "default": null, "optional": true, "choices": null }, { "name": "last_bid_timestamp", "type": "datetime", "description": "The timestamp of the last bid price. Bid price and size is not always available.", "default": null, "optional": true, "choices": null }, { "name": "last_ask_timestamp", "type": "datetime", "description": "The timestamp of the last ask price. Ask price and size is not always available.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "vwap", "type": "float", "description": "The volume weighted average price of the stock on the current trading day.", "default": null, "optional": true, "choices": null }, { "name": "prev_open", "type": "float", "description": "The previous trading session opening price.", "default": null, "optional": true, "choices": null }, { "name": "prev_high", "type": "float", "description": "The previous trading session high price.", "default": null, "optional": true, "choices": null }, { "name": "prev_low", "type": "float", "description": "The previous trading session low price.", "default": null, "optional": true, "choices": null }, { "name": "prev_volume", "type": "float", "description": "The previous trading session volume.", "default": null, "optional": true, "choices": null }, { "name": "prev_vwap", "type": "float", "description": "The previous trading session VWAP.", "default": null, "optional": true, "choices": null }, { "name": "last_updated", "type": "datetime", "description": "The last time the data was updated.", "default": "", "optional": false, "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, "optional": true, "choices": null }, { "name": "bid_size", "type": "int", "description": "The current bid size.", "default": null, "optional": true, "choices": null }, { "name": "ask_size", "type": "int", "description": "The current ask size.", "default": null, "optional": true, "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, "optional": true, "choices": null }, { "name": "quote_timestamp", "type": "datetime", "description": "The timestamp of the last quote.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_price", "type": "float", "description": "The last trade price.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_size", "type": "int", "description": "The last trade size.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_conditions", "type": "list[int]", "description": "The last trade condition codes.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_exchange", "type": "int", "description": "The last trade exchange ID code.", "default": null, "optional": true, "choices": null }, { "name": "last_trade_timestamp", "type": "datetime", "description": "The last trade timestamp.", "default": null, "optional": true, "choices": null } ] }, "model": "MarketSnapshots", "openapi_extra": { "model": "MarketSnapshots" } }, "/equity/historical_market_cap": { "deprecated": { "flag": null, "message": null }, "description": "Get the historical market cap of a ticker symbol.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.equity.historical_market_cap(provider='fmp', symbol='AAPL')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "fmp": [], "intrinio": [ { "name": "interval", "type": "Literal['day', 'week', 'month', 'quarter', 'year']", "description": "None", "default": "day", "optional": true, "choices": [ "day", "week", "month", "quarter", "year" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HistoricalMarketCap]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "market_cap", "type": "Union[int, float]", "description": "Market capitalization of the security.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [] }, "model": "HistoricalMarketCap", "openapi_extra": { "model": "HistoricalMarketCap" } }, "/etf/search": { "deprecated": { "flag": null, "message": null }, "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# An empty query returns the full list of ETFs from the provider.\nobb.etf.search(provider='fmp')\n# The query will return results from text-based fields containing the term.\nobb.etf.search(query='commercial real estate', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null } ], "fmp": [ { "name": "exchange", "type": "Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']", "description": "The exchange code the ETF trades on.", "default": null, "optional": true, "choices": [ "AMEX", "NYSE", "NASDAQ", "ETF", "TSX", "EURONEXT" ] }, { "name": "is_active", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "exchange", "type": "Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']", "description": "Target a specific exchange by providing the MIC code.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.(ETF)", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "market_cap", "type": "float", "description": "The market cap of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "sector", "type": "str", "description": "The sector of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "industry", "type": "str", "description": "The industry of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "The beta of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "price", "type": "float", "description": "The current price of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "last_annual_dividend", "type": "float", "description": "The last annual dividend paid.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The current trading volume of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange code the ETF trades on.", "default": null, "optional": true, "choices": null }, { "name": "exchange_name", "type": "str", "description": "The full name of the exchange the ETF trades on.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country the ETF is registered in.", "default": null, "optional": true, "choices": null }, { "name": "actively_trading", "type": "Literal[True, False]", "description": "Whether the ETF is actively trading.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "exchange", "type": "str", "description": "The exchange MIC code.", "default": null, "optional": true, "choices": null }, { "name": "figi_ticker", "type": "str", "description": "The OpenFIGI ticker.", "default": null, "optional": true, "choices": null }, { "name": "ric", "type": "str", "description": "The Reuters Instrument Code.", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The International Securities Identification Number.", "default": null, "optional": true, "choices": null }, { "name": "sedol", "type": "str", "description": "The Stock Exchange Daily Official list.", "default": null, "optional": true, "choices": null }, { "name": "intrinio_id", "type": "str", "description": "The unique Intrinio ID for the security.", "default": null, "optional": true, "choices": null } ] }, "model": "EtfSearch", "openapi_extra": { "model": "EtfSearch" } }, "/etf/historical": { "deprecated": { "flag": null, "message": null }, "description": "ETF Historical Market Price.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.historical(symbol='SPY', provider='fmp')\nobb.etf.historical(symbol='SPY', provider='yfinance')\n# This function accepts multiple tickers.\nobb.etf.historical(symbol='SPY,IWM,QQQ,DJIA', provider='yfinance')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "fmp": [ { "name": "interval", "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ] } ], "intrinio": [ { "name": "symbol", "type": "str", "description": "A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID).", "default": "", "optional": false, "choices": null }, { "name": "interval", "type": "Literal['1m', '5m', '10m', '15m', '30m', '60m', '1h', '1d', '1W', '1M', '1Q', '1Y']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "10m", "15m", "30m", "60m", "1h", "1d", "1W", "1M", "1Q", "1Y" ] }, { "name": "start_time", "type": "datetime.time", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true, "choices": null }, { "name": "end_time", "type": "datetime.time", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'.", "default": null, "optional": true, "choices": null }, { "name": "timezone", "type": "str", "description": "Timezone of the data, in the IANA format (Continent/City).", "default": "America/New_York", "optional": true, "choices": null }, { "name": "source", "type": "Literal['realtime', 'delayed', 'nasdaq_basic']", "description": "The source of the data.", "default": "realtime", "optional": true, "choices": null } ], "polygon": [ { "name": "interval", "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", "optional": true, "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'unadjusted']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", "optional": true, "choices": null }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, "optional": true, "choices": null } ], "tiingo": [ { "name": "interval", "type": "Union[Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '1W', '1M', '1Y'], str]", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "90m", "1h", "2h", "4h", "1d", "1W", "1M", "1Y" ] } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1W", "1M", "1Q" ] }, { "name": "extended_hours", "type": "bool", "description": "Include Pre and Post market data.", "default": false, "optional": true, "choices": null }, { "name": "include_actions", "type": "bool", "description": "Include dividends and stock splits in results.", "default": true, "optional": true, "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor to apply. Default is splits only.", "default": "splits_only", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[Union[date, datetime], str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "float", "description": "The open price.", "default": "", "optional": false, "choices": null }, { "name": "high", "type": "float", "description": "The high price.", "default": "", "optional": false, "choices": null }, { "name": "low", "type": "float", "description": "The low price.", "default": "", "optional": false, "choices": null }, { "name": "close", "type": "float", "description": "The close price.", "default": "", "optional": false, "choices": null }, { "name": "volume", "type": "Union[int, float]", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "unadjusted_volume", "type": "float", "description": "Unadjusted volume of the symbol.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "average", "type": "float", "description": "Average trade price of an individual equity during the interval.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price of the symbol from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Percent change in the price of the symbol from the previous day.", "default": null, "optional": true, "choices": null }, { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, "optional": true, "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, "optional": true, "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, "optional": true, "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, "optional": true, "choices": null }, { "name": "fifty_two_week_high", "type": "float", "description": "52 week high price for the symbol.", "default": null, "optional": true, "choices": null }, { "name": "fifty_two_week_low", "type": "float", "description": "52 week low price for the symbol.", "default": null, "optional": true, "choices": null }, { "name": "factor", "type": "float", "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true, "choices": null }, { "name": "close_time", "type": "datetime", "description": "The timestamp that represents the end of the interval span.", "default": null, "optional": true, "choices": null }, { "name": "interval", "type": "str", "description": "The data time frequency.", "default": null, "optional": true, "choices": null }, { "name": "intra_period", "type": "bool", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "transactions", "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null } ], "tiingo": [ { "name": "adj_open", "type": "float", "description": "The adjusted open price.", "default": null, "optional": true, "choices": null }, { "name": "adj_high", "type": "float", "description": "The adjusted high price.", "default": null, "optional": true, "choices": null }, { "name": "adj_low", "type": "float", "description": "The adjusted low price.", "default": null, "optional": true, "choices": null }, { "name": "adj_close", "type": "float", "description": "The adjusted close price.", "default": null, "optional": true, "choices": null }, { "name": "adj_volume", "type": "float", "description": "The adjusted volume.", "default": null, "optional": true, "choices": null }, { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount, if a dividend was paid.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "split_ratio", "type": "float", "description": "Ratio of the equity split, if a split occurred.", "default": null, "optional": true, "choices": null }, { "name": "dividend", "type": "float", "description": "Dividend amount (split-adjusted), if a dividend was paid.", "default": null, "optional": true, "choices": null } ] }, "model": "EtfHistorical", "openapi_extra": { "model": "EtfHistorical" } }, "/etf/info": { "deprecated": { "flag": null, "message": null }, "description": "ETF Information Overview.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.info(symbol='SPY', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.info(symbol='SPY,IWM,QQQ,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfInfo]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data. (ETF)", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF.", "default": "", "optional": false, "choices": null }, { "name": "description", "type": "str", "description": "Description of the fund.", "default": null, "optional": true, "choices": null }, { "name": "inception_date", "type": "str", "description": "Inception date of the ETF.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "issuer", "type": "str", "description": "Company of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "CUSIP of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "ISIN of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "domicile", "type": "str", "description": "Domicile of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "asset_class", "type": "str", "description": "Asset class of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "aum", "type": "float", "description": "Assets under management.", "default": null, "optional": true, "choices": null }, { "name": "nav", "type": "float", "description": "Net asset value of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "nav_currency", "type": "str", "description": "Currency of the ETF's net asset value.", "default": null, "optional": true, "choices": null }, { "name": "expense_ratio", "type": "float", "description": "The expense ratio, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "holdings_count", "type": "int", "description": "Number of holdings.", "default": null, "optional": true, "choices": null }, { "name": "avg_volume", "type": "float", "description": "Average daily trading volume.", "default": null, "optional": true, "choices": null }, { "name": "website", "type": "str", "description": "Website of the issuer.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "fund_listing_date", "type": "date", "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.", "default": null, "optional": true, "choices": null }, { "name": "data_change_date", "type": "date", "description": "The last date on which there was a change in a classifications data field for this ETF.", "default": null, "optional": true, "choices": null }, { "name": "etn_maturity_date", "type": "date", "description": "If the product is an ETN, this field identifies the maturity date for the ETN.", "default": null, "optional": true, "choices": null }, { "name": "is_listed", "type": "bool", "description": "If true, the ETF is still listed on an exchange.", "default": null, "optional": true, "choices": null }, { "name": "close_date", "type": "date", "description": "The date on which the ETF was de-listed if it is no longer listed.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange Market Identifier Code (MIC).", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "International Securities Identification Number (ISIN).", "default": null, "optional": true, "choices": null }, { "name": "ric", "type": "str", "description": "Reuters Instrument Code (RIC).", "default": null, "optional": true, "choices": null }, { "name": "sedol", "type": "str", "description": "Stock Exchange Daily Official list (SEDOL).", "default": null, "optional": true, "choices": null }, { "name": "figi_symbol", "type": "str", "description": "Financial Instrument Global Identifier (FIGI) symbol.", "default": null, "optional": true, "choices": null }, { "name": "share_class_figi", "type": "str", "description": "Financial Instrument Global Identifier (FIGI).", "default": null, "optional": true, "choices": null }, { "name": "firstbridge_id", "type": "str", "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF).", "default": null, "optional": true, "choices": null }, { "name": "firstbridge_parent_id", "type": "str", "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.", "default": null, "optional": true, "choices": null }, { "name": "intrinio_id", "type": "str", "description": "Intrinio unique identifier for the security.", "default": null, "optional": true, "choices": null }, { "name": "intraday_nav_symbol", "type": "str", "description": "Intraday Net Asset Value (NAV) symbol.", "default": null, "optional": true, "choices": null }, { "name": "primary_symbol", "type": "str", "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.", "default": null, "optional": true, "choices": null }, { "name": "etp_structure_type", "type": "str", "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.", "default": null, "optional": true, "choices": null }, { "name": "legal_structure", "type": "str", "description": "Legal structure of the fund.", "default": null, "optional": true, "choices": null }, { "name": "issuer", "type": "str", "description": "Issuer of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "etn_issuing_bank", "type": "str", "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.", "default": null, "optional": true, "choices": null }, { "name": "fund_family", "type": "str", "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.", "default": null, "optional": true, "choices": null }, { "name": "investment_style", "type": "str", "description": "Investment style of the ETF.", "default": null, "optional": true, "choices": null }, { "name": "derivatives_based", "type": "str", "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.", "default": null, "optional": true, "choices": null }, { "name": "income_category", "type": "str", "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income", "default": null, "optional": true, "choices": null }, { "name": "asset_class", "type": "str", "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).", "default": null, "optional": true, "choices": null }, { "name": "other_asset_types", "type": "str", "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.", "default": null, "optional": true, "choices": null }, { "name": "single_category_designation", "type": "str", "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.", "default": null, "optional": true, "choices": null }, { "name": "beta_type", "type": "str", "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.", "default": null, "optional": true, "choices": null }, { "name": "beta_details", "type": "str", "description": "This field provides further detail within the traditional and smart beta categories.", "default": null, "optional": true, "choices": null }, { "name": "market_cap_range", "type": "str", "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)", "default": null, "optional": true, "choices": null }, { "name": "market_cap_weighting_type", "type": "str", "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.", "default": null, "optional": true, "choices": null }, { "name": "index_weighting_scheme", "type": "str", "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type.", "default": null, "optional": true, "choices": null }, { "name": "index_linked", "type": "str", "description": "This field identifies whether an ETF is index linked or active.", "default": null, "optional": true, "choices": null }, { "name": "index_name", "type": "str", "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable.", "default": null, "optional": true, "choices": null }, { "name": "index_symbol", "type": "str", "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF.", "default": null, "optional": true, "choices": null }, { "name": "parent_index", "type": "str", "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.", "default": null, "optional": true, "choices": null }, { "name": "index_family", "type": "str", "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.", "default": null, "optional": true, "choices": null }, { "name": "broader_index_family", "type": "str", "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.", "default": null, "optional": true, "choices": null }, { "name": "index_provider", "type": "str", "description": "This field identifies the Index provider for the index underlying the ETF, if applicable.", "default": null, "optional": true, "choices": null }, { "name": "index_provider_code", "type": "str", "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.", "default": null, "optional": true, "choices": null }, { "name": "replication_structure", "type": "str", "description": "The replication structure of the Exchange Traded Product (ETP).", "default": null, "optional": true, "choices": null }, { "name": "growth_value_tilt", "type": "str", "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.", "default": null, "optional": true, "choices": null }, { "name": "growth_type", "type": "str", "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.", "default": null, "optional": true, "choices": null }, { "name": "value_type", "type": "str", "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.", "default": null, "optional": true, "choices": null }, { "name": "sector", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.", "default": null, "optional": true, "choices": null }, { "name": "industry", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.", "default": null, "optional": true, "choices": null }, { "name": "industry_group", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.", "default": null, "optional": true, "choices": null }, { "name": "cross_sector_theme", "type": "str", "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)", "default": null, "optional": true, "choices": null }, { "name": "natural_resources_type", "type": "str", "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.", "default": null, "optional": true, "choices": null }, { "name": "us_or_excludes_us", "type": "str", "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.", "default": null, "optional": true, "choices": null }, { "name": "developed_emerging", "type": "str", "description": "This field identifies the stage of development of the markets that the ETF provides exposure to.", "default": null, "optional": true, "choices": null }, { "name": "specialized_region", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)", "default": null, "optional": true, "choices": null }, { "name": "continent", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.", "default": null, "optional": true, "choices": null }, { "name": "latin_america_sub_group", "type": "str", "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true, "choices": null }, { "name": "europe_sub_group", "type": "str", "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true, "choices": null }, { "name": "asia_sub_group", "type": "str", "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.", "default": null, "optional": true, "choices": null }, { "name": "specific_country", "type": "str", "description": "This field is populated if the ETF provides targeted exposure to a specific country.", "default": null, "optional": true, "choices": null }, { "name": "china_listing_location", "type": "str", "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.", "default": null, "optional": true, "choices": null }, { "name": "us_state", "type": "str", "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.", "default": null, "optional": true, "choices": null }, { "name": "real_estate", "type": "str", "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.", "default": null, "optional": true, "choices": null }, { "name": "fundamental_weighting_type", "type": "str", "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.", "default": null, "optional": true, "choices": null }, { "name": "dividend_weighting_type", "type": "str", "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.", "default": null, "optional": true, "choices": null }, { "name": "bond_type", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.", "default": null, "optional": true, "choices": null }, { "name": "government_bond_types", "type": "str", "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.", "default": null, "optional": true, "choices": null }, { "name": "municipal_bond_region", "type": "str", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.", "default": null, "optional": true, "choices": null }, { "name": "municipal_vrdo", "type": "bool", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.", "default": null, "optional": true, "choices": null }, { "name": "mortgage_bond_types", "type": "str", "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.", "default": null, "optional": true, "choices": null }, { "name": "bond_tax_status", "type": "str", "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.", "default": null, "optional": true, "choices": null }, { "name": "credit_quality", "type": "str", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.", "default": null, "optional": true, "choices": null }, { "name": "average_maturity", "type": "str", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.", "default": null, "optional": true, "choices": null }, { "name": "specific_maturity_year", "type": "int", "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.", "default": null, "optional": true, "choices": null }, { "name": "commodity_types", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true, "choices": null }, { "name": "energy_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.", "default": null, "optional": true, "choices": null }, { "name": "agricultural_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.", "default": null, "optional": true, "choices": null }, { "name": "livestock_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.", "default": null, "optional": true, "choices": null }, { "name": "metal_type", "type": "str", "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.", "default": null, "optional": true, "choices": null }, { "name": "inverse_leveraged", "type": "str", "description": "This field is populated if the ETF provides inverse or leveraged exposure.", "default": null, "optional": true, "choices": null }, { "name": "target_date_multi_asset_type", "type": "str", "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.", "default": null, "optional": true, "choices": null }, { "name": "currency_pair", "type": "str", "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.", "default": null, "optional": true, "choices": null }, { "name": "social_environmental_type", "type": "str", "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.", "default": null, "optional": true, "choices": null }, { "name": "clean_energy_type", "type": "str", "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.", "default": null, "optional": true, "choices": null }, { "name": "dividend_type", "type": "str", "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.", "default": null, "optional": true, "choices": null }, { "name": "regular_dividend_payor_type", "type": "str", "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.", "default": null, "optional": true, "choices": null }, { "name": "quant_strategies_type", "type": "str", "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.", "default": null, "optional": true, "choices": null }, { "name": "other_quant_models", "type": "str", "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.", "default": null, "optional": true, "choices": null }, { "name": "hedge_fund_type", "type": "str", "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.", "default": null, "optional": true, "choices": null }, { "name": "excludes_financials", "type": "bool", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.", "default": null, "optional": true, "choices": null }, { "name": "excludes_technology", "type": "bool", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.", "default": null, "optional": true, "choices": null }, { "name": "holds_only_nyse_stocks", "type": "bool", "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE.", "default": null, "optional": true, "choices": null }, { "name": "holds_only_nasdaq_stocks", "type": "bool", "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.", "default": null, "optional": true, "choices": null }, { "name": "holds_mlp", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.", "default": null, "optional": true, "choices": null }, { "name": "holds_preferred_stock", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.", "default": null, "optional": true, "choices": null }, { "name": "holds_closed_end_funds", "type": "bool", "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.", "default": null, "optional": true, "choices": null }, { "name": "holds_adr", "type": "bool", "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.", "default": null, "optional": true, "choices": null }, { "name": "laddered", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.", "default": null, "optional": true, "choices": null }, { "name": "zero_coupon", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.", "default": null, "optional": true, "choices": null }, { "name": "floating_rate", "type": "bool", "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.", "default": null, "optional": true, "choices": null }, { "name": "build_america_bonds", "type": "bool", "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.", "default": null, "optional": true, "choices": null }, { "name": "dynamic_futures_roll", "type": "bool", "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.", "default": null, "optional": true, "choices": null }, { "name": "currency_hedged", "type": "bool", "description": "This field is populated if the ETF's strategy involves hedging currency exposure.", "default": null, "optional": true, "choices": null }, { "name": "includes_short_exposure", "type": "bool", "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.", "default": null, "optional": true, "choices": null }, { "name": "ucits", "type": "bool", "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant", "default": null, "optional": true, "choices": null }, { "name": "registered_countries", "type": "str", "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.", "default": null, "optional": true, "choices": null }, { "name": "issuer_country", "type": "str", "description": "2 letter ISO country code for the country where the issuer is located.", "default": null, "optional": true, "choices": null }, { "name": "domicile", "type": "str", "description": "2 letter ISO country code for the country where the ETP is domiciled.", "default": null, "optional": true, "choices": null }, { "name": "listing_country", "type": "str", "description": "2 letter ISO country code for the country of the primary listing.", "default": null, "optional": true, "choices": null }, { "name": "listing_region", "type": "str", "description": "Geographic region in the country of the primary listing falls.", "default": null, "optional": true, "choices": null }, { "name": "bond_currency_denomination", "type": "str", "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.", "default": null, "optional": true, "choices": null }, { "name": "base_currency", "type": "str", "description": "Base currency in which NAV is reported.", "default": null, "optional": true, "choices": null }, { "name": "listing_currency", "type": "str", "description": "listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.", "default": null, "optional": true, "choices": null }, { "name": "number_of_holdings", "type": "int", "description": "The number of holdings in the ETF.", "default": null, "optional": true, "choices": null }, { "name": "month_end_assets", "type": "float", "description": "Net assets in millions of dollars as of the most recent month end.", "default": null, "optional": true, "choices": null }, { "name": "net_expense_ratio", "type": "float", "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", "default": null, "optional": true, "choices": null }, { "name": "etf_portfolio_turnover", "type": "float", "description": "The percentage of positions turned over in the last 12 months.", "default": null, "optional": true, "choices": null } ], "yfinance": [ { "name": "fund_type", "type": "str", "description": "The legal type of fund.", "default": null, "optional": true, "choices": null }, { "name": "fund_family", "type": "str", "description": "The fund family.", "default": null, "optional": true, "choices": null }, { "name": "category", "type": "str", "description": "The fund category.", "default": null, "optional": true, "choices": null }, { "name": "exchange", "type": "str", "description": "The exchange the fund is listed on.", "default": null, "optional": true, "choices": null }, { "name": "exchange_timezone", "type": "str", "description": "The timezone of the exchange.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "The currency in which the fund is listed.", "default": null, "optional": true, "choices": null }, { "name": "nav_price", "type": "float", "description": "The net asset value per unit of the fund.", "default": null, "optional": true, "choices": null }, { "name": "total_assets", "type": "int", "description": "The total value of assets held by the fund.", "default": null, "optional": true, "choices": null }, { "name": "trailing_pe", "type": "float", "description": "The trailing twelve month P/E ratio of the fund's assets.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield", "type": "float", "description": "The dividend yield of the fund, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "dividend_rate_ttm", "type": "float", "description": "The trailing twelve month annual dividend rate of the fund, in currency units.", "default": null, "optional": true, "choices": null }, { "name": "dividend_yield_ttm", "type": "float", "description": "The trailing twelve month annual dividend yield of the fund, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The fifty-two week high price.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The fifty-two week low price.", "default": null, "optional": true, "choices": null }, { "name": "ma_50d", "type": "float", "description": "50-day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "ma_200d", "type": "float", "description": "200-day moving average price.", "default": null, "optional": true, "choices": null }, { "name": "return_ytd", "type": "float", "description": "The year-to-date return of the fund, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_3y_avg", "type": "float", "description": "The three year average return of the fund, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "return_5y_avg", "type": "float", "description": "The five year average return of the fund, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "beta_3y_avg", "type": "float", "description": "The three year average beta of the fund.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg", "type": "float", "description": "The average daily trading volume of the fund.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg_10d", "type": "float", "description": "The average daily trading volume of the fund over the past ten days.", "default": null, "optional": true, "choices": null }, { "name": "bid", "type": "float", "description": "The current bid price.", "default": null, "optional": true, "choices": null }, { "name": "bid_size", "type": "float", "description": "The current bid size.", "default": null, "optional": true, "choices": null }, { "name": "ask", "type": "float", "description": "The current ask price.", "default": null, "optional": true, "choices": null }, { "name": "ask_size", "type": "float", "description": "The current ask size.", "default": null, "optional": true, "choices": null }, { "name": "open", "type": "float", "description": "The open price of the most recent trading session.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "float", "description": "The highest price of the most recent trading session.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "float", "description": "The lowest price of the most recent trading session.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume of the most recent trading session.", "default": null, "optional": true, "choices": null }, { "name": "prev_close", "type": "float", "description": "The previous closing price.", "default": null, "optional": true, "choices": null } ] }, "model": "EtfInfo", "openapi_extra": { "model": "EtfInfo" } }, "/etf/sectors": { "deprecated": { "flag": null, "message": null }, "description": "ETF Sector weighting.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.sectors(symbol='SPY', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfSectors]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "sector", "type": "str", "description": "Sector of exposure.", "default": "", "optional": false, "choices": null }, { "name": "weight", "type": "float", "description": "Exposure of the ETF to the sector in normalized percentage points.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "EtfSectors", "openapi_extra": { "model": "EtfSectors" } }, "/etf/countries": { "deprecated": { "flag": null, "message": null }, "description": "ETF Country weighting.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.countries(symbol='VT', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfCountries]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "country", "type": "str", "description": "The country of the exposure. Corresponding values are normalized percentage points.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "EtfCountries", "openapi_extra": { "model": "EtfCountries" } }, "/etf/price_performance": { "deprecated": { "flag": null, "message": null }, "description": "Price performance as a return, over different periods.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.price_performance(symbol='QQQ', provider='fmp')\nobb.etf.price_performance(symbol='SPY,QQQ,IWM,DJIA', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "default": "", "optional": false, "choices": null } ], "fmp": [], "intrinio": [ { "name": "return_type", "type": "Literal['trailing', 'calendar']", "description": "The type of returns to return, a trailing or calendar window.", "default": "trailing", "optional": true, "choices": null }, { "name": "adjustment", "type": "Literal['splits_only', 'splits_and_dividends']", "description": "The adjustment factor, 'splits_only' will return pure price performance.", "default": "splits_and_dividends", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfPricePerformance]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "one_day", "type": "float", "description": "One-day return.", "default": null, "optional": true, "choices": null }, { "name": "wtd", "type": "float", "description": "Week to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_week", "type": "float", "description": "One-week return.", "default": null, "optional": true, "choices": null }, { "name": "mtd", "type": "float", "description": "Month to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_month", "type": "float", "description": "One-month return.", "default": null, "optional": true, "choices": null }, { "name": "qtd", "type": "float", "description": "Quarter to date return.", "default": null, "optional": true, "choices": null }, { "name": "three_month", "type": "float", "description": "Three-month return.", "default": null, "optional": true, "choices": null }, { "name": "six_month", "type": "float", "description": "Six-month return.", "default": null, "optional": true, "choices": null }, { "name": "ytd", "type": "float", "description": "Year to date return.", "default": null, "optional": true, "choices": null }, { "name": "one_year", "type": "float", "description": "One-year return.", "default": null, "optional": true, "choices": null }, { "name": "two_year", "type": "float", "description": "Two-year return.", "default": null, "optional": true, "choices": null }, { "name": "three_year", "type": "float", "description": "Three-year return.", "default": null, "optional": true, "choices": null }, { "name": "four_year", "type": "float", "description": "Four-year", "default": null, "optional": true, "choices": null }, { "name": "five_year", "type": "float", "description": "Five-year return.", "default": null, "optional": true, "choices": null }, { "name": "ten_year", "type": "float", "description": "Ten-year return.", "default": null, "optional": true, "choices": null }, { "name": "max", "type": "float", "description": "Return from the beginning of the time series.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "symbol", "type": "str", "description": "The ticker symbol.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "max_annualized", "type": "float", "description": "Annualized rate of return from inception.", "default": null, "optional": true, "choices": null }, { "name": "volatility_one_year", "type": "float", "description": "Trailing one-year annualized volatility.", "default": null, "optional": true, "choices": null }, { "name": "volatility_three_year", "type": "float", "description": "Trailing three-year annualized volatility.", "default": null, "optional": true, "choices": null }, { "name": "volatility_five_year", "type": "float", "description": "Trailing five-year annualized volatility.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg_30", "type": "float", "description": "The one-month average daily volume.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg_90", "type": "float", "description": "The three-month average daily volume.", "default": null, "optional": true, "choices": null }, { "name": "volume_avg_180", "type": "float", "description": "The six-month average daily volume.", "default": null, "optional": true, "choices": null }, { "name": "beta", "type": "float", "description": "Beta compared to the S&P 500.", "default": null, "optional": true, "choices": null }, { "name": "nav", "type": "float", "description": "Net asset value per share.", "default": null, "optional": true, "choices": null }, { "name": "year_high", "type": "float", "description": "The 52-week high price.", "default": null, "optional": true, "choices": null }, { "name": "year_low", "type": "float", "description": "The 52-week low price.", "default": null, "optional": true, "choices": null }, { "name": "market_cap", "type": "float", "description": "The market capitalization.", "default": null, "optional": true, "choices": null }, { "name": "shares_outstanding", "type": "int", "description": "The number of shares outstanding.", "default": null, "optional": true, "choices": null }, { "name": "updated", "type": "date", "description": "The date of the data.", "default": null, "optional": true, "choices": null } ] }, "model": "EtfPricePerformance", "openapi_extra": { "model": "EtfPricePerformance" } }, "/etf/holdings": { "deprecated": { "flag": null, "message": null }, "description": "Get the holdings for an individual ETF.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings(symbol='XLK', provider='fmp')\n# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')\n# The same data can be returned from the SEC directly.\nobb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "date", "type": "Union[Union[date, str], str]", "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "str", "description": "The CIK of the filing entity. Overrides symbol.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null } ], "sec": [ { "name": "date", "type": "Union[Union[date, str], str]", "description": "A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.", "default": null, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache for the request.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfHoldings]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data. (ETF)", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the ETF holding.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "lei", "type": "str", "description": "The LEI of the holding.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "The title of the holding.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the holding.", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the holding.", "default": null, "optional": true, "choices": null }, { "name": "balance", "type": "int", "description": "The balance of the holding, in shares or units.", "default": null, "optional": true, "choices": null }, { "name": "units", "type": "Union[str, float]", "description": "The type of units.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "The currency of the holding.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The value of the holding, in dollars.", "default": null, "optional": true, "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "payoff_profile", "type": "str", "description": "The payoff profile of the holding.", "default": null, "optional": true, "choices": null }, { "name": "asset_category", "type": "str", "description": "The asset category of the holding.", "default": null, "optional": true, "choices": null }, { "name": "issuer_category", "type": "str", "description": "The issuer category of the holding.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country of the holding.", "default": null, "optional": true, "choices": null }, { "name": "is_restricted", "type": "str", "description": "Whether the holding is restricted.", "default": null, "optional": true, "choices": null }, { "name": "fair_value_level", "type": "int", "description": "The fair value level of the holding.", "default": null, "optional": true, "choices": null }, { "name": "is_cash_collateral", "type": "str", "description": "Whether the holding is cash collateral.", "default": null, "optional": true, "choices": null }, { "name": "is_non_cash_collateral", "type": "str", "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true, "choices": null }, { "name": "is_loan_by_fund", "type": "str", "description": "Whether the holding is loan by fund.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "str", "description": "The CIK of the filing.", "default": null, "optional": true, "choices": null }, { "name": "acceptance_datetime", "type": "str", "description": "The acceptance datetime of the filing.", "default": null, "optional": true, "choices": null }, { "name": "updated", "type": "Union[date, datetime]", "description": "The date the data was updated.", "default": null, "optional": true, "choices": null } ], "intrinio": [ { "name": "name", "type": "str", "description": "The common name for the holding.", "default": null, "optional": true, "choices": null }, { "name": "security_type", "type": "str", "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The International Securities Identification Number.", "default": null, "optional": true, "choices": null }, { "name": "ric", "type": "str", "description": "The Reuters Instrument Code.", "default": null, "optional": true, "choices": null }, { "name": "sedol", "type": "str", "description": "The Stock Exchange Daily Official list.", "default": null, "optional": true, "choices": null }, { "name": "share_class_figi", "type": "str", "description": "The OpenFIGI symbol for the holding.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country or region of the holding.", "default": null, "optional": true, "choices": null }, { "name": "maturity_date", "type": "date", "description": "The maturity date for the debt security, if available.", "default": null, "optional": true, "choices": null }, { "name": "contract_expiry_date", "type": "date", "description": "Expiry date for the futures contract held, if available.", "default": null, "optional": true, "choices": null }, { "name": "coupon", "type": "float", "description": "The coupon rate of the debt security, if available.", "default": null, "optional": true, "choices": null }, { "name": "balance", "type": "Union[int, float]", "description": "The number of units of the security held, if available.", "default": null, "optional": true, "choices": null }, { "name": "unit", "type": "str", "description": "The units of the 'balance' field.", "default": null, "optional": true, "choices": null }, { "name": "units_per_share", "type": "float", "description": "Number of units of the security held per share outstanding of the ETF, if available.", "default": null, "optional": true, "choices": null }, { "name": "face_value", "type": "float", "description": "The face value of the debt security, if available.", "default": null, "optional": true, "choices": null }, { "name": "derivatives_value", "type": "float", "description": "The notional value of derivatives contracts held.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The market value of the holding, on the 'as_of' date.", "default": null, "optional": true, "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "updated", "type": "date", "description": "The 'as_of' date for the holding.", "default": null, "optional": true, "choices": null } ], "sec": [ { "name": "lei", "type": "str", "description": "The LEI of the holding.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the holding.", "default": null, "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the holding.", "default": null, "optional": true, "choices": null }, { "name": "other_id", "type": "str", "description": "Internal identifier for the holding.", "default": null, "optional": true, "choices": null }, { "name": "balance", "type": "float", "description": "The balance of the holding.", "default": null, "optional": true, "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the holding in ETF in %.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The value of the holding in USD.", "default": null, "optional": true, "choices": null }, { "name": "payoff_profile", "type": "str", "description": "The payoff profile of the holding.", "default": null, "optional": true, "choices": null }, { "name": "units", "type": "Union[str, float]", "description": "The units of the holding.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "The currency of the holding.", "default": null, "optional": true, "choices": null }, { "name": "asset_category", "type": "str", "description": "The asset category of the holding.", "default": null, "optional": true, "choices": null }, { "name": "issuer_category", "type": "str", "description": "The issuer category of the holding.", "default": null, "optional": true, "choices": null }, { "name": "country", "type": "str", "description": "The country of the holding.", "default": null, "optional": true, "choices": null }, { "name": "is_restricted", "type": "str", "description": "Whether the holding is restricted.", "default": null, "optional": true, "choices": null }, { "name": "fair_value_level", "type": "int", "description": "The fair value level of the holding.", "default": null, "optional": true, "choices": null }, { "name": "is_cash_collateral", "type": "str", "description": "Whether the holding is cash collateral.", "default": null, "optional": true, "choices": null }, { "name": "is_non_cash_collateral", "type": "str", "description": "Whether the holding is non-cash collateral.", "default": null, "optional": true, "choices": null }, { "name": "is_loan_by_fund", "type": "str", "description": "Whether the holding is loan by fund.", "default": null, "optional": true, "choices": null }, { "name": "loan_value", "type": "float", "description": "The loan value of the holding.", "default": null, "optional": true, "choices": null }, { "name": "issuer_conditional", "type": "str", "description": "The issuer conditions of the holding.", "default": null, "optional": true, "choices": null }, { "name": "asset_conditional", "type": "str", "description": "The asset conditions of the holding.", "default": null, "optional": true, "choices": null }, { "name": "maturity_date", "type": "date", "description": "The maturity date of the debt security.", "default": null, "optional": true, "choices": null }, { "name": "coupon_kind", "type": "str", "description": "The type of coupon for the debt security.", "default": null, "optional": true, "choices": null }, { "name": "rate_type", "type": "str", "description": "The type of rate for the debt security, floating or fixed.", "default": null, "optional": true, "choices": null }, { "name": "annualized_return", "type": "float", "description": "The annualized return on the debt security.", "default": null, "optional": true, "choices": null }, { "name": "is_default", "type": "str", "description": "If the debt security is defaulted.", "default": null, "optional": true, "choices": null }, { "name": "in_arrears", "type": "str", "description": "If the debt security is in arrears.", "default": null, "optional": true, "choices": null }, { "name": "is_paid_kind", "type": "str", "description": "If the debt security payments are paid in kind.", "default": null, "optional": true, "choices": null }, { "name": "derivative_category", "type": "str", "description": "The derivative category of the holding.", "default": null, "optional": true, "choices": null }, { "name": "counterparty", "type": "str", "description": "The counterparty of the derivative.", "default": null, "optional": true, "choices": null }, { "name": "underlying_name", "type": "str", "description": "The name of the underlying asset associated with the derivative.", "default": null, "optional": true, "choices": null }, { "name": "option_type", "type": "str", "description": "The type of option.", "default": null, "optional": true, "choices": null }, { "name": "derivative_payoff", "type": "str", "description": "The payoff profile of the derivative.", "default": null, "optional": true, "choices": null }, { "name": "expiry_date", "type": "date", "description": "The expiry or termination date of the derivative.", "default": null, "optional": true, "choices": null }, { "name": "exercise_price", "type": "float", "description": "The exercise price of the option.", "default": null, "optional": true, "choices": null }, { "name": "exercise_currency", "type": "str", "description": "The currency of the option exercise price.", "default": null, "optional": true, "choices": null }, { "name": "shares_per_contract", "type": "float", "description": "The number of shares per contract.", "default": null, "optional": true, "choices": null }, { "name": "delta", "type": "Union[str, float]", "description": "The delta of the option.", "default": null, "optional": true, "choices": null }, { "name": "rate_type_rec", "type": "str", "description": "The type of rate for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "receive_currency", "type": "str", "description": "The receive currency of the swap.", "default": null, "optional": true, "choices": null }, { "name": "upfront_receive", "type": "float", "description": "The upfront amount received of the swap.", "default": null, "optional": true, "choices": null }, { "name": "floating_rate_index_rec", "type": "str", "description": "The floating rate index for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "floating_rate_spread_rec", "type": "float", "description": "The floating rate spread for reveivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "rate_tenor_rec", "type": "str", "description": "The rate tenor for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "rate_tenor_unit_rec", "type": "Union[int, str]", "description": "The rate tenor unit for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "reset_date_rec", "type": "str", "description": "The reset date for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "reset_date_unit_rec", "type": "Union[int, str]", "description": "The reset date unit for receivable portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "rate_type_pmnt", "type": "str", "description": "The type of rate for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "payment_currency", "type": "str", "description": "The payment currency of the swap.", "default": null, "optional": true, "choices": null }, { "name": "upfront_payment", "type": "float", "description": "The upfront amount received of the swap.", "default": null, "optional": true, "choices": null }, { "name": "floating_rate_index_pmnt", "type": "str", "description": "The floating rate index for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "floating_rate_spread_pmnt", "type": "float", "description": "The floating rate spread for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "rate_tenor_pmnt", "type": "str", "description": "The rate tenor for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "rate_tenor_unit_pmnt", "type": "Union[int, str]", "description": "The rate tenor unit for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "reset_date_pmnt", "type": "str", "description": "The reset date for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "reset_date_unit_pmnt", "type": "Union[int, str]", "description": "The reset date unit for payment portion of the swap.", "default": null, "optional": true, "choices": null }, { "name": "repo_type", "type": "str", "description": "The type of repo.", "default": null, "optional": true, "choices": null }, { "name": "is_cleared", "type": "str", "description": "If the repo is cleared.", "default": null, "optional": true, "choices": null }, { "name": "is_tri_party", "type": "str", "description": "If the repo is tri party.", "default": null, "optional": true, "choices": null }, { "name": "principal_amount", "type": "float", "description": "The principal amount of the repo.", "default": null, "optional": true, "choices": null }, { "name": "principal_currency", "type": "str", "description": "The currency of the principal amount.", "default": null, "optional": true, "choices": null }, { "name": "collateral_type", "type": "str", "description": "The collateral type of the repo.", "default": null, "optional": true, "choices": null }, { "name": "collateral_amount", "type": "float", "description": "The collateral amount of the repo.", "default": null, "optional": true, "choices": null }, { "name": "collateral_currency", "type": "str", "description": "The currency of the collateral amount.", "default": null, "optional": true, "choices": null }, { "name": "exchange_currency", "type": "str", "description": "The currency of the exchange rate.", "default": null, "optional": true, "choices": null }, { "name": "exchange_rate", "type": "float", "description": "The exchange rate.", "default": null, "optional": true, "choices": null }, { "name": "currency_sold", "type": "str", "description": "The currency sold in a Forward Derivative.", "default": null, "optional": true, "choices": null }, { "name": "currency_amount_sold", "type": "float", "description": "The amount of currency sold in a Forward Derivative.", "default": null, "optional": true, "choices": null }, { "name": "currency_bought", "type": "str", "description": "The currency bought in a Forward Derivative.", "default": null, "optional": true, "choices": null }, { "name": "currency_amount_bought", "type": "float", "description": "The amount of currency bought in a Forward Derivative.", "default": null, "optional": true, "choices": null }, { "name": "notional_amount", "type": "float", "description": "The notional amount of the derivative.", "default": null, "optional": true, "choices": null }, { "name": "notional_currency", "type": "str", "description": "The currency of the derivative's notional amount.", "default": null, "optional": true, "choices": null }, { "name": "unrealized_gain", "type": "float", "description": "The unrealized gain or loss on the derivative.", "default": null, "optional": true, "choices": null } ] }, "model": "EtfHoldings", "openapi_extra": { "model": "EtfHoldings" } }, "/etf/holdings_date": { "deprecated": { "flag": null, "message": null }, "description": "Use this function to get the holdings dates, if available.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.holdings_date(symbol='XLK', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for. (ETF)", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "cik", "type": "str", "description": "The CIK of the filing entity. Overrides symbol.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfHoldingsDate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "model": "EtfHoldingsDate", "openapi_extra": { "model": "EtfHoldingsDate" } }, "/etf/equity_exposure": { "deprecated": { "flag": null, "message": null }, "description": "Get the exposure to ETFs for a specific stock.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.etf.equity_exposure(symbol='MSFT', provider='fmp')\n# This function accepts multiple tickers.\nobb.etf.equity_exposure(symbol='MSFT,AAPL', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", "default": "", "optional": false, "choices": null } ], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EtfEquityExposure]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "equity_symbol", "type": "str", "description": "The symbol of the equity requested.", "default": "", "optional": false, "choices": null }, { "name": "etf_symbol", "type": "str", "description": "The symbol of the ETF with exposure to the requested equity.", "default": "", "optional": false, "choices": null }, { "name": "shares", "type": "float", "description": "The number of shares held in the ETF.", "default": null, "optional": true, "choices": null }, { "name": "weight", "type": "float", "description": "The weight of the equity in the ETF, as a normalized percent.", "default": null, "optional": true, "choices": null }, { "name": "market_value", "type": "Union[int, float]", "description": "The market value of the equity position in the ETF.", "default": null, "optional": true, "choices": null } ], "fmp": [] }, "model": "EtfEquityExposure", "openapi_extra": { "model": "EtfEquityExposure" } }, "/fixedincome/rate/ameribor": { "deprecated": { "flag": null, "message": null }, "description": "AMERIBOR.\n\nAMERIBOR (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ameribor(provider='fred')\n# The change from one year ago is applied with the transform parameter.\nobb.fixedincome.rate.ameribor(maturity=all, transform=pc1, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "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]]]", "description": "Period of AMERIBOR rate. Multiple items allowed for provider(s): fred.", "default": "all", "optional": true, "choices": [ "all", "overnight", "average_30d", "average_90d", "term_30d", "term_90d" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[Ameribor]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "maturity", "type": "str", "description": "Maturity length of the item.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Interest rate.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the series.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "Ameribor", "openapi_extra": { "model": "Ameribor" } }, "/fixedincome/rate/sonia": { "deprecated": { "flag": null, "message": null }, "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sonia(provider='fred')\nobb.fixedincome.rate.sonia(parameter=total_nominal_value, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "parameter", "type": "Literal['rate', 'index', '10th_percentile', '25th_percentile', '75th_percentile', '90th_percentile', 'total_nominal_value']", "description": "Period of SONIA rate.", "default": "rate", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SONIA]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "SONIA rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "SONIA", "openapi_extra": { "model": "SONIA" } }, "/fixedincome/rate/sofr": { "deprecated": { "flag": null, "message": null }, "description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sofr(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [], "fred": [ { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SOFR]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Effective federal funds rate.", "default": "", "optional": false, "choices": null }, { "name": "percentile_1", "type": "float", "description": "1st percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_25", "type": "float", "description": "25th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_75", "type": "float", "description": "75th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_99", "type": "float", "description": "99th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.The notional volume of transactions (Billions of $).", "default": null, "optional": true, "choices": null } ], "federal_reserve": [], "fred": [ { "name": "average_30d", "type": "float", "description": "30-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "average_90d", "type": "float", "description": "90-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "average_180d", "type": "float", "description": "180-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "index", "type": "float", "description": "SOFR index as 2018-04-02 = 1", "default": null, "optional": true, "choices": null } ] }, "model": "SOFR", "openapi_extra": { "model": "SOFR" } }, "/fixedincome/rate/iorb": { "deprecated": { "flag": null, "message": null }, "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.iorb(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[IORB]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "IORB rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "IORB", "openapi_extra": { "model": "IORB" } }, "/fixedincome/rate/effr": { "deprecated": { "flag": null, "message": null }, "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr(provider='fred')\nobb.fixedincome.rate.effr(effr_only=True, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [], "fred": [ { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] }, { "name": "effr_only", "type": "bool", "description": "Return data without quantiles, target ranges, and volume.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[FederalFundsRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Effective federal funds rate.", "default": "", "optional": false, "choices": null }, { "name": "target_range_upper", "type": "float", "description": "Upper bound of the target range.", "default": null, "optional": true, "choices": null }, { "name": "target_range_lower", "type": "float", "description": "Lower bound of the target range.", "default": null, "optional": true, "choices": null }, { "name": "percentile_1", "type": "float", "description": "1st percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_25", "type": "float", "description": "25th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_75", "type": "float", "description": "75th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_99", "type": "float", "description": "99th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.The notional volume of transactions (Billions of $).", "default": null, "optional": true, "choices": null } ], "federal_reserve": [ { "name": "intraday_low", "type": "float", "description": "Intraday low. This field is only present for data before 2016.", "default": null, "optional": true, "choices": null }, { "name": "intraday_high", "type": "float", "description": "Intraday high. This field is only present for data before 2016.", "default": null, "optional": true, "choices": null }, { "name": "standard_deviation", "type": "float", "description": "Standard deviation. This field is only present for data before 2016.", "default": null, "optional": true, "choices": null }, { "name": "revision_indicator", "type": "str", "description": "Indicates a revision of the data for that date.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "FederalFundsRate", "openapi_extra": { "model": "FederalFundsRate" } }, "/fixedincome/rate/effr_forecast": { "deprecated": { "flag": null, "message": null }, "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.effr_forecast(provider='fred')\nobb.fixedincome.rate.effr_forecast(long_run=True, provider='fred')\n```\n\n", "parameters": { "standard": [], "fred": [ { "name": "long_run", "type": "bool", "description": "Flag to show long run projections", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[PROJECTIONS]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "range_high", "type": "float", "description": "High projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "central_tendency_high", "type": "float", "description": "Central tendency of high projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "median", "type": "float", "description": "Median projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "range_midpoint", "type": "float", "description": "Midpoint projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "central_tendency_midpoint", "type": "float", "description": "Central tendency of midpoint projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "range_low", "type": "float", "description": "Low projection of rates.", "default": "", "optional": false, "choices": null }, { "name": "central_tendency_low", "type": "float", "description": "Central tendency of low projection of rates.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "PROJECTIONS", "openapi_extra": { "model": "PROJECTIONS" } }, "/fixedincome/rate/estr": { "deprecated": { "flag": null, "message": null }, "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm's length and thus reflect market rates in an unbiased way.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.estr(provider='fred')\nobb.fixedincome.rate.estr(transform=ch1, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n \n a = Annual\n \n q = Quarterly\n \n m = Monthly\n \n w = Weekly\n \n d = Daily\n \n wef = Weekly, Ending Friday\n \n weth = Weekly, Ending Thursday\n \n wew = Weekly, Ending Wednesday\n \n wetu = Weekly, Ending Tuesday\n \n wem = Weekly, Ending Monday\n \n wesu = Weekly, Ending Sunday\n \n wesa = Weekly, Ending Saturday\n \n bwew = Biweekly, Ending Wednesday\n \n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n \n avg = Average\n \n sum = Sum\n \n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n \n None = No transformation\n \n chg = Change\n \n ch1 = Change from Year Ago\n \n pch = Percent Change\n \n pc1 = Percent Change from Year Ago\n \n pca = Compounded Annual Rate of Change\n \n cch = Continuously Compounded Rate of Change\n \n cca = Continuously Compounded Annual Rate of Change\n \n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EuroShortTermRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Volume-weighted trimmed mean rate.", "default": "", "optional": false, "choices": null }, { "name": "percentile_25", "type": "float", "description": "Rate at 25th percentile of volume.", "default": null, "optional": true, "choices": null }, { "name": "percentile_75", "type": "float", "description": "Rate at 75th percentile of volume.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume. (Millions of \u20acEUR).", "default": null, "optional": true, "choices": null }, { "name": "transactions", "type": "int", "description": "Number of transactions.", "default": null, "optional": true, "choices": null }, { "name": "number_of_banks", "type": "int", "description": "Number of active banks.", "default": null, "optional": true, "choices": null }, { "name": "large_bank_share_of_volume", "type": "float", "description": "The percent of volume attributable to the 5 largest active banks.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "EuroShortTermRate", "openapi_extra": { "model": "EuroShortTermRate" } }, "/fixedincome/rate/ecb": { "deprecated": { "flag": null, "message": null }, "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.ecb(provider='fred')\nobb.fixedincome.rate.ecb(interest_rate_type='refinancing', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "interest_rate_type", "type": "Literal['deposit', 'lending', 'refinancing']", "description": "The type of interest rate.", "default": "lending", "optional": true, "choices": null } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[EuropeanCentralBankInterestRates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "European Central Bank Interest Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "EuropeanCentralBankInterestRates", "openapi_extra": { "model": "EuropeanCentralBankInterestRates" } }, "/fixedincome/rate/dpcredit": { "deprecated": { "flag": null, "message": null }, "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.dpcredit(provider='fred')\nobb.fixedincome.rate.dpcredit(start_date='2023-02-01', end_date='2023-05-01', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "parameter", "type": "Literal['daily_excl_weekend', 'monthly', 'weekly', 'daily', 'annual']", "description": "FRED series ID of DWPCR data.", "default": "daily_excl_weekend", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[DiscountWindowPrimaryCreditRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Discount Window Primary Credit Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "DiscountWindowPrimaryCreditRate", "openapi_extra": { "model": "DiscountWindowPrimaryCreditRate" } }, "/fixedincome/rate/overnight_bank_funding": { "deprecated": { "flag": null, "message": null }, "description": "Overnight Bank Funding.\n\nFor the United States, the overnight bank funding rate (OBFR) is calculated as a volume-weighted median of\novernight federal funds transactions and Eurodollar transactions reported in the\nFR 2420 Report of Selected Money Market Rates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.overnight_bank_funding(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [], "fred": [ { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[OvernightBankFundingRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Overnight Bank Funding Rate.", "default": "", "optional": false, "choices": null }, { "name": "percentile_1", "type": "float", "description": "1st percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_25", "type": "float", "description": "25th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_75", "type": "float", "description": "75th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_99", "type": "float", "description": "99th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.The notional volume of transactions (Billions of $).", "default": null, "optional": true, "choices": null } ], "federal_reserve": [ { "name": "revision_indicator", "type": "str", "description": "Indicates a revision of the data for that date.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "OvernightBankFundingRate", "openapi_extra": { "model": "OvernightBankFundingRate" } }, "/fixedincome/spreads/tcm": { "deprecated": { "flag": null, "message": null }, "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm(provider='fred')\nobb.fixedincome.spreads.tcm(maturity='2y', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "maturity", "type": "Literal['3m', '2y']", "description": "The maturity", "default": "3m", "optional": true, "choices": null } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[TreasuryConstantMaturity]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "TreasuryConstantMaturity Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "TreasuryConstantMaturity", "openapi_extra": { "model": "TreasuryConstantMaturity" } }, "/fixedincome/spreads/tcm_effr": { "deprecated": { "flag": null, "message": null }, "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.tcm_effr(provider='fred')\nobb.fixedincome.spreads.tcm_effr(maturity='10y', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "maturity", "type": "Literal['10y', '5y', '1y', '6m', '3m']", "description": "The maturity", "default": "10y", "optional": true, "choices": null } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SelectedTreasuryConstantMaturity]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Selected Treasury Constant Maturity Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "SelectedTreasuryConstantMaturity", "openapi_extra": { "model": "SelectedTreasuryConstantMaturity" } }, "/fixedincome/spreads/treasury_effr": { "deprecated": { "flag": null, "message": null }, "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.spreads.treasury_effr(provider='fred')\nobb.fixedincome.spreads.treasury_effr(maturity='6m', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "maturity", "type": "Literal['3m', '6m']", "description": "The maturity", "default": "3m", "optional": true, "choices": null } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SelectedTreasuryBill]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "SelectedTreasuryBill Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "SelectedTreasuryBill", "openapi_extra": { "model": "SelectedTreasuryBill" } }, "/fixedincome/government/yield_curve": { "deprecated": { "flag": null, "message": null }, "description": "Get yield curve data by country and date.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.yield_curve(provider='federal_reserve')\nobb.fixedincome.government.yield_curve(date='2023-05-01,2024-05-01', provider='fmp')\nobb.fixedincome.government.yield_curve(date='2023-05-01', country=united_kingdom, provider='econdb')\nobb.fixedincome.government.yield_curve(provider='fred', yield_curve_type=real, date='2023-05-01,2024-05-01')\n```\n\n", "parameters": { "standard": [ { "name": "date", "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, "choices": null } ], "econdb": [ { "name": "country", "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, "choices": [ "australia", "canada", "china", "ecb_instantaneous_forward", "ecb_par_yield", "ecb_spot_rate", "hong_kong", "india", "japan", "mexico", "new_zealand", "russia", "saudi_arabia", "singapore", "south_africa", "south_korea", "taiwan", "thailand", "united_kingdom", "united_states" ] }, { "name": "use_cache", "type": "bool", "description": "If true, cache the request for four hours.", "default": true, "optional": true, "choices": null } ], "federal_reserve": [], "fmp": [], "fred": [ { "name": "yield_curve_type", "type": "Literal['nominal', 'real', 'breakeven', 'treasury_minus_fed_funds', 'corporate_spot', 'corporate_par']", "description": "Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned.", "default": "nominal", "optional": true, "choices": [ "nominal", "real", "breakeven", "treasury_minus_fed_funds", "corporate_spot", "corporate_par" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[YieldCurve]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['econdb', 'federal_reserve', 'fmp', 'fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": null, "optional": true, "choices": null }, { "name": "maturity", "type": "str", "description": "Maturity length of the security.", "default": "", "optional": false, "choices": null } ], "econdb": [], "federal_reserve": [], "fmp": [], "fred": [] }, "model": "YieldCurve", "openapi_extra": { "model": "YieldCurve" } }, "/fixedincome/government/treasury_rates": { "deprecated": { "flag": null, "message": null }, "description": "Government Treasury Rates.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.treasury_rates(provider='fmp')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [], "fmp": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[TreasuryRates]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve', 'fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "week_4", "type": "float", "description": "4 week Treasury bills rate (secondary market).", "default": null, "optional": true, "choices": null }, { "name": "month_1", "type": "float", "description": "1 month Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "month_2", "type": "float", "description": "2 month Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "month_3", "type": "float", "description": "3 month Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "month_6", "type": "float", "description": "6 month Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_1", "type": "float", "description": "1 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_2", "type": "float", "description": "2 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_3", "type": "float", "description": "3 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_5", "type": "float", "description": "5 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_7", "type": "float", "description": "7 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_10", "type": "float", "description": "10 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_20", "type": "float", "description": "20 year Treasury rate.", "default": null, "optional": true, "choices": null }, { "name": "year_30", "type": "float", "description": "30 year Treasury rate.", "default": null, "optional": true, "choices": null } ], "federal_reserve": [], "fmp": [] }, "model": "TreasuryRates", "openapi_extra": { "model": "TreasuryRates" } }, "/fixedincome/government/tips_yields": { "deprecated": { "flag": null, "message": null }, "description": "Get current Treasury inflation-protected securities yields.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.tips_yields(provider='fred')\nobb.fixedincome.government.tips_yields(maturity=10, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "fred": [ { "name": "maturity", "type": "Literal['5', '10', '20', '30']", "description": "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.", "default": null, "optional": true, "choices": [ "5", "10", "20", "30" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[TipsYields]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "due", "type": "date", "description": "The due date (maturation date) of the security.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "The name of the security.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "The yield value.", "default": null, "optional": true, "choices": null } ], "fred": [] }, "model": "TipsYields", "openapi_extra": { "model": "TipsYields" } }, "/fixedincome/corporate/ice_bofa": { "deprecated": { "flag": true, "message": "This endpoint is deprecated; use `/fixedincome/bond_indices` instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.5." }, "description": "ICE BofA US Corporate Bond Indices.\n\nThe ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt\npublicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an\naverage of Moody\u2019s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year\nremaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount\noutstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.ice_bofa(provider='fred')\nobb.fixedincome.corporate.ice_bofa(index_type='yield_to_worst', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "index_type", "type": "Literal['yield', 'yield_to_worst', 'total_return', 'spread']", "description": "The type of series.", "default": "yield", "optional": true, "choices": null } ], "fred": [ { "name": "category", "type": "Literal['all', 'duration', 'eur', 'usd']", "description": "The type of category.", "default": "all", "optional": true, "choices": null }, { "name": "area", "type": "Literal['asia', 'emea', 'eu', 'ex_g10', 'latin_america', 'us']", "description": "The type of area.", "default": "us", "optional": true, "choices": null }, { "name": "grade", "type": "Literal['a', 'aa', 'aaa', 'b', 'bb', 'bbb', 'ccc', 'crossover', 'high_grade', 'high_yield', 'non_financial', 'non_sovereign', 'private_sector', 'public_sector']", "description": "The type of grade.", "default": "non_sovereign", "optional": true, "choices": null }, { "name": "options", "type": "bool", "description": "Whether to include options in the results.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[ICEBofA]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "ICE BofA US Corporate Bond Indices Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "ICEBofA", "openapi_extra": { "model": "ICEBofA" } }, "/fixedincome/corporate/moody": { "deprecated": { "flag": true, "message": "This endpoint is deprecated; use `/fixedincome/bond_indices` instead. Set `category` to `us` and `index` to `seasoned_corporate`. Deprecated in OpenBB Platform V4.2 to be removed in V4.5." }, "description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.moody(provider='fred')\nobb.fixedincome.corporate.moody(index_type='baa', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "index_type", "type": "Literal['aaa', 'baa']", "description": "The type of series.", "default": "aaa", "optional": true, "choices": null } ], "fred": [ { "name": "spread", "type": "Literal['treasury', 'fed_funds']", "description": "The type of spread.", "default": null, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[MoodyCorporateBondIndex]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Moody Corporate Bond Index Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "MoodyCorporateBondIndex", "openapi_extra": { "model": "MoodyCorporateBondIndex" } }, "/fixedincome/corporate/hqm": { "deprecated": { "flag": null, "message": null }, "description": "High Quality Market Corporate Bond.\n\nThe HQM yield curve represents the high quality corporate bond market, i.e.,\ncorporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.\nThese terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve\nthat is the market-weighted average (MWA) quality of high quality bonds.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.hqm(provider='fred')\nobb.fixedincome.corporate.hqm(yield_curve=par, provider='fred')\n```\n\n", "parameters": { "standard": [ { "name": "date", "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, "choices": null } ], "fred": [ { "name": "yield_curve", "type": "Literal['spot', 'par']", "description": "The yield curve type.", "default": "spot", "optional": true, "choices": [ "spot", "par" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[HighQualityMarketCorporateBond]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Interest rate.", "default": "", "optional": false, "choices": null }, { "name": "maturity", "type": "str", "description": "Maturity.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "HighQualityMarketCorporateBond", "openapi_extra": { "model": "HighQualityMarketCorporateBond" } }, "/fixedincome/corporate/spot_rates": { "deprecated": { "flag": null, "message": null }, "description": "Spot Rates.\n\nThe spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.\nThis is a zero coupon bond.\nBecause each spot rate pertains to a single cashflow, it is the relevant interest rate\nconcept for discounting a pension liability at the same maturity.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.spot_rates(provider='fred')\nobb.fixedincome.corporate.spot_rates(maturity='10,20,30,50', provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "maturity", "type": "Union[Union[float, str], list[Union[float, str]]]", "description": "Maturities in years. Multiple items allowed for provider(s): fred.", "default": 10.0, "optional": true, "choices": null }, { "name": "category", "type": "Union[str, list[str]]", "description": "Rate category. Options: spot_rate, par_yield. Multiple items allowed for provider(s): fred.", "default": "spot_rate", "optional": true, "choices": [ "par_yield", "spot_rate" ] } ], "fred": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SpotRate]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Spot Rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "SpotRate", "openapi_extra": { "model": "SpotRate" } }, "/fixedincome/corporate/commercial_paper": { "deprecated": { "flag": null, "message": null }, "description": "Commercial Paper.\n\nCommercial paper (CP) consists of short-term, promissory notes issued primarily by corporations.\nMaturities range up to 270 days but average about 30 days.\nMany companies use CP to raise cash needed for current transactions,\nand many find it to be a lower-cost alternative to bank loans.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.corporate.commercial_paper(provider='fred')\nobb.fixedincome.corporate.commercial_paper(category=all, maturity=15d, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "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']]]]", "description": "A target maturity. Multiple items allowed for provider(s): fred.", "default": "all", "optional": true, "choices": [ "all", "overnight", "7d", "15d", "30d", "60d", "90d" ] }, { "name": "category", "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, "choices": [ "all", "asset_backed", "financial", "nonfinancial", "a2p2" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CommercialPaper]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "maturity", "type": "str", "description": "Maturity length of the item.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Interest rate.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the series.", "default": null, "optional": true, "choices": null } ], "fred": [ { "name": "asset_type", "type": "Literal['asset_backed', 'financial', 'nonfinancial', 'a2p2']", "description": "The category of asset.", "default": "", "optional": false, "choices": null } ] }, "model": "CommercialPaper", "openapi_extra": { "model": "CommercialPaper" } }, "/fixedincome/sofr": { "deprecated": { "flag": true, "message": "This endpoint is deprecated; use `/fixedincome/rate/sofr` instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.5." }, "description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.sofr(provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "federal_reserve": [], "fred": [ { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n avg = Average\n sum = Sum\n eop = End of Period", "default": null, "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SOFR]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['federal_reserve', 'fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "rate", "type": "float", "description": "Effective federal funds rate.", "default": "", "optional": false, "choices": null }, { "name": "percentile_1", "type": "float", "description": "1st percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_25", "type": "float", "description": "25th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_75", "type": "float", "description": "75th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "percentile_99", "type": "float", "description": "99th percentile of the distribution.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "float", "description": "The trading volume.The notional volume of transactions (Billions of $).", "default": null, "optional": true, "choices": null } ], "federal_reserve": [], "fred": [ { "name": "average_30d", "type": "float", "description": "30-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "average_90d", "type": "float", "description": "90-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "average_180d", "type": "float", "description": "180-Day Average SOFR", "default": null, "optional": true, "choices": null }, { "name": "index", "type": "float", "description": "SOFR index as 2018-04-02 = 1", "default": null, "optional": true, "choices": null } ] }, "model": "SOFR", "openapi_extra": { "model": "SOFR" } }, "/fixedincome/bond_indices": { "deprecated": { "flag": null, "message": null }, "description": "Bond Indices.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# The default state for FRED are series for constructing the US Corporate Bond Yield Curve.\nobb.fixedincome.bond_indices(provider='fred')\n# Multiple indices, from within the same 'category', can be requested.\nobb.fixedincome.bond_indices(category=high_yield, index=us,europe,emerging, index_type='total_return', provider='fred')\n# From FRED, there are three main categories, 'high_yield', 'us', and 'emerging_markets'. Emerging markets is a broad category.\nobb.fixedincome.bond_indices(category=emerging_markets, index=corporate,private_sector,public_sector, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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": "index_type", "type": "Literal['yield', 'yield_to_worst', 'total_return', 'oas']", "description": "The type of series. OAS is the option-adjusted spread. Default is yield.", "default": "yield", "optional": true, "choices": [ "yield", "yield_to_worst", "total_return", "oas" ] } ], "fred": [ { "name": "category", "type": "Literal['high_yield', 'us', 'emerging_markets']", "description": "The type of index category. Used in conjunction with 'index', default is 'us'.", "default": "us", "optional": true, "choices": null }, { "name": "index", "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, "choices": [ "a", "aa", "aaa", "asia", "b", "bb", "bbb", "ccc", "corporate", "crossover", "emea", "high_grade", "high_yield", "latam", "liquid_aaa", "liquid_asia", "liquid_bbb", "liquid_corporate", "liquid_emea", "liquid_latam", "non_financial", "private_sector", "public_sector", "seasoned_corporate", "yield_curve" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set, default is 'avg'.\n avg = Average\n sum = Sum\n eop = End of Period", "default": "avg", "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[BondIndices]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "value", "type": "float", "description": "Index values.", "default": "", "optional": false, "choices": null } ], "fred": [ { "name": "maturity", "type": "str", "description": "The maturity range of the bond index. Only applicable when 'index' is 'yield_curve'.", "default": null, "optional": true, "choices": null }, { "name": "title", "type": "str", "description": "The title of the index.", "default": "", "optional": false, "choices": null } ] }, "model": "BondIndices", "openapi_extra": { "model": "BondIndices" } }, "/fixedincome/mortgage_indices": { "deprecated": { "flag": null, "message": null }, "description": "Mortgage Indices.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# The default state for FRED are the primary mortgage indices from Optimal Blue.\nobb.fixedincome.mortgage_indices(provider='fred')\n# Multiple indices can be requested.\nobb.fixedincome.mortgage_indices(index=jumbo_30y,conforming_30y,conforming_15y, provider='fred')\n```\n\n", "parameters": { "standard": [ { "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 } ], "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]]]", "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, "choices": [ "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" ] }, { "name": "frequency", "type": "Literal['a', 'q', 'm', 'w', 'd', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem']", "description": "Frequency aggregation to convert daily data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday", "default": null, "optional": true, "choices": [ "a", "q", "m", "w", "d", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" ] }, { "name": "aggregation_method", "type": "Literal['avg', 'sum', 'eop']", "description": "A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set, default is 'avg'.\n avg = Average\n sum = Sum\n eop = End of Period", "default": "avg", "optional": true, "choices": [ "avg", "sum", "eop" ] }, { "name": "transform", "type": "Literal['chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log']", "description": "Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log", "default": null, "optional": true, "choices": [ "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[MortgageIndices]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fred']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null }, { "name": "name", "type": "str", "description": "Name of the index.", "default": null, "optional": true, "choices": null }, { "name": "rate", "type": "float", "description": "Mortgage rate.", "default": "", "optional": false, "choices": null } ], "fred": [] }, "model": "MortgageIndices", "openapi_extra": { "model": "MortgageIndices" } }, "/index/price/historical": { "deprecated": { "flag": null, "message": null }, "description": "Historical Index Levels.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.price.historical(symbol='^GSPC', provider='fmp')\n# Not all providers have the same symbols.\nobb.index.price.historical(symbol='SPX', provider='intrinio')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "Union[str, list[str]]", "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, polygon, yfinance.", "default": "", "optional": false, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format.", "default": null, "optional": true, "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 } ], "fmp": [ { "name": "interval", "type": "Literal['1m', '5m', '15m', '30m', '1h', '4h', '1d']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ] } ], "intrinio": [ { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 10000, "optional": true, "choices": null } ], "polygon": [ { "name": "interval", "type": "str", "description": "Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y", "default": "1d", "optional": true, "choices": null }, { "name": "sort", "type": "Literal['asc', 'desc']", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.", "default": "asc", "optional": true, "choices": null }, { "name": "limit", "type": "int", "description": "The number of data entries to return.", "default": 49999, "optional": true, "choices": null } ], "yfinance": [ { "name": "interval", "type": "Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']", "description": "Time interval of the data to return.", "default": "1d", "optional": true, "choices": [ "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1W", "1M", "1Q" ] } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[IndexHistorical]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'intrinio', 'polygon', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[Union[date, datetime], str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "open", "type": "Annotated[float, Strict(strict=True)]", "description": "The open price.", "default": null, "optional": true, "choices": null }, { "name": "high", "type": "Annotated[float, Strict(strict=True)]", "description": "The high price.", "default": null, "optional": true, "choices": null }, { "name": "low", "type": "Annotated[float, Strict(strict=True)]", "description": "The low price.", "default": null, "optional": true, "choices": null }, { "name": "close", "type": "Annotated[float, Strict(strict=True)]", "description": "The close price.", "default": null, "optional": true, "choices": null }, { "name": "volume", "type": "int", "description": "The trading volume.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "vwap", "type": "float", "description": "Volume Weighted Average Price over the period.", "default": null, "optional": true, "choices": null }, { "name": "change", "type": "float", "description": "Change in the price from the previous close.", "default": null, "optional": true, "choices": null }, { "name": "change_percent", "type": "float", "description": "Change in the price from the previous close, as a normalized percent.", "default": null, "optional": true, "choices": null } ], "intrinio": [], "polygon": [ { "name": "transactions", "type": "Annotated[int, Gt(gt=0)]", "description": "Number of transactions for the symbol in the time period.", "default": null, "optional": true, "choices": null } ], "yfinance": [] }, "model": "IndexHistorical", "openapi_extra": { "model": "IndexHistorical" } }, "/index/constituents": { "deprecated": { "flag": null, "message": null }, "description": "Get Index Constituents.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.constituents(symbol='dowjones', provider='fmp')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "fmp": [ { "name": "symbol", "type": "Literal['dowjones', 'sp500', 'nasdaq']", "description": "None", "default": "dowjones", "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[IndexConstituents]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the constituent company in the index.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "sector", "type": "str", "description": "Sector the constituent company in the index belongs to.", "default": "", "optional": false, "choices": null }, { "name": "sub_sector", "type": "str", "description": "Sub-sector the constituent company in the index belongs to.", "default": null, "optional": true, "choices": null }, { "name": "headquarter", "type": "str", "description": "Location of the headquarter of the constituent company in the index.", "default": null, "optional": true, "choices": null }, { "name": "date_first_added", "type": "Union[date, str]", "description": "Date the constituent company was added to the index.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "int", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null }, { "name": "founded", "type": "Union[date, str]", "description": "Founding year of the constituent company in the index.", "default": null, "optional": true, "choices": null } ] }, "model": "IndexConstituents", "openapi_extra": { "model": "IndexConstituents" } }, "/index/available": { "deprecated": { "flag": null, "message": null }, "description": "All indices available from a given provider.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.index.available(provider='fmp')\nobb.index.available(provider='yfinance')\n```\n\n", "parameters": { "standard": [], "fmp": [], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[AvailableIndices]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['fmp', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "name", "type": "str", "description": "Name of the index.", "default": null, "optional": true, "choices": null }, { "name": "currency", "type": "str", "description": "Currency the index is traded in.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "stock_exchange", "type": "str", "description": "Stock exchange where the index is listed.", "default": "", "optional": false, "choices": null }, { "name": "exchange_short_name", "type": "str", "description": "Short name of the stock exchange where the index is listed.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "code", "type": "str", "description": "ID code for keying the index in the OpenBB Terminal.", "default": "", "optional": false, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol for the index.", "default": "", "optional": false, "choices": null } ] }, "model": "AvailableIndices", "openapi_extra": { "model": "AvailableIndices" } }, "/news/world": { "deprecated": { "flag": null, "message": null }, "description": "World News. Global news data.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.news.world(provider='fmp')\nobb.news.world(limit=100, provider='intrinio')\n# Get news on the specified dates.\nobb.news.world(start_date='2024-02-01', end_date='2024-02-07', provider='intrinio')\n# Display the headlines of the news.\nobb.news.world(display=headline, provider='benzinga')\n# Get news by topics.\nobb.news.world(topics=finance, provider='benzinga')\n# Get news by source using 'tingo' as provider.\nobb.news.world(provider='tiingo', source=bloomberg)\n```\n\n", "parameters": { "standard": [ { "name": "limit", "type": "int", "description": "The number of data entries to return. The number of articles to return.", "default": 2500, "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 } ], "benzinga": [ { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null }, { "name": "display", "type": "Literal['headline', 'abstract', 'full']", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", "default": "full", "optional": true, "choices": null }, { "name": "updated_since", "type": "int", "description": "Number of seconds since the news was updated.", "default": null, "optional": true, "choices": null }, { "name": "published_since", "type": "int", "description": "Number of seconds since the news was published.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['id', 'created', 'updated']", "description": "Key to sort the news by.", "default": "created", "optional": true, "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order to sort the news by.", "default": "desc", "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The ISIN of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "The CUSIP of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "channels", "type": "str", "description": "Channels of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "topics", "type": "str", "description": "Topics of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "authors", "type": "str", "description": "Authors of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "content_types", "type": "str", "description": "Content types of the news to retrieve.", "default": null, "optional": true, "choices": null } ], "fmp": [], "intrinio": [ { "name": "source", "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", "description": "The source of the news article.", "default": null, "optional": true, "choices": null }, { "name": "sentiment", "type": "Literal['positive', 'neutral', 'negative']", "description": "Return news only from this source.", "default": null, "optional": true, "choices": null }, { "name": "language", "type": "str", "description": "Filter by language. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "topic", "type": "str", "description": "Filter by topic. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "word_count_greater_than", "type": "int", "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "word_count_less_than", "type": "int", "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "is_spam", "type": "bool", "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance_greater_than", "type": "float", "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance_less_than", "type": "float", "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.", "default": null, "optional": true, "choices": null } ], "tiingo": [ { "name": "offset", "type": "int", "description": "Page offset, used in conjunction with limit.", "default": 0, "optional": true, "choices": null }, { "name": "source", "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, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[WorldNews]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'tiingo']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data. The published date of the article.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the article.", "default": "", "optional": false, "choices": null }, { "name": "images", "type": "list[Dict[str, str]]", "description": "Images associated with the article.", "default": null, "optional": true, "choices": null }, { "name": "text", "type": "str", "description": "Text/body of the article.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "URL to the article.", "default": null, "optional": true, "choices": null } ], "benzinga": [ { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false, "choices": null }, { "name": "author", "type": "str", "description": "Author of the news.", "default": null, "optional": true, "choices": null }, { "name": "teaser", "type": "str", "description": "Teaser of the news.", "default": null, "optional": true, "choices": null }, { "name": "channels", "type": "str", "description": "Channels associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "stocks", "type": "str", "description": "Stocks associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "updated", "type": "datetime", "description": "Updated date of the news.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "site", "type": "str", "description": "News source.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "source", "type": "str", "description": "The source of the news article.", "default": null, "optional": true, "choices": null }, { "name": "summary", "type": "str", "description": "The summary of the news article.", "default": null, "optional": true, "choices": null }, { "name": "topics", "type": "str", "description": "The topics related to the news article.", "default": null, "optional": true, "choices": null }, { "name": "word_count", "type": "int", "description": "The word count of the news article.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance", "type": "float", "description": "How strongly correlated the news article is to the business", "default": null, "optional": true, "choices": null }, { "name": "sentiment", "type": "str", "description": "The sentiment of the news article - i.e, negative, positive.", "default": null, "optional": true, "choices": null }, { "name": "sentiment_confidence", "type": "float", "description": "The confidence score of the sentiment rating.", "default": null, "optional": true, "choices": null }, { "name": "language", "type": "str", "description": "The language of the news article.", "default": null, "optional": true, "choices": null }, { "name": "spam", "type": "bool", "description": "Whether the news article is spam.", "default": null, "optional": true, "choices": null }, { "name": "copyright", "type": "str", "description": "The copyright notice of the news article.", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false, "choices": null }, { "name": "company", "type": "IntrinioCompany", "description": "The Intrinio Company object. Contains details company reference data.", "default": null, "optional": true, "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The Intrinio Security object. Contains the security details related to the news article.", "default": null, "optional": true, "choices": null } ], "tiingo": [ { "name": "symbols", "type": "str", "description": "Ticker tagged in the fetched news.", "default": null, "optional": true, "choices": null }, { "name": "article_id", "type": "int", "description": "Unique ID of the news article.", "default": "", "optional": false, "choices": null }, { "name": "site", "type": "str", "description": "News source.", "default": "", "optional": false, "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news article.", "default": null, "optional": true, "choices": null }, { "name": "crawl_date", "type": "datetime", "description": "Date the news article was crawled.", "default": "", "optional": false, "choices": null } ] }, "model": "WorldNews", "openapi_extra": { "model": "WorldNews" } }, "/news/company": { "deprecated": { "flag": null, "message": null }, "description": "Company News. Get news for one or more companies.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.news.company(provider='benzinga')\nobb.news.company(limit=100, provider='benzinga')\n# Get news on the specified dates.\nobb.news.company(symbol='AAPL', start_date='2024-02-01', end_date='2024-02-07', provider='intrinio')\n# Display the headlines of the news.\nobb.news.company(symbol='AAPL', display=headline, provider='benzinga')\n# Get news for multiple symbols.\nobb.news.company(symbol='aapl,tsla', provider='fmp')\n# Get news company's ISIN.\nobb.news.company(symbol='NVDA', isin=US0378331005, provider='benzinga')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "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, "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": "Annotated[int, Ge(ge=0)]", "description": "The number of data entries to return.", "default": 2500, "optional": true, "choices": null } ], "benzinga": [ { "name": "date", "type": "Union[date, str]", "description": "A specific date to get data for.", "default": null, "optional": true, "choices": null }, { "name": "display", "type": "Literal['headline', 'abstract', 'full']", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full).", "default": "full", "optional": true, "choices": null }, { "name": "updated_since", "type": "int", "description": "Number of seconds since the news was updated.", "default": null, "optional": true, "choices": null }, { "name": "published_since", "type": "int", "description": "Number of seconds since the news was published.", "default": null, "optional": true, "choices": null }, { "name": "sort", "type": "Literal['id', 'created', 'updated']", "description": "Key to sort the news by.", "default": "created", "optional": true, "choices": null }, { "name": "order", "type": "Literal['asc', 'desc']", "description": "Order to sort the news by.", "default": "desc", "optional": true, "choices": null }, { "name": "isin", "type": "str", "description": "The company's ISIN.", "default": null, "optional": true, "choices": null }, { "name": "cusip", "type": "str", "description": "The company's CUSIP.", "default": null, "optional": true, "choices": null }, { "name": "channels", "type": "str", "description": "Channels of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "topics", "type": "str", "description": "Topics of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "authors", "type": "str", "description": "Authors of the news to retrieve.", "default": null, "optional": true, "choices": null }, { "name": "content_types", "type": "str", "description": "Content types of the news to retrieve.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "page", "type": "int", "description": "Page number of the results. Use in combination with limit.", "default": 0, "optional": true, "choices": null } ], "intrinio": [ { "name": "source", "type": "Literal['yahoo', 'moody', 'moody_us_news', 'moody_us_press_releases']", "description": "The source of the news article.", "default": null, "optional": true, "choices": [ "yahoo", "moody", "moody_us_news", "moody_us_press_releases" ] }, { "name": "sentiment", "type": "Literal['positive', 'neutral', 'negative']", "description": "Return news only from this source.", "default": null, "optional": true, "choices": [ "positive", "neutral", "negative" ] }, { "name": "language", "type": "str", "description": "Filter by language. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "topic", "type": "str", "description": "Filter by topic. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "word_count_greater_than", "type": "int", "description": "News stories will have a word count greater than this value. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "word_count_less_than", "type": "int", "description": "News stories will have a word count less than this value. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "is_spam", "type": "bool", "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance_greater_than", "type": "float", "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance_less_than", "type": "float", "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "order", "type": "Literal['asc', 'desc']", "description": "Sort order of the articles.", "default": "desc", "optional": true, "choices": [ "asc", "desc" ] } ], "tiingo": [ { "name": "offset", "type": "int", "description": "Page offset, used in conjunction with limit.", "default": 0, "optional": true, "choices": null }, { "name": "source", "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, "choices": null } ], "yfinance": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CompanyNews]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['benzinga', 'fmp', 'intrinio', 'polygon', 'tiingo', 'yfinance']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[datetime, str]", "description": "The date of the data. Here it is the published date of the article.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "Title of the article.", "default": "", "optional": false, "choices": null }, { "name": "text", "type": "str", "description": "Text/body of the article.", "default": null, "optional": true, "choices": null }, { "name": "images", "type": "list[Dict[str, str]]", "description": "Images associated with the article.", "default": null, "optional": true, "choices": null }, { "name": "url", "type": "str", "description": "URL to the article.", "default": "", "optional": false, "choices": null }, { "name": "symbols", "type": "str", "description": "Symbols associated with the article.", "default": null, "optional": true, "choices": null } ], "benzinga": [ { "name": "images", "type": "list[Dict[str, str]]", "description": "URL to the images of the news.", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false, "choices": null }, { "name": "author", "type": "str", "description": "Author of the article.", "default": null, "optional": true, "choices": null }, { "name": "teaser", "type": "str", "description": "Teaser of the news.", "default": null, "optional": true, "choices": null }, { "name": "channels", "type": "str", "description": "Channels associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "stocks", "type": "str", "description": "Stocks associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "tags", "type": "str", "description": "Tags associated with the news.", "default": null, "optional": true, "choices": null }, { "name": "updated", "type": "datetime", "description": "Updated date of the news.", "default": null, "optional": true, "choices": null } ], "fmp": [ { "name": "source", "type": "str", "description": "Name of the news source.", "default": "", "optional": false, "choices": null } ], "intrinio": [ { "name": "source", "type": "str", "description": "The source of the news article.", "default": null, "optional": true, "choices": null }, { "name": "summary", "type": "str", "description": "The summary of the news article.", "default": null, "optional": true, "choices": null }, { "name": "topics", "type": "str", "description": "The topics related to the news article.", "default": null, "optional": true, "choices": null }, { "name": "word_count", "type": "int", "description": "The word count of the news article.", "default": null, "optional": true, "choices": null }, { "name": "business_relevance", "type": "float", "description": "How strongly correlated the news article is to the business", "default": null, "optional": true, "choices": null }, { "name": "sentiment", "type": "str", "description": "The sentiment of the news article - i.e, negative, positive.", "default": null, "optional": true, "choices": null }, { "name": "sentiment_confidence", "type": "float", "description": "The confidence score of the sentiment rating.", "default": null, "optional": true, "choices": null }, { "name": "language", "type": "str", "description": "The language of the news article.", "default": null, "optional": true, "choices": null }, { "name": "spam", "type": "bool", "description": "Whether the news article is spam.", "default": null, "optional": true, "choices": null }, { "name": "copyright", "type": "str", "description": "The copyright notice of the news article.", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false, "choices": null }, { "name": "security", "type": "IntrinioSecurity", "description": "The Intrinio Security object. Contains the security details related to the news article.", "default": null, "optional": true, "choices": null } ], "polygon": [ { "name": "source", "type": "str", "description": "Source of the article.", "default": null, "optional": true, "choices": null }, { "name": "tags", "type": "str", "description": "Keywords/tags in the article", "default": null, "optional": true, "choices": null }, { "name": "id", "type": "str", "description": "Article ID.", "default": "", "optional": false, "choices": null }, { "name": "amp_url", "type": "str", "description": "AMP URL.", "default": null, "optional": true, "choices": null }, { "name": "publisher", "type": "PolygonPublisher", "description": "Publisher of the article.", "default": "", "optional": false, "choices": null } ], "tiingo": [ { "name": "tags", "type": "str", "description": "Tags associated with the news article.", "default": null, "optional": true, "choices": null }, { "name": "article_id", "type": "int", "description": "Unique ID of the news article.", "default": "", "optional": false, "choices": null }, { "name": "source", "type": "str", "description": "News source.", "default": "", "optional": false, "choices": null }, { "name": "crawl_date", "type": "datetime", "description": "Date the news article was crawled.", "default": "", "optional": false, "choices": null } ], "yfinance": [ { "name": "source", "type": "str", "description": "Source of the news article", "default": null, "optional": true, "choices": null } ] }, "model": "CompanyNews", "openapi_extra": { "model": "CompanyNews" } }, "/regulators/sec/filing_headers": { "deprecated": { "flag": null, "message": null }, "description": "Download the index headers, and cover page if available, for any SEC filing.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.filing_headers(url=https://www.sec.gov/Archives/edgar/data/317540/000119312524076556/d645509ddef14a.htm, provider='sec')\n```\n\n", "parameters": { "standard": [], "sec": [ { "name": "url", "type": "str", "description": "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.", "default": "", "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Use cache for the index headers and cover page. Default is True.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SecFiling]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "base_url", "type": "str", "description": "Base URL of the filing.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the entity filing.", "default": "", "optional": false, "choices": null }, { "name": "cik", "type": "str", "description": "Central Index Key.", "default": "", "optional": false, "choices": null }, { "name": "trading_symbols", "type": "list", "description": "Trading symbols, if available.", "default": null, "optional": true, "choices": null }, { "name": "sic", "type": "str", "description": "Standard Industrial Classification.", "default": "", "optional": false, "choices": null }, { "name": "sic_organization_name", "type": "str", "description": "SIC Organization Name.", "default": "", "optional": false, "choices": null }, { "name": "filing_date", "type": "date", "description": "Filing date.", "default": "", "optional": false, "choices": null }, { "name": "period_ending", "type": "date", "description": "Date of the ending period for the filing, if available.", "default": null, "optional": true, "choices": null }, { "name": "fiscal_year_end", "type": "str", "description": "Fiscal year end of the entity, if available. Format: MM-DD", "default": null, "optional": true, "choices": null }, { "name": "document_type", "type": "str", "description": "Specific SEC filing type.", "default": "", "optional": false, "choices": null }, { "name": "has_cover_page", "type": "bool", "description": "True if the filing has a cover page.", "default": "", "optional": false, "choices": null }, { "name": "description", "type": "str", "description": "Description of attached content, mostly applicable to 8-K filings.", "default": null, "optional": true, "choices": null }, { "name": "cover_page", "type": "dict", "description": "Cover page information, if available.", "default": null, "optional": true, "choices": null }, { "name": "document_urls", "type": "list", "description": "list of files associated with the filing.", "default": "", "optional": false, "choices": null } ] }, "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": { "flag": null, "message": null }, "description": "Download a raw HTML object from the SEC website.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.htm_file(url=https://www.sec.gov/Archives/edgar/data/1723690/000119312525030074/d866336dex991.htm, provider='sec')\n```\n\n", "parameters": { "standard": [], "sec": [ { "name": "url", "type": "str", "description": "URL for the SEC filing.", "default": "", "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Cache the file for use later. Default is True.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SecHtmFile]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "url", "type": "str", "description": "URL of the downloaded file.", "default": "", "optional": false, "choices": null }, { "name": "content", "type": "str", "description": "Raw content of the HTM/HTML file.", "default": "", "optional": false, "choices": null } ] }, "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": { "flag": null, "message": null }, "description": "Map a ticker symbol to a CIK number.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.cik_map(symbol='MSFT', provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "symbol", "type": "str", "description": "Symbol to get data for.", "default": "", "optional": false, "choices": null } ], "sec": [ { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache for the request, default is True.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[CikMap]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "cik", "type": "Union[int, str]", "description": "Central Index Key (CIK) for the requested entity.", "default": null, "optional": true, "choices": null } ], "sec": [] }, "model": "CikMap", "openapi_extra": { "model": "CikMap" } }, "/regulators/sec/institutions_search": { "deprecated": { "flag": null, "message": null }, "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.institutions_search(provider='sec')\nobb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null } ], "sec": [ { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[InstitutionsSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "name", "type": "str", "description": "The name of the institution.", "default": null, "optional": true, "choices": null }, { "name": "cik", "type": "Union[int, str]", "description": "Central Index Key (CIK)", "default": null, "optional": true, "choices": null } ] }, "model": "InstitutionsSearch", "openapi_extra": { "model": "InstitutionsSearch" } }, "/regulators/sec/schema_files": { "deprecated": { "flag": null, "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", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null } ], "sec": [ { "name": "url", "type": "str", "description": "Enter an optional URL path to fetch the next level.", "default": null, "optional": true, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SchemaFiles]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "files", "type": "list[str]", "description": "Dictionary of URLs to SEC Schema Files", "default": "", "optional": false, "choices": null } ] }, "model": "SchemaFiles", "openapi_extra": { "model": "SchemaFiles" } }, "/regulators/sec/symbol_map": { "deprecated": { "flag": null, "message": null }, "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.symbol_map(query='0000789019', provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": false, "choices": null }, { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache. If True, cache will store for seven days.", "default": true, "optional": true, "choices": null } ], "sec": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SymbolMap]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": "", "optional": false, "choices": null } ] }, "model": "SymbolMap", "openapi_extra": { "model": "SymbolMap" } }, "/regulators/sec/rss_litigation": { "deprecated": { "flag": null, "message": null }, "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.rss_litigation(provider='sec')\n```\n\n", "parameters": { "standard": [], "sec": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[RssLitigation]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "published", "type": "datetime", "description": "The date of publication.", "default": "", "optional": false, "choices": null }, { "name": "title", "type": "str", "description": "The title of the release.", "default": "", "optional": false, "choices": null }, { "name": "summary", "type": "str", "description": "Short summary of the release.", "default": "", "optional": false, "choices": null }, { "name": "id", "type": "str", "description": "The identifier associated with the release.", "default": "", "optional": false, "choices": null }, { "name": "link", "type": "str", "description": "URL to the release.", "default": "", "optional": false, "choices": null } ] }, "model": "RssLitigation", "openapi_extra": { "model": "RssLitigation" } }, "/regulators/sec/sic_search": { "deprecated": { "flag": null, "message": null }, "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.sec.sic_search(provider='sec')\nobb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null } ], "sec": [ { "name": "use_cache", "type": "bool", "description": "Whether or not to use cache.", "default": true, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[SicSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['sec']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [], "sec": [ { "name": "sic", "type": "int", "description": "Sector Industrial Code (SIC)", "default": "", "optional": false, "choices": null }, { "name": "industry", "type": "str", "description": "Industry title.", "default": "", "optional": false, "choices": null }, { "name": "office", "type": "str", "description": "Reporting office within the Corporate Finance Office", "default": "", "optional": false, "choices": null } ] }, "model": "SicSearch", "openapi_extra": { "model": "SicSearch" } }, "/regulators/cftc/cot_search": { "deprecated": { "flag": null, "message": null }, "description": "Get the current Commitment of Traders Reports.\n\nSearch a list of the current Commitment of Traders Reports series information.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.regulators.cftc.cot_search(provider='cftc')\nobb.regulators.cftc.cot_search(query='gold', provider='cftc')\n```\n\n", "parameters": { "standard": [ { "name": "query", "type": "str", "description": "Search query.", "default": "", "optional": true, "choices": null } ], "cftc": [] }, "returns": { "OBBject": [ { "name": "results", "type": "list[COTSearch]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['cftc']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "code", "type": "str", "description": "CFTC market contract code of the report.", "default": "", "optional": false, "choices": null }, { "name": "name", "type": "str", "description": "Name of the underlying asset.", "default": "", "optional": false, "choices": null }, { "name": "category", "type": "str", "description": "Category of the underlying asset.", "default": null, "optional": true, "choices": null }, { "name": "subcategory", "type": "str", "description": "Subcategory of the underlying asset.", "default": null, "optional": true, "choices": null }, { "name": "units", "type": "str", "description": "The units for one contract.", "default": null, "optional": true, "choices": null }, { "name": "symbol", "type": "str", "description": "Symbol representing the entity requested in the data.", "default": null, "optional": true, "choices": null } ], "cftc": [ { "name": "commodity", "type": "str", "description": "Name of the commodity.", "default": null, "optional": true, "choices": null } ] }, "model": "COTSearch", "openapi_extra": { "model": "COTSearch" } }, "/regulators/cftc/cot": { "deprecated": { "flag": null, "message": null }, "description": "Get Commitment of Traders Reports.", "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\n# Get the latest report for all items classified as, GOLD.\nobb.regulators.cftc.cot(id='gold', provider='cftc')\n# Enter the entire history for a single CFTC Market Contract Code.\nobb.regulators.cftc.cot(id='088691', provider='cftc')\n# Get the report for futures only.\nobb.regulators.cftc.cot(id='088691', futures_only=True, provider='cftc')\n# Get the most recent Commodity Index Traders Supplemental Report.\nobb.regulators.cftc.cot(id='all', report_type=supplemental, provider='cftc')\n```\n\n", "parameters": { "standard": [ { "name": "id", "type": "str", "description": "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.", "default": "045601", "optional": true, "choices": null }, { "name": "start_date", "type": "Union[date, str]", "description": "Start date of the data, in YYYY-MM-DD format. Default is the most recent report.", "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 } ], "cftc": [ { "name": "report_type", "type": "Literal['legacy', 'disaggregated', 'financial', 'supplemental']", "description": "The type of report to retrieve. Set `id` as 'all' to return all items in the report\n type (default date range returns the latest report). The Legacy report is broken down by exchange\n with reported open interest further broken down into three trader classifications: commercial,\n non-commercial and non-reportable. The Disaggregated reports are broken down by Agriculture and\n Natural Resource contracts. The Disaggregated reports break down reportable open interest positions\n into four classifications: Producer/Merchant, Swap Dealers, Managed Money and Other Reportables.\n The Traders in Financial Futures (TFF) report includes financial contracts. The TFF report breaks\n down the reported open interest into five classifications: Dealer, Asset Manager, Leveraged Money,\n Other Reportables and Non-Reportables.", "default": "legacy", "optional": true, "choices": [ "legacy", "disaggregated", "financial", "supplemental" ] }, { "name": "futures_only", "type": "bool", "description": "Returns the futures-only report. Default is False, for the combined report.", "default": false, "optional": true, "choices": null } ] }, "returns": { "OBBject": [ { "name": "results", "type": "list[COT]", "description": "Serializable results." }, { "name": "provider", "type": "Optional[Literal['cftc']]", "description": "Provider name." }, { "name": "warnings", "type": "Optional[list[Warning_]]", "description": "list of warnings." }, { "name": "chart", "type": "Optional[Chart]", "description": "Chart object." }, { "name": "extra", "type": "dict[str, Any]", "description": "Extra info." } ] }, "data": { "standard": [ { "name": "date", "type": "Union[date, str]", "description": "The date of the data.", "default": "", "optional": false, "choices": null }, { "name": "report_week", "type": "str", "description": "Report week for the year.", "default": null, "optional": true, "choices": null }, { "name": "market_and_exchange_names", "type": "str", "description": "Market and exchange names.", "default": null, "optional": true, "choices": null }, { "name": "cftc_contract_market_code", "type": "str", "description": "CFTC contract market code.", "default": null, "optional": true, "choices": null }, { "name": "cftc_market_code", "type": "str", "description": "CFTC market code.", "default": null, "optional": true, "choices": null }, { "name": "cftc_region_code", "type": "str", "description": "CFTC region code.", "default": null, "optional": true, "choices": null }, { "name": "cftc_commodity_code", "type": "str", "description": "CFTC commodity code.", "default": null, "optional": true, "choices": null }, { "name": "cftc_contract_market_code_quotes", "type": "str", "description": "CFTC contract market code quotes.", "default": null, "optional": true, "choices": null }, { "name": "cftc_market_code_quotes", "type": "str", "description": "CFTC market code quotes.", "default": null, "optional": true, "choices": null }, { "name": "cftc_commodity_code_quotes", "type": "str", "description": "CFTC commodity code quotes.", "default": null, "optional": true, "choices": null }, { "name": "cftc_subgroup_code", "type": "str", "description": "CFTC subgroup code.", "default": null, "optional": true, "choices": null }, { "name": "commodity", "type": "str", "description": "Commodity.", "default": null, "optional": true, "choices": null }, { "name": "commodity_group", "type": "str", "description": "Commodity group name.", "default": null, "optional": true, "choices": null }, { "name": "commodity_subgroup", "type": "str", "description": "Commodity subgroup name.", "default": null, "optional": true, "choices": null }, { "name": "futonly_or_combined", "type": "str", "description": "If the report is futures-only or combined.", "default": null, "optional": true, "choices": null }, { "name": "contract_units", "type": "str", "description": "Contract units.", "default": null, "optional": true, "choices": null } ], "cftc": [] }, "model": "COT", "openapi_extra": { "model": "COT" } } }, "routers": { "/commodity": { "description": "Commodity market data." }, "/crypto": { "description": "Cryptocurrency market data." }, "/currency": { "description": "Foreign exchange (FX) market data." }, "/derivatives": { "description": "Derivatives market data." }, "/economy": { "description": "Economic data." }, "/equity": { "description": "Equity market data." }, "/etf": { "description": "Exchange Traded Funds market data." }, "/fixedincome": { "description": "Fixed Income market data." }, "/index": { "description": "Indices data." }, "/news": { "description": "Financial market news data." }, "/regulators": { "description": "Financial market regulators data." } } }