From b7088a21073a8d9a64f55bc73fa2d4d0054b1624 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Fri, 14 Jun 2024 23:22:18 +0100 Subject: [Docs] Excel docs update (#6504) * update xl docs * update xl files --- website/content/excel/functions.json | 4465 +-- website/content/excel/openapi.json | 38273 +++++++++++++++----------- website/content/excel/openbb-functions.json | 173 + website/generate_excel_markdown.py | 96 +- 4 files changed, 23492 insertions(+), 19515 deletions(-) create mode 100644 website/content/excel/openbb-functions.json diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json index 1cebe7a1928..c86e1b29f05 100644 --- a/website/content/excel/functions.json +++ b/website/content/excel/functions.json @@ -73,13 +73,13 @@ } }, { - "description": "Get historical price data for cryptocurrency pair(s) within a provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/crypto/price/historical", - "id": "CRYPTO.PRICE.HISTORICAL", - "name": "CRYPTO.PRICE.HISTORICAL", + "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.", + "helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical", + "id": "CURRENCY.PRICE.HISTORICAL", + "name": "CURRENCY.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -96,28 +96,10 @@ "type": "string" }, { - "description": "Options: fmp, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time interval of the data to return. (provider: fmp);\nTime 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 (provider: polygon)", + "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "optional": true, "type": "string" - }, - { - "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. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", - "optional": true, - "type": "number" } ], "result": { @@ -125,22 +107,28 @@ } }, { - "description": "Search available cryptocurrency pairs within a provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/crypto/search", - "id": "CRYPTO.SEARCH", - "name": "CRYPTO.SEARCH", + "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", + "helpUrl": "https://docs.openbb.co/excel/reference/currency/snapshots", + "id": "CURRENCY.SNAPSHOTS", + "name": "CURRENCY.SNAPSHOTS", "parameters": [ { - "description": "Search query.", - "name": "query", + "description": "The base currency symbol. Multiple comma separated items allowed.", + "name": "base", "optional": true, "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", + "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.", + "name": "quote_type", "optional": true, "type": "string" + }, + { + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "name": "counter_currencies", + "optional": true, + "type": "any" } ], "result": { @@ -148,16 +136,11 @@ } }, { - "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.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical", - "id": "CURRENCY.PRICE.HISTORICAL", - "name": "CURRENCY.PRICE.HISTORICAL", + "description": "Get the upcoming, or historical, economic calendar of global events.", + "helpUrl": "https://docs.openbb.co/excel/reference/economy/calendar", + "id": "ECONOMY.CALENDAR", + "name": "ECONOMY.CALENDAR", "parameters": [ - { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "name": "symbol", - "type": "string" - }, { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", @@ -171,28 +154,28 @@ "type": "string" }, { - "description": "Options: fmp, polygon, defaults to fmp.", - "name": "provider", + "description": "Country of the event. Multiple comma separated items allowed.", + "name": "country", "optional": true, "type": "string" }, { - "description": "Time interval of the data to return. (provider: fmp);\nTime 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 (provider: polygon)", - "name": "interval", + "description": "Importance of the event. Options: Low, Medium, High.", + "name": "importance", "optional": true, "type": "string" }, { - "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. (provider: polygon)", - "name": "sort", + "description": "Grouping of events. Options: interest_rate, inflation, bonds, consumer, gdp, government, housing, labour, markets, money, prices, trade, business.", + "name": "group", "optional": true, "type": "string" }, { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.", + "name": "calendar_id", "optional": true, - "type": "number" + "type": "any" } ], "result": { @@ -200,15 +183,14 @@ } }, { - "description": "Current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/reference_rates", - "id": "CURRENCY.REFERENCE_RATES", - "name": "CURRENCY.REFERENCE_RATES", + "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.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/compare/peers", + "id": "EQUITY.COMPARE.PEERS", + "name": "EQUITY.COMPARE.PEERS", "parameters": [ { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" } ], @@ -217,58 +199,16 @@ } }, { - "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.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/search", - "id": "CURRENCY.SEARCH", - "name": "CURRENCY.SEARCH", + "description": "Get consensus price target and recommendation.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/consensus", + "id": "EQUITY.ESTIMATES.CONSENSUS", + "name": "EQUITY.ESTIMATES.CONSENSUS", "parameters": [ { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Symbol of the pair to search. (provider: polygon)", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "optional": true, "type": "string" - }, - { - "description": "A specific date to get data for. (provider: polygon)", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Search for terms within the ticker and/or company name. (provider: polygon)", - "name": "search", - "optional": true, - "type": "string" - }, - { - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)", - "name": "active", - "optional": true, - "type": "boolean" - }, - { - "description": "Order data by ascending or descending. (provider: polygon)", - "name": "order", - "optional": true, - "type": "string" - }, - { - "description": "Sort field used for ordering. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", - "optional": true, - "type": "number" } ], "result": { @@ -276,34 +216,27 @@ } }, { - "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/snapshots", - "id": "CURRENCY.SNAPSHOTS", - "name": "CURRENCY.SNAPSHOTS", + "description": "Get historical analyst estimates for earnings and revenue.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/historical", + "id": "EQUITY.ESTIMATES.HISTORICAL", + "name": "EQUITY.ESTIMATES.HISTORICAL", "parameters": [ { - "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.", - "name": "base", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "type": "string" }, { - "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.", - "name": "quote_type", + "description": "Time period of the data to return. Options: quarter, annual.", + "name": "period", "optional": true, "type": "string" }, { - "description": "An optional list of counter currency symbols to filter for. None returns all.", - "name": "counter_currencies", - "optional": true, - "type": "any" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" } ], "result": { @@ -311,98 +244,94 @@ } }, { - "description": "Get the complete options chain for a ticker.", - "helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/chains", - "id": "DERIVATIVES.OPTIONS.CHAINS", - "name": "DERIVATIVES.OPTIONS.CHAINS", + "description": "Get analyst price targets by company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/price_target", + "id": "EQUITY.ESTIMATES.PRICE_TARGET", + "name": "EQUITY.ESTIMATES.PRICE_TARGET", "parameters": [ { - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", + "optional": true, "type": "string" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" }, { - "description": "The end-of-day date for options chains data. (provider: intrinio)", - "name": "date", + "description": "Options: benzinga, fmp, defaults to benzinga.", + "name": "provider", "optional": true, "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the complete options chain for a ticker.", - "helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/unusual", - "id": "DERIVATIVES.OPTIONS.UNUSUAL", - "name": "DERIVATIVES.OPTIONS.UNUSUAL", - "parameters": [ + }, { - "description": "Symbol to get data for. (the underlying symbol)", - "name": "symbol", + "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.", + "name": "page", "optional": true, - "type": "string" + "type": "number" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "name": "date", "optional": true, "type": "string" }, { - "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. (provider: intrinio)", + "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio)", + "description": "End date of the data, in YYYY-MM-DD format.", "name": "end_date", "optional": true, "type": "string" }, { - "description": "The type of unusual activity to query for. (provider: intrinio)", - "name": "trade_type", + "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.", + "name": "updated", "optional": true, - "type": "string" + "type": "any" + }, + { + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "name": "importance", + "optional": true, + "type": "number" }, { - "description": "The sentiment type to query for. (provider: intrinio)", - "name": "sentiment", + "description": "Filter by a specific action_company. Options: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates, terminates, removes, suspends, firm_dissolved.", + "name": "action", "optional": true, "type": "string" }, { - "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)", - "name": "min_value", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed.", + "name": "analyst_ids", "optional": true, - "type": "number" + "type": "any" }, { - "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)", - "name": "max_value", + "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed.", + "name": "firm_ids", "optional": true, - "type": "number" + "type": "any" }, { - "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. (provider: intrinio)", - "name": "limit", + "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 comma separated items allowed.", + "name": "fields", "optional": true, - "type": "number" + "type": "any" }, { - "description": "The source of the data. Either realtime or delayed. (provider: intrinio)", - "name": "source", + "description": "Include upgrades and downgrades in the response.", + "name": "with_grade", "optional": true, - "type": "string" + "type": "boolean" } ], "result": { @@ -410,34 +339,27 @@ } }, { - "description": "Balance of Payments Reports.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/balance_of_payments", - "id": "ECONOMY.BALANCE_OF_PAYMENTS", - "name": "ECONOMY.BALANCE_OF_PAYMENTS", + "description": "Get the balance sheet for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance", + "id": "EQUITY.FUNDAMENTAL.BALANCE", + "name": "EQUITY.FUNDAMENTAL.BALANCE", "parameters": [ { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The report type, the level of detail in the data. (provider: ecb)", - "name": "report_type", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)", - "name": "frequency", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)", - "name": "country", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "any" + "type": "number" } ], "result": { @@ -445,46 +367,27 @@ } }, { - "description": "Get the upcoming, or historical, economic calendar of global events.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/calendar", - "id": "ECONOMY.CALENDAR", - "name": "ECONOMY.CALENDAR", + "description": "Get the cash flow statement for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash", + "id": "EQUITY.FUNDAMENTAL.CASH", + "name": "EQUITY.FUNDAMENTAL.CASH", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, tradingeconomics, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", - "name": "country", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "Importance of the event. (provider: tradingeconomics)", - "name": "importance", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Grouping of events (provider: tradingeconomics)", - "name": "group", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" } ], "result": { @@ -492,11 +395,16 @@ } }, { - "description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/composite_leading_indicator", - "id": "ECONOMY.COMPOSITE_LEADING_INDICATOR", - "name": "ECONOMY.COMPOSITE_LEADING_INDICATOR", + "description": "Get historical dividend data for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/dividends", + "id": "EQUITY.FUNDAMENTAL.DIVIDENDS", + "name": "EQUITY.FUNDAMENTAL.DIVIDENDS", "parameters": [ + { + "description": "Symbol to get data for.", + "name": "symbol", + "type": "string" + }, { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", @@ -508,18 +416,6 @@ "name": "end_date", "optional": true, "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" } ], "result": { @@ -527,3402 +423,28 @@ } }, { - "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/cpi", - "id": "ECONOMY.CPI", - "name": "ECONOMY.CPI", + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings 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.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/filings", + "id": "EQUITY.FUNDAMENTAL.FILINGS", + "name": "EQUITY.FUNDAMENTAL.FILINGS", "parameters": [ { - "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred.", - "name": "country", - "type": "string" - }, - { - "description": "The unit of measurement for the data.\nOptions:\n- `growth_previous`: Percent growth from the previous period.\nIf monthly data, this is month-over-month, etc\n- `growth_same`: Percent growth from the same period in the previous year.\nIf looking at monthly data, this would be year-over-year, etc.\n- `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "The frequency of the data.\nOptions: `monthly`, `quarter`, and `annual`.", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "Whether you wish to obtain harmonized data.", - "name": "harmonized", - "optional": true, - "type": "boolean" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Query the Geo Fred API for regional economic data by series group.\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_regional", - "id": "ECONOMY.FRED_REGIONAL", - "name": "ECONOMY.FRED_REGIONAL", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)", - "name": "is_series_group", - "optional": true, - "type": "boolean" - }, - { - "description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)", - "name": "region_type", - "optional": true, - "type": "string" - }, - { - "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)", - "name": "season", - "optional": true, - "type": "string" - }, - { - "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. (provider: fred)", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "Frequency aggregation to convert high frequency data to lower frequency.\nParameter is only valid when `is_series_group` is True.\na = Annual\nsa= Semiannual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\nOnly valid when `is_series_group` is True.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)", - "name": "aggregation_method", - "optional": true, - "type": "string" - }, - { - "description": "Transformation type. Only valid when `is_series_group` is True.\nlin = Levels (No transformation)\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)", - "name": "transform", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for FRED series or economic releases by ID or string.\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_search", - "id": "ECONOMY.FRED_SEARCH", - "name": "ECONOMY.FRED_SEARCH", - "parameters": [ - { - "description": "The search word(s).", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. (provider: fred)", - "name": "is_release", - "optional": true, - "type": "boolean" - }, - { - "description": "A specific release ID to target. (provider: fred)", - "name": "release_id", - "optional": true, - "type": "any" - }, - { - "description": "The number of data entries to return. (1-1000) (provider: fred)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Offset the results in conjunction with limit. (provider: fred)", - "name": "offset", - "optional": true, - "type": "number" - }, - { - "description": "Filter by an attribute. (provider: fred)", - "name": "filter_variable", - "optional": true, - "type": "any" - }, - { - "description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)", - "name": "filter_value", - "optional": true, - "type": "string" - }, - { - "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)", - "name": "tag_names", - "optional": true, - "type": "string" - }, - { - "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. (provider: fred)", - "name": "exclude_tag_names", - "optional": true, - "type": "string" - }, - { - "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. (provider: fred)", - "name": "series_id", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data by series ID from FRED.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_series", - "id": "ECONOMY.FRED_SERIES", - "name": "ECONOMY.FRED_SERIES", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.", - "name": "symbol", - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fred, intrinio, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Frequency aggregation to convert high frequency data to lower frequency.\nNone = No change\na = Annual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)", - "name": "frequency", - "optional": true, - "type": "any" - }, - { - "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)", - "name": "aggregation_method", - "optional": true, - "type": "any" - }, - { - "description": "Transformation type\nNone = No transformation\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)", - "name": "transform", - "optional": true, - "type": "any" - }, - { - "description": "Returns all pages of data from the API call at once. (provider: intrinio)", - "name": "all_pages", - "optional": true, - "type": "boolean" - }, - { - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", - "name": "sleep", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Forecasted GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/forecast", - "id": "ECONOMY.GDP.FORECAST", - "name": "ECONOMY.GDP.FORECAST", - "parameters": [ - { - "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Type of GDP to get forecast of. Either nominal or real.", - "name": "type", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Nominal GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/nominal", - "id": "ECONOMY.GDP.NOMINAL", - "name": "ECONOMY.GDP.NOMINAL", - "parameters": [ - { - "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Real GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/real", - "id": "ECONOMY.GDP.REAL", - "name": "ECONOMY.GDP.REAL", - "parameters": [ - { - "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Long-term interest rates refer to government bonds maturing in ten years.\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.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/long_term_interest_rate", - "id": "ECONOMY.LONG_TERM_INTEREST_RATE", - "name": "ECONOMY.LONG_TERM_INTEREST_RATE", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get interest rate for for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/money_measures", - "id": "ECONOMY.MONEY_MEASURES", - "name": "ECONOMY.MONEY_MEASURES", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Whether to return seasonally adjusted data.", - "name": "adjusted", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: federal_reserve, defaults to federal_reserve.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Market Risk Premium by country.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/risk_premium", - "id": "ECONOMY.RISK_PREMIUM", - "name": "ECONOMY.RISK_PREMIUM", - "parameters": [ - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Short-term interest rates 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.\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\".", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/short_term_interest_rate", - "id": "ECONOMY.SHORT_TERM_INTEREST_RATE", - "name": "ECONOMY.SHORT_TERM_INTEREST_RATE", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get interest rate for for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Global unemployment data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/unemployment", - "id": "ECONOMY.UNEMPLOYMENT", - "name": "ECONOMY.UNEMPLOYMENT", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Sex to get unemployment for. (provider: oecd)", - "name": "sex", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get unemployment for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "Age group to get unemployment for. Total indicates 15 years or over (provider: oecd)", - "name": "age", - "optional": true, - "type": "string" - }, - { - "description": "Whether to get seasonally adjusted unemployment. Defaults to False. (provider: oecd)", - "name": "seasonal_adjustment", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/dividend", - "id": "EQUITY.CALENDAR.DIVIDEND", - "name": "EQUITY.CALENDAR.DIVIDEND", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/earnings", - "id": "EQUITY.CALENDAR.EARNINGS", - "name": "EQUITY.CALENDAR.EARNINGS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming initial public offerings (IPOs).", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/ipo", - "id": "EQUITY.CALENDAR.IPO", - "name": "EQUITY.CALENDAR.IPO", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)", - "name": "status", - "optional": true, - "type": "string" - }, - { - "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)", - "name": "offer_amount_greater_than", - "optional": true, - "type": "number" - }, - { - "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)", - "name": "offer_amount_less_than", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming stock split operations.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/splits", - "id": "EQUITY.CALENDAR.SPLITS", - "name": "EQUITY.CALENDAR.SPLITS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "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.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/compare/peers", - "id": "EQUITY.COMPARE.PEERS", - "name": "EQUITY.COMPARE.PEERS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings 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.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/discovery/filings", - "id": "EQUITY.DISCOVERY.FILINGS", - "name": "EQUITY.DISCOVERY.FILINGS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", - "name": "form_type", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Flag for whether or not the filing is done. (provider: fmp)", - "name": "isDone", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for specific analysts and get their forecast track record.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/analyst_search", - "id": "EQUITY.ESTIMATES.ANALYST_SEARCH", - "name": "EQUITY.ESTIMATES.ANALYST_SEARCH", - "parameters": [ - { - "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga.", - "name": "analyst_name", - "optional": true, - "type": "string" - }, - { - "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga.", - "name": "firm_name", - "optional": true, - "type": "string" - }, - { - "description": "Options: benzinga, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "analyst_ids", - "optional": true, - "type": "string" - }, - { - "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "firm_ids", - "optional": true, - "type": "string" - }, - { - "description": "Number of results returned. Limit 1000. (provider: benzinga)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "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. (provider: benzinga)", - "name": "page", - "optional": true, - "type": "number" - }, - { - "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga)", - "name": "fields", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get consensus price target and recommendation.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/consensus", - "id": "EQUITY.ESTIMATES.CONSENSUS", - "name": "EQUITY.ESTIMATES.CONSENSUS", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical analyst estimates for earnings and revenue.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/historical", - "id": "EQUITY.ESTIMATES.HISTORICAL", - "name": "EQUITY.ESTIMATES.HISTORICAL", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time period of the data to return. (provider: fmp)", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: fmp)", - "name": "limit", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get analyst price targets by company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/price_target", - "id": "EQUITY.ESTIMATES.PRICE_TARGET", - "name": "EQUITY.ESTIMATES.PRICE_TARGET", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", - "name": "symbol", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: benzinga, fmp, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "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. (provider: benzinga)", - "name": "page", - "optional": true, - "type": "number" - }, - { - "description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format. (provider: benzinga)", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "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. (provider: benzinga)", - "name": "updated", - "optional": true, - "type": "any" - }, - { - "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)", - "name": "importance", - "optional": true, - "type": "number" - }, - { - "description": "Filter by a specific action_company. (provider: benzinga)", - "name": "action", - "optional": true, - "type": "string" - }, - { - "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)", - "