diff options
Diffstat (limited to 'website/content/excel/openapi.json')
| -rw-r--r-- | website/content/excel/openapi.json | 957 |
1 files changed, 583 insertions, 374 deletions
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" ], "summary": "Major Holders", - "description": "Equity Ownership. Information about the company ownership.", + "description": "Get data about major holders for a given company over time.", "operationId": "equity_ownership_major_holders", "security": [ { @@ -9878,6 +9900,24 @@ "title": "Page" }, "description": "Page number of the data to fetch." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "fmp", + "description": "Number of records to return. (Ignores page if set. Default: None) (provider: fmp)" + }, + "description": "Number of records to return. (Ignores page if set. Default: None) (provider: fmp)" } ], "responses": { @@ -9937,7 +9977,7 @@ "equity" ], "summary": "Institutional", - "description": "Institutional Ownership. Institutional ownership data.", + "description": "Get data about institutional ownership for a given company over time.", "operationId": "equity_ownership_institutional", "security": [ { @@ -10084,7 +10124,7 @@ "equity" ], "summary": "Insider Trading", - "description": "Insider Trading. Information about insider trading.", + "description": "Get data about trading by a company's management team and board of directors.", "operationId": "equity_ownership_insider_trading", "security": [ { @@ -10300,7 +10340,7 @@ "equity" ], "summary": "Share Statistics", - "description": "Share Statistics. Share statistics for a given company.", + "description": "Get data about share float for a given company.", "operationId": "equity_ownership_share_statistics", "security": [ { @@ -10390,7 +10430,7 @@ "equity" ], "summary": "Quote", - "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.", "operationId": "equity_price_quote", "security": [ { @@ -10417,14 +10457,14 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp", "intrinio" ], "title": "Symbol" }, - "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": "source", @@ -10507,7 +10547,7 @@ "equity" ], "summary": "Nbbo", - "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.", "operationId": "equity_price_nbbo", "security": [ { @@ -10713,7 +10753,7 @@ "equity" ], "summary": "Historical", - "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.", "operationId": "equity_price_historical", "security": [ { @@ -10742,7 +10782,7 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp", "polygon", @@ -10750,7 +10790,7 @@ ], "title": "Symbol" }, - "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": "interval", @@ -11003,7 +11043,7 @@ "equity" ], "summary": "Performance", - "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.", "operationId": "equity_price_performance", "security": [ { @@ -11027,13 +11067,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": { @@ -11208,7 +11248,7 @@ }, "model": "EquityFTD", "examples": [ - "obb.equity.shorts.fails_to_deliver(symbol=\"AAPL\")" + "obb.equity.shorts.fails_to_deliver(symbol='AAPL')" ] } }, @@ -11218,7 +11258,7 @@ "equity" ], "summary": "Search", - |