{ "functions": [ { "description": "Bring Your Own Data: single widget, own backend or native integration setup in OpenBB Terminal Pro.", "helpUrl": "https://docs.openbb.co/excel/data-connectors", "id": "BYOD", "name": "BYOD", "parameters": [ { "description": "Name of the widget to get data for.", "name": "widget", "type": "string" }, { "description": "Name of the backend to use, required for widgets in custom backends or native integrations (e.g. database, snowflake).", "name": "backend", "optional": true, "type": "string" }, { "description": "Symbol to get data for, if applicable.", "name": "symbol", "optional": true, "type": "string" }, { "description": "Date to get data for, if applicable.", "name": "date", "optional": true, "type": "string" }, { "description": "Optional parameters as (n rows by 2 columns) range selection or array constant (e.g. {\"key1\",\"value1\"}; {\"key2\",\"value2\"}).", "dimensionality": "matrix", "name": "optional", "optional": true, "type": "any" } ], "result": { "dimensionality": "matrix" } }, { "description": "Slice data from a range.", "helpUrl": "https://docs.openbb.co/excel/data-slicer", "id": "GET", "name": "GET", "parameters": [ { "description": "Array to slice.", "dimensionality": "matrix", "name": "array", "type": "any" }, { "description": "Range of row labels or indices.", "dimensionality": "matrix", "name": "rows", "optional": true, "type": "any" }, { "description": "Range of column labels or indices.", "dimensionality": "matrix", "name": "columns", "optional": true, "type": "any" } ], "result": { "dimensionality": "matrix" } }, { "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.", "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": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "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": "The base currency symbol. Multiple comma separated items allowed.", "name": "base", "optional": true, "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", "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": { "dimensionality": "matrix" } }, { "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": "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": "Country of the event. Multiple comma separated items allowed.", "name": "country", "optional": true, "type": "string" }, { "description": "Importance of the event. Options: Low, Medium, High.", "name": "importance", "optional": true, "type": "string" }, { "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": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.", "name": "calendar_id", "optional": true, "type": "any" } ], "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" } ], "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.", "name": "symbol", "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.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return. Options: quarter, annual.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "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.", "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.", "name": "page", "optional": true, "type": "number" }, { "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.", "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": "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": "any" }, { "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", "name": "importance", "optional": true, "type": "number" }, { "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": "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": "any" }, { "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed.", "name": "firm_ids", "optional": true, "type": "any" }, { "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": "any" }, { "description": "Include upgrades and downgrades in the response.", "name": "with_grade", "optional": true, "type": "boolean" } ], "result": { "dimensionality": "matrix" } }, { "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": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "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": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "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", "optional": true, "type": "string" }, { "description": "End date of the data, in YYYY-MM-DD format.", "name": "end_date", "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/fundamental/filings", "id": "EQUITY.FUNDAMENTAL.FILINGS", "name": "EQUITY.FUNDAMENTAL.FILINGS", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "optional": true, "type": "string" }, { "description": "Filter by form type. Check the data provider for available types.", "name": "form_type", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get historical earnings per share data for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_eps", "id": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", "name": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get historical stock splits for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_splits", "id": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", "name": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get the income statement for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income", "id": "EQUITY.FUNDAMENTAL.INCOME", "name": "EQUITY.FUNDAMENTAL.INCOME", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get executive management team data for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management", "id": "EQUITY.FUNDAMENTAL.MANAGEMENT", "name": "EQUITY.FUNDAMENTAL.MANAGEMENT", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get fundamental metrics for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/metrics", "id": "EQUITY.FUNDAMENTAL.METRICS", "name": "EQUITY.FUNDAMENTAL.METRICS", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" }, { "description": "Include trailing twelve months (TTM) data.", "name": "with_ttm", "optional": true, "type": "boolean" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get company general business and stock data for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/overview", "id": "EQUITY.FUNDAMENTAL.OVERVIEW", "name": "EQUITY.FUNDAMENTAL.OVERVIEW", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get an extensive set of financial and accounting ratios for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/ratios", "id": "EQUITY.FUNDAMENTAL.RATIOS", "name": "EQUITY.FUNDAMENTAL.RATIOS", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" }, { "description": "Include trailing twelve months (TTM) data.", "name": "with_ttm", "optional": true, "type": "boolean" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get the revenue geographic breakdown for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_geography", "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "Structure of the returned data.", "name": "structure", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get the revenue breakdown by business segment for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_segment", "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Time period of the data to return.", "name": "period", "optional": true, "type": "string" }, { "description": "Structure of the returned data.", "name": "structure", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get earnings call transcripts for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/transcript", "id": "EQUITY.FUNDAMENTAL.TRANSCRIPT", "name": "EQUITY.FUNDAMENTAL.TRANSCRIPT", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Year of the earnings call transcript.", "name": "year", "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get data about trading by a company's management team and board of directors.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/insider_trading", "id": "EQUITY.OWNERSHIP.INSIDER_TRADING", "name": "EQUITY.OWNERSHIP.INSIDER_TRADING", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" }, { "description": "Type of the transaction. Options: award, conversion, return, expire_short, in_kind, gift, expire_long, discretionary, other, small, exempt, otm, purchase, sale, tender, will, itm, trust.", "name": "transactionType", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get data about institutional ownership for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/institutional", "id": "EQUITY.OWNERSHIP.INSTITUTIONAL", "name": "EQUITY.OWNERSHIP.INSTITUTIONAL", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "Include current quarter data.", "name": "include_current_quarter", "optional": true, "type": "boolean" }, { "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get data about major holders for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/major_holders", "id": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", "name": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, { "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { "description": "Page number of the data to fetch.", "name": "page", "optional": true, "type": "number" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get data about share float for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/share_statistics", "id": "EQUITY.OWNERSHIP.SHARE_STATISTICS", "name": "EQUITY.OWNERSHIP.SHARE_STATISTICS", "parameters": [ { "description": "Symbol to get data for.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/historical", "id": "EQUITY.PRICE.HISTORICAL", "name": "EQUITY.PRICE.HISTORICAL", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, { "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "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" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get price performance data for a given stock. This includes price changes for different time periods.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/performance", "id": "EQUITY.PRICE.PERFORMANCE", "name": "EQUITY.PRICE.PERFORMANCE", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/quote", "id": "EQUITY.PRICE.QUOTE", "name": "EQUITY.PRICE.QUOTE", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get general information about a company. This includes company name, industry, sector and price data.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/profile", "id": "EQUITY.PROFILE", "name": "EQUITY.PROFILE", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get the holdings for an individual ETF.", "helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings", "id": "ETF.HOLDINGS", "name": "ETF.HOLDINGS", "parameters": [ { "description": "Symbol to get data for. (ETF)", "name": "symbol", "type": "string" }, { "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "ETF Information Overview.", "helpUrl": "https://docs.openbb.co/excel/reference/etf/info", "id": "ETF.INFO", "name": "ETF.INFO", "parameters": [ { "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed.", "name": "symbol", "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Get Historical Market Indices.", "helpUrl": "https://docs.openbb.co/excel/reference/index/market", "id": "INDEX.MARKET", "name": "INDEX.MARKET", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "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": "Time interval of the data to return.", "name": "interval", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "Company News. Get news for one or more companies.", "helpUrl": "https://docs.openbb.co/excel/reference/news/company", "id": "NEWS.COMPANY", "name": "NEWS.COMPANY", "parameters": [ { "description": "Symbol to get data for. Multiple comma separated items allowed.", "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": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { "description": "Number of seconds since the news was published.", "name": "published_since", "optional": true, "type": "number" }, { "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { "description": "The company's ISIN.", "name": "isin", "optional": true, "type": "string" }, { "description": "The company's CUSIP.", "name": "cusip", "optional": true, "type": "string" }, { "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { "description": "Content types of the news to retrieve.", "name": "content_types", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } }, { "description": "World News. Global news data.", "helpUrl": "https://docs.openbb.co/excel/reference/news/world", "id": "NEWS.WORLD", "name": "NEWS.WORLD", "parameters": [ { "description": "The number of data entries to return. The number of articles to return.", "name": "limit", "optional": true, "type": "number" }, { "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": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { "description": "Number of seconds since the news was published.", "name": "published_since", "optional": true, "type": "number" }, { "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { "description": "The ISIN of the news to retrieve.", "name": "isin", "optional": true, "type": "string" }, { "description": "The CUSIP of the news to retrieve.", "name": "cusip", "optional": true, "type": "string" }, { "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { "description": "Content types of the news to retrieve.", "name": "content_types", "optional": true, "type": "string" } ], "result": { "dimensionality": "matrix" } } ] }