From 741bb624fe75cbdccccb2d9ae15d18844fc70551 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:54:45 +0000 Subject: [Docs] - Update BYOD page (#6207) * update byod docs * regenerate docs --------- Co-authored-by: Luqman --- website/content/excel/data-connectors.md | 36 +- website/content/excel/functions.json | 283 +++++---- website/content/excel/openapi.json | 957 +++++++++++++++++++------------ 3 files changed, 776 insertions(+), 500 deletions(-) diff --git a/website/content/excel/data-connectors.md b/website/content/excel/data-connectors.md index 4094df81e40..2fda0f8deb6 100644 --- a/website/content/excel/data-connectors.md +++ b/website/content/excel/data-connectors.md @@ -18,29 +18,55 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; OpenBB Add-In for Excel allows you to access your [data connectors](https://docs.openbb.co/pro/main-menu/data-connectors) from OpenBB Terminal Pro inside Microsoft Excel. This can be done using the [OBB.BYOD](https://docs.openbb.co/excel/reference/byod) function. -To access data from a [single widget](https://docs.openbb.co/pro/main-menu/data-connectors/single-widget) use: +## [Single widget](https://docs.openbb.co/pro/main-menu/data-connectors/single-widget) ```excel =OBB.BYOD("widget_name") ``` -To access data from your own [backend](https://docs.openbb.co/pro/main-menu/data-connectors/integrate-your-own-backend) use: +:::info + +- Make sure your widget is setup in the OpenBB Terminal Pro. + +::: + +## [Own backend](https://docs.openbb.co/pro/main-menu/data-connectors/integrate-your-own-backend) ```excel =OBB.BYOD("widget_name","backend_name") ``` -If your backend supports it is possible to pass a symbol, date or other optional parameters: +If your backend supports it is possible to pass a symbol, a date or other optional parameters: ```excel -=OBB.BYOD("widget_name","backend_name","my_symbol","my_date",{"param1":"value1","param2":"value2", ...}) +=OBB.BYOD("widget_name","backend_name","my_symbol","YYYY-MM-DD",{"param1":"value1","param2":"value2", ...}) ``` :::tip The easiest way to pass optional parameters is to write them into cells and reference them in the function. For example, `=OBB.BYOD(...,A1:B2)` where A1 contains "param1", B1 "value1", A2 "param2", B2 "value2" and so on. ::: -#### Additional notes +:::info - Make sure your backend's CORS settings allow requests coming from . - Requests via HTTP will be blocked by Excel. So if you are using the Add-in for Excel on Mac or Office on the web with Safari browser you need to run your backend via HTTPS. + +::: + +## [Native integrations](https://docs.openbb.co/pro/main-menu/data-connectors#native-integrations) + +Supported native integrations: + +- database +- snowflake + +```excel +=OBB.BYOD("widget_name","native_integration") +``` + +:::info + +- Make sure your OpenBB Data Connector is properly configured and the widget is setup in the OpenBB Terminal Pro. +- Native integrations are available only for Excel on the web or Windows. + +::: diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json index e4f8c0506ab..e93a51521c4 100644 --- a/website/content/excel/functions.json +++ b/website/content/excel/functions.json @@ -1,38 +1,7 @@ { "functions": [ { - "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": "Bring Your Own Data features from OpenBB Terminal Pro.", + "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", @@ -43,7 +12,7 @@ "type": "string" }, { - "description": "Name of the backend to use, required for widgets in custom backends.", + "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" @@ -72,6 +41,37 @@ "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": "Get historical price data for cryptocurrency pair(s) within a provider.", "helpUrl": "https://docs.openbb.co/excel/reference/crypto/price/historical", @@ -79,7 +79,7 @@ "name": "CRYPTO.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: fmp, polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon.", "name": "symbol", "type": "string" }, @@ -167,7 +167,7 @@ "name": "CURRENCY.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon.", "name": "symbol", "type": "string" }, @@ -469,7 +469,7 @@ "name": "ECONOMY.CPI", "parameters": [ { - "description": "The country to get data. Multiple items allowed: fred.", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", "name": "country", "type": "string" }, @@ -521,7 +521,7 @@ "name": "ECONOMY.FRED_REGIONAL", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fred.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "name": "symbol", "type": "string" }, @@ -680,7 +680,7 @@ "name": "ECONOMY.FRED_SERIES", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fred.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "name": "symbol", "type": "string" }, @@ -1066,7 +1066,7 @@ } }, { - "description": "Upcoming and Historical Dividend Calendar.", + "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", @@ -1095,7 +1095,7 @@ } }, { - "description": "Upcoming and Historical earnings calendar.", + "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", @@ -1124,7 +1124,7 @@ } }, { - "description": "Upcoming and Historical IPO Calendar.", + "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", @@ -1183,7 +1183,7 @@ } }, { - "description": "Calendar Splits. Show Stock Split Calendar.", + "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", @@ -1212,7 +1212,7 @@ } }, { - "description": "Equity Peers. Company peers.", + "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", @@ -1234,7 +1234,7 @@ } }, { - "description": "Get the most-recent filings submitted to the SEC.", + "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", @@ -1340,7 +1340,7 @@ } }, { - "description": "Consensus price target and recommendation.", + "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", @@ -1362,7 +1362,7 @@ } }, { - "description": "Historical analyst estimates for earnings and revenue.", + "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", @@ -1396,13 +1396,13 @@ } }, { - "description": "Analyst price targets by company.", + "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 items allowed: benzinga.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.", "name": "symbol", "optional": true, "type": "string" @@ -1491,7 +1491,7 @@ } }, { - "description": "Balance Sheet. Balance sheet statement.", + "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", @@ -1609,7 +1609,7 @@ } }, { - "description": "Balance Sheet Statement Growth. Information about the growth of the company balance sheet.", + "description": "Get the growth of a company's balance sheet items over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance_growth", "id": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH", "name": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH", @@ -1637,7 +1637,7 @@ } }, { - "description": "Cash Flow Statement. Information about the cash flow statement.", + "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", @@ -1755,7 +1755,7 @@ } }, { - "description": "Cash Flow Statement Growth. Information about the growth of the company cash flow statement.", + "description": "Get the growth of a company's cash flow statement items over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash_growth", "id": "EQUITY.FUNDAMENTAL.CASH_GROWTH", "name": "EQUITY.FUNDAMENTAL.CASH_GROWTH", @@ -1783,7 +1783,7 @@ } }, { - "description": "Historical Dividends. Historical dividends data for a given company.", + "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", @@ -1823,7 +1823,7 @@ } }, { - "description": "Historical Employees. Historical number of employees.", + "description": "Get historical employee count data for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/employee_count", "id": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT", "name": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT", @@ -1845,7 +1845,7 @@ } }, { - "description": "Company Filings. Company filings data.", + "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", @@ -1916,18 +1916,18 @@ } }, { - "description": "Fetch the historical values of a data tag from Intrinio.", + "description": "Get the historical values of a data tag from Intrinio.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_attributes", "id": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES", "name": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "name": "symbol", "type": "string" }, { - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio.", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "name": "tag", "type": "string" }, @@ -1979,7 +1979,7 @@ } }, { - "description": "Historical earnings-per-share for a given company.", + "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", @@ -2007,7 +2007,7 @@ } }, { - "description": "Historical Splits. Historical splits data.", + "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", @@ -2029,7 +2029,7 @@ } }, { - "description": "Income Statement. Report on a company's financial performance.", + "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", @@ -2147,7 +2147,7 @@ } }, { - "description": "Income Statement Growth. Information about the growth of the company income statement.", + "description": "Get the growth of a company's income statement items over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income_growth", "id": "EQUITY.FUNDAMENTAL.INCOME_GROWTH", "name": "EQUITY.FUNDAMENTAL.INCOME_GROWTH", @@ -2181,18 +2181,18 @@ } }, { - "description": "Fetch the latest value of a data tag from Intrinio.", + "description": "Get the latest value of a data tag from Intrinio.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/latest_attributes", "id": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES", "name": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "name": "symbol", "type": "string" }, { - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio.", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "name": "tag", "type": "string" }, @@ -2208,7 +2208,7 @@ } }, { - "description": "Key Executives. Key executives for a given company.", + "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", @@ -2230,13 +2230,13 @@ } }, { - "description": "Get Executive Compensation. Information about the executive compensation for a given company.", + "description": "Get executive management team compensation for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management_compensation", "id": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION", "name": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -2264,13 +2264,13 @@ } }, { - "description": "Key Metrics. Key metrics for a given company.", + "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 items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -2304,13 +2304,13 @@ } }, { - "description": "Equity Valuation Multiples. Valuation multiples for a stock ticker.", + "description": "Get equity valuation multiples for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/multiples", "id": "EQUITY.FUNDAMENTAL.MULTIPLES", "name": "EQUITY.FUNDAMENTAL.MULTIPLES", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -2326,7 +2326,7 @@ } }, { - "description": "Company Overview. General information about a company.", + "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", @@ -2348,13 +2348,13 @@ } }, { - "description": "Extensive set of ratios over time. Financial ratios for a given company.", + "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 items allowed: fmp, intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "name": "symbol", "type": "string" }, @@ -2394,7 +2394,7 @@ } }, { - "description": "Financial statements, as-reported.", + "description": "Get financial statements as reported by the company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/reported_financials", "id": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS", "name": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS", @@ -2440,7 +2440,7 @@ } }, { - "description": "Revenue Geographic. Geographic revenue data.", + "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", @@ -2474,7 +2474,7 @@ } }, { - "description": "Revenue Business Line. Business line revenue data.", + "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", @@ -2508,7 +2508,7 @@ } }, { - "description": "Search Intrinio data tags.", + "description": "Search Intrinio data tags to search in latest or historical attributes.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/search_attributes", "id": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES", "name": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES", @@ -2536,7 +2536,7 @@ } }, { - "description": "Trailing 1yr dividend yield.", + "description": "Get the 1 year trailing dividend yield for a given company over time.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/trailing_dividend_yield", "id": "EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD", "name": "EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD", @@ -2565,7 +2565,7 @@ } }, { - "description": "Earnings Call Transcript. Earnings call transcript for a given company.", + "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", @@ -2599,7 +2599,7 @@ } }, { - "description": "Get a current, complete, market snapshot.", + "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/market_snapshots", "id": "EQUITY.MARKET_SNAPSHOTS", "name": "EQUITY.MARKET_SNAPSHOTS", @@ -2622,7 +2622,7 @@ } }, { - "description": "Insider Trading. Information about insider trading.", + "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", @@ -2680,7 +2680,7 @@ } }, { - "description": "Institutional Ownership. Institutional ownership data.", + "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", @@ -2720,7 +2720,47 @@ } }, { - "description": "Share Statistics. Share statistics for a given company.", + "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" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { + "description": "Number of records to return. (Ignores page if set. Default: None) (provider: fmp)", + "name": "limit", + "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", @@ -2742,13 +2782,13 @@ } }, { - "description": "Equity Historical price. Load stock data for a specific ticker.", + "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 items allowed: fmp, polygon, tiingo.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo.", "name": "symbol", "type": "string" }, @@ -2830,7 +2870,7 @@ } }, { - "description": "Equity NBBO. Load National Best Bid and Offer for a specific equity.", + "description": "Get the National Best Bid and Offer for a given stock.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/nbbo", "id": "EQUITY.PRICE.NBBO", "name": "EQUITY.PRICE.NBBO", @@ -2888,13 +2928,13 @@ } }, { - "description": "Price performance as a return, over different periods.", + "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 items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -2910,13 +2950,13 @@ } }, { - "description": "Equity Quote. Load stock data for a specific ticker.", + "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. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: fmp, intrinio.", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio.", "name": "symbol", "type": "string" }, @@ -2938,13 +2978,13 @@ } }, { - "description": "Equity Info. Get general price and performance metrics of a stock.", + "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 items allowed: fmp, intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "name": "symbol", "type": "string" }, @@ -2960,7 +3000,7 @@ } }, { - "description": "Equity Screen. Screen for companies meeting various criteria.", + "description": "Screen for companies meeting various criteria. These criteria include\nmarket cap, price, beta, volume, and dividend yield.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/screener", "id": "EQUITY.SCREENER", "name": "EQUITY.SCREENER", @@ -3079,7 +3119,7 @@ } }, { - "description": "Equity Search. Search for a company or stock ticker.", + "description": "Search for stock symbol, CIK, LEI, or company name.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/search", "id": "EQUITY.SEARCH", "name": "EQUITY.SEARCH", @@ -3172,7 +3212,7 @@ "name": "ETF.COUNTRIES", "parameters": [ { - "description": "Symbol to get data for. (ETF) Multiple items allowed: fmp.", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3194,7 +3234,7 @@ "name": "ETF.EQUITY_EXPOSURE", "parameters": [ { - "description": "Symbol to get data for. (Stock) Multiple items allowed: fmp.", + "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3284,7 +3324,7 @@ "name": "ETF.HOLDINGS_PERFORMANCE", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3306,7 +3346,7 @@ "name": "ETF.INFO", "parameters": [ { - "description": "Symbol to get data for. (ETF) Multiple items allowed: fmp.", + "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3328,7 +3368,7 @@ "name": "ETF.PRICE_PERFORMANCE", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3632,20 +3672,20 @@ "type": "string" }, { - "description": "The yield curve type.", - "name": "yield_curve_type", + "description": "Options: ecb, defaults to ecb.", + "name": "provider", "optional": true, "type": "string" }, { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", + "name": "rating", "optional": true, "type": "string" }, { - "description": "The rating type. (provider: ecb)", - "name": "rating", + "description": "The yield curve type. (provider: ecb)", + "name": "yield_curve_type", "optional": true, "type": "string" } @@ -4138,8 +4178,8 @@ "name": "INDEX.CONSTITUENTS", "parameters": [ { - "description": "Index to fetch the constituents of.", - "name": "index", + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { @@ -4254,7 +4294,7 @@ "name": "INDEX.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: intrinio, polygon.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio, polygon.", "name": "symbol", "type": "string" }, @@ -4312,15 +4352,10 @@ "name": "NEWS.COMPANY", "parameters": [ { - "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: benzinga, intrinio.", + "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo.", "name": "symbol", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", "optional": true, - "type": "number" + "type": "string" }, { "description": "Start date of the data, in YYYY-MM-DD format.", @@ -4334,6 +4369,12 @@ "optional": true, "type": "string" }, + { + "description": "The number of data entries to return.", + "name": "limit", + "optional": true, + "type": "number" + }, { "description": "Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga.", "name": "provider", @@ -4419,10 +4460,10 @@ "type": "number" }, { - "description": "Date query to fetch articles. Supports operators <, <=, >, >= (provider: polygon)", - "name": "published_utc", + "description": "Page offset, used in conjunction with limit. (provider: tiingo)", + "name": "offset", "optional": true, - "type": "string" + "type": "number" }, { "description": "A comma-separated list of the domains requested. (provider: tiingo)", @@ -4561,7 +4602,7 @@ "name": "REGULATORS.SEC.CIK_MAP", "parameters": [ { - "description": "Symbol to get data for. Multiple items allowed: fmp, intrinio.", + "description": "Symbol to get data for.", "name": "symbol", "type": "string" }, diff --git a/website/content/excel/openapi.json b/website/content/excel/openapi.json index 7293340bcdf..f986aefdd43 100644 --- a/website/content/excel/openapi.json +++ b/website/content/excel/openapi.json @@ -50,14 +50,14 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: fmp, polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon.", "multiple_items_allowed": [ "fmp", "polygon" ], "title": "Symbol" }, - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: fmp, polygon." + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon." }, { "name": "start_date", @@ -379,13 +379,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon.", "multiple_items_allowed": [ "polygon" ], "title": "Symbol" }, - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: polygon." + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon." }, { "name": "start_date", @@ -598,8 +598,7 @@ } ], "title": "polygon", - "description": "A specific date to get data for. (provider: polygon)", - "default": "2024-02-27" + "description": "A specific date to get data for. (provider: polygon)" }, "description": "A specific date to get data for. (provider: polygon)" }, @@ -1897,13 +1896,13 @@ "required": true, "schema": { "type": "string", - "description": "The country to get data. Multiple items allowed: fred.", + "description": "The country to get data. Multiple items allowed for provider(s): fred.", "multiple_items_allowed": [ "fred" ], "title": "Country" }, - "description": "The country to get data. Multiple items allowed: fred." + "description": "The country to get data. Multiple items allowed for provider(s): fred." }, { "name": "units", @@ -2552,13 +2551,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fred.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "multiple_items_allowed": [ "fred" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fred." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred." }, { "name": "start_date", @@ -3713,13 +3712,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fred.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", "multiple_items_allowed": [ "fred" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fred." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fred." }, { "name": "start_date", @@ -3997,7 +3996,7 @@ "equity" ], "summary": "Ipo", - "description": "Upcoming and Historical IPO Calendar.", + "description": "Get historical and upcoming initial public offerings (IPOs).", "operationId": "equity_calendar_ipo", "security": [ { @@ -4197,7 +4196,11 @@ }, "model": "CalendarIpo", "examples": [ - "obb.equity.calendar.ipo(limit=100)" + "obb.equity.calendar.ipo(limit=100)", + "# Get all IPOs available.", + "obb.equity.calendar.ipo()", + "# Get IPOs for specific dates.", + "obb.equity.calendar.ipo(start_date='2024-02-01', end_date='2024-02-07')" ] } }, @@ -4207,7 +4210,7 @@ "equity" ], "summary": "Dividend", - "description": "Upcoming and Historical Dividend Calendar.", + "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", "operationId": "equity_calendar_dividend", "security": [ { @@ -4311,7 +4314,9 @@ }, "model": "CalendarDividend", "examples": [ - "obb.equity.calendar.dividend()" + "obb.equity.calendar.dividend()", + "# Get dividend calendar for specific dates.", + "obb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07')" ] } }, @@ -4321,7 +4326,7 @@ "equity" ], "summary": "Splits", - "description": "Calendar Splits. Show Stock Split Calendar.", + "description": "Get historical and upcoming stock split operations.", "operationId": "equity_calendar_splits", "security": [ { @@ -4425,7 +4430,9 @@ }, "model": "CalendarSplits", "examples": [ - "obb.equity.calendar.splits()" + "obb.equity.calendar.splits()", + "# Get stock splits calendar for specific dates.", + "obb.equity.calendar.splits(start_date='2024-02-01', end_date='2024-02-07')" ] } }, @@ -4435,7 +4442,7 @@ "equity" ], "summary": "Earnings", - "description": "Upcoming and Historical earnings calendar.", + "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", "operationId": "equity_calendar_earnings", "security": [ { @@ -4539,7 +4546,9 @@ }, "model": "CalendarEarnings", "examples": [ - "obb.equity.calendar.earnings()" + "obb.equity.calendar.earnings()", + "# Get earnings calendar for specific dates.", + "obb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07')" ] } }, @@ -4549,7 +4558,7 @@ "equity" ], "summary": "Peers", - "description": "Equity Peers. Company peers.", + "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.", "operationId": "equity_compare_peers", "security": [ { @@ -4636,7 +4645,7 @@ "equity" ], "summary": "Price Target", - "description": "Analyst price targets by company.", + "description": "Get analyst price targets by company.", "operationId": "equity_estimates_price_target", "security": [ { @@ -4670,13 +4679,13 @@ "type": "null" } ], - "description": "Symbol to get data for. Multiple items allowed: benzinga.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.", "multiple_items_allowed": [ "benzinga" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: benzinga." + "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga." }, { "name": "limit", @@ -4988,7 +4997,7 @@ "equity" ], "summary": "Historical", - "description": "Historical analyst estimates for earnings and revenue.", + "description": "Get historical analyst estimates for earnings and revenue.", "operationId": "equity_estimates_historical", "security": [ { @@ -5103,7 +5112,7 @@ "equity" ], "summary": "Consensus", - "description": "Consensus price target and recommendation.", + "description": "Get consensus price target and recommendation.", "operationId": "equity_estimates_consensus", "security": [ { @@ -5412,7 +5421,7 @@ "equity" ], "summary": "Filings", - "description": "Get the most-recent filings submitted to the SEC.", + "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.", "operationId": "equity_discovery_filings", "security": [ { @@ -5564,7 +5573,9 @@ }, "model": "DiscoveryFilings", "examples": [ - "obb.equity.discovery.filings(limit=100)" + "obb.equity.discovery.filings(limit=100)", + "# Get filings for the year 2023, limited to 100 results", + "obb.equity.discovery.filings(start_date='2023-01-01', end_date='2023-12-31')" ] } }, @@ -5574,7 +5585,7 @@ "equity" ], "summary": "Multiples", - "description": "Equity Valuation Multiples. Valuation multiples for a stock ticker.", + "description": "Get equity valuation multiples for a given company.", "operationId": "equity_fundamental_multiples", "security": [ { @@ -5598,13 +5609,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fmp." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp." } ], "responses": { @@ -5664,7 +5675,7 @@ "equity" ], "summary": "Balance", - "description": "Balance Sheet. Balance sheet statement.", + "description": "Get the balance sheet for a given company.", "operationId": "equity_fundamental_balance", "security": [ { @@ -6051,7 +6062,7 @@ "equity" ], "summary": "Balance Growth", - "description": "Balance Sheet Statement Growth. Information about the growth of the company balance sheet.", + "description": "Get the growth of a company's balance sheet items over time.", "operationId": "equity_fundamental_balance_growth", "security": [ { @@ -6150,7 +6161,7 @@ "equity" ], "summary": "Cash", - "description": "Cash Flow Statement. Information about the cash flow statement.", + "description": "Get the cash flow statement for a given company.", "operationId": "equity_fundamental_cash", "security": [ { @@ -6523,7 +6534,7 @@ "equity" ], "summary": "Reported Financials", - "description": "Financial statements, as-reported.", + "description": "Get financial statements as reported by the company.", "operationId": "equity_fundamental_reported_financials", "security": [ { @@ -6661,7 +6672,11 @@ }, "model": "ReportedFinancials", "examples": [ - "obb.equity.fundamental.reported_financials(symbol=\"AAPL\", period=\"annual\", statement_type=\"balance\", limit=100)" + "obb.equity.fundamental.reported_financials(symbol=\"AAPL\", period=\"annual\", statement_type=\"balance\", limit=100)", + "# Get reported income statement", + "obb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='income)", + "# Get reported cash flow statement", + "obb.equity.fundamental.reported_financials(symbol='AAPL', statement_type='cash')" ] } }, @@ -6671,7 +6686,7 @@ "equity" ], "summary": "Cash Growth", - "description": "Cash Flow Statement Growth. Information about the growth of the company cash flow statement.", + "description": "Get the growth of a company's cash flow statement items over time.", "operationId": "equity_fundamental_cash_growth", "security": [ { @@ -6770,7 +6785,7 @@ "equity" ], "summary": "Dividends", - "description": "Historical Dividends. Historical dividends data for a given company.", + "description": "Get historical dividend data for a given company.", "operationId": "equity_fundamental_dividends", "security": [ { @@ -6917,7 +6932,7 @@ "equity" ], "summary": "Historical Eps", - "description": "Historical earnings-per-share for a given company.", + "description": "Get historical earnings per share data for a given company.", "operationId": "equity_fundamental_historical_eps", "security": [ { @@ -7022,7 +7037,7 @@ "equity" ], "summary": "Employee Count", - "description": "Historical Employees. Historical number of employees.", + "description": "Get historical employee count data for a given company.", "operationId": "equity_fundamental_employee_count", "security": [ { @@ -7109,7 +7124,7 @@ "equity" ], "summary": "Search Attributes", - "description": "Search Intrinio data tags.", + "description": "Search Intrinio data tags to search in latest or historical attributes.", "operationId": "equity_fundamental_search_attributes", "security": [ { @@ -7205,7 +7220,7 @@ }, "model": "SearchAttributes", "examples": [ - "obb.equity.fundamental.search_attributes(query=\"AAPL\", limit=1000)" + "obb.equity.fundamental.search_attributes(query='ebitda')" ] } }, @@ -7215,7 +7230,7 @@ "equity" ], "summary": "Latest Attributes", - "description": "Fetch the latest value of a data tag from Intrinio.", + "description": "Get the latest value of a data tag from Intrinio.", "operationId": "equity_fundamental_latest_attributes", "security": [ { @@ -7239,13 +7254,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "multiple_items_allowed": [ "intrinio" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: intrinio." + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio." }, { "name": "tag", @@ -7253,13 +7268,13 @@ "required": true, "schema": { "type": "string", - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio.", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "multiple_items_allowed": [ "intrinio" ], "title": "Tag" }, - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio." + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio." } ], "responses": { @@ -7309,7 +7324,7 @@ }, "model": "LatestAttributes", "examples": [ - "obb.equity.fundamental.latest_attributes(symbol=\"AAPL\", tag=\"ceo\")" + "obb.equity.fundamental.latest_attributes(tag='ceo')" ] } }, @@ -7319,7 +7334,7 @@ "equity" ], "summary": "Historical Attributes", - "description": "Fetch the historical values of a data tag from Intrinio.", + "description": "Get the historical values of a data tag from Intrinio.", "operationId": "equity_fundamental_historical_attributes", "security": [ { @@ -7343,13 +7358,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.", "multiple_items_allowed": [ "intrinio" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: intrinio." + "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio." }, { "name": "tag", @@ -7357,13 +7372,13 @@ "required": true, "schema": { "type": "string", - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio.", + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.", "multiple_items_allowed": [ "intrinio" ], "title": "Tag" }, - "description": "Intrinio data tag ID or code. Multiple items allowed: intrinio." + "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio." }, { "name": "start_date", @@ -7537,7 +7552,7 @@ }, "model": "HistoricalAttributes", "examples": [ - "obb.equity.fundamental.historical_attributes(symbol=\"AAPL\", tag=\"ebitda\", frequency=\"yearly\", limit=1000, sort=\"desc\")" + "obb.equity.fundamental.historical_attributes(tag='ebitda')" ] } }, @@ -7547,7 +7562,7 @@ "equity" ], "summary": "Income", - "description": "Income Statement. Report on a company's financial performance.", + "description": "Get the income statement for a given company.", "operationId": "equity_fundamental_income", "security": [ { @@ -7940,7 +7955,7 @@ "equity" ], "summary": "Income Growth", - "description": "Income Statement Growth. Information about the growth of the company income statement.", + "description": "Get the growth of a company's income statement items over time.", "operationId": "equity_fundamental_income_growth", "security": [ { @@ -8055,7 +8070,7 @@ "equity" ], "summary": "Metrics", - "description": "Key Metrics. Key metrics for a given company.", + "description": "Get fundamental metrics for a given company.", "operationId": "equity_fundamental_metrics", "security": [ { @@ -8082,13 +8097,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fmp." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp." }, { "name": "period", @@ -8202,7 +8217,7 @@ "equity" ], "summary": "Management", - "description": "Key Executives. Key executives for a given company.", + "description": "Get executive management team data for a given company.", "operationId": "equity_fundamental_management", "security": [ { @@ -8289,7 +8304,7 @@ "equity" ], "summary": "Management Compensation", - "description": "Get Executive Compensation. Information about the executive compensation for a given company.", + "description": "Get executive management team compensation for a given company over time.", "operationId": "equity_fundamental_management_compensation", "security": [ { @@ -8313,13 +8328,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fmp.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fmp." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp." }, { "name": "start_date", @@ -8417,7 +8432,7 @@ "equity" ], "summary": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3.", - "description": "Company Overview. General information about a company.", + "description": "Get company general business and stock data for a given company.", "operationId": "equity_fundamental_overview", "deprecated": true, "security": [ @@ -8505,7 +8520,7 @@ "equity" ], "summary": "Ratios", - "description": "Extensive set of ratios over time. Financial ratios for a given company.", + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", "operationId": "equity_fundamental_ratios", "security": [ { @@ -8532,14 +8547,14 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed: fmp, intrinio.", + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.", "multiple_items_allowed": [ "fmp", "intrinio" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed: fmp, intrinio." + "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio." }, { "name": "period", @@ -8660,7 +8675,7 @@ "equity" ], "summary": "Revenue Per Geography", - "description": "Revenue Geographic. Geographic revenue data.", + "description": "Get the revenue geographic breakdown for a given company over time.", "operationId": "equity_fundamental_revenue_per_geography", "security": [ { @@ -8779,7 +8794,7 @@ "equity" ], "summary": "Revenue Per Segment", - "description": "Revenue Business Line. Business line revenue data.", + "description": "Get the revenue breakdown by business segment for a given company over time.", "operationId": "equity_fundamental_revenue_per_segment", "security": [ { @@ -8898,7 +8913,7 @@ "equity" ], "summary": "Filings", - "description": "Company Filings. Company filings data.", + "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.", "operationId": "equity_fundamental_filings", "security": [ { @@ -9495,7 +9510,7 @@ "equity" ], "summary": "Historical Splits", - "description": "Historical Splits. Historical splits data.", + "description": "Get historical stock splits for a given company.", "operationId": "equity_fundamental_historical_splits", "security": [ { @@ -9582,7 +9597,7 @@ "equity" ], "summary": "Transcript", - "description": "Earnings Call Transcript. Earnings call transcript for a given company.", + "description": "Get earnings call transcripts for a given company.", "operationId": "equity_fundamental_transcript", "security": [ { @@ -9696,7 +9711,7 @@ }, "model": "EarningsCallTranscript", "examples": [ - "obb.equity.fundamental.transcript(symbol=\"AAPL\")" + "obb.equity.fundamental.transcript(symbol='AAPL', year=2020)" ] } }, @@ -9706,7 +9721,7 @@ "equity" ], "summary": "Trailing Dividend Yield", - "description": "Trailing 1yr dividend yield.", + "description": "Get the 1 year trailing dividend yield for a given company over time.", "operationId": "equity_fundamental_trailing_dividend_yield", "security": [ { @@ -9729,7 +9744,14 @@ "in": "query", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "description": "Symbol to get data for.", "title": "Symbol" }, @@ -9812,7 +9834,7 @@ "equity"