summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormontezdesousa <79287829+montezdesousa@users.noreply.github.com>2024-04-19 19:12:29 +0100
committerGitHub <noreply@github.com>2024-04-19 19:12:29 +0100
commitf43c0bcb7f8295900ef2e20c5f282687d28220ca (patch)
treeb571709c862687af6bdbc063068888b240328952
parentf0b29cf8177d6ebc124fb88559f5e2e703431315 (diff)
[Docs] - Excel examples from openapi.json (#6318)
* fix: move website gitignore paths * fix: use openapi.json examples * Update .gitignore * pro released
-rw-r--r--.gitignore6
-rw-r--r--website/.gitignore5
-rw-r--r--website/content/excel/functions.json575
-rw-r--r--website/content/excel/openapi.json10318
-rw-r--r--website/generate_excel_markdown.py174
5 files changed, 7966 insertions, 3112 deletions
diff --git a/.gitignore b/.gitignore
index bdd736b86dc..e92f1407831 100644
--- a/.gitignore
+++ b/.gitignore
@@ -85,9 +85,3 @@ lightning_logs/
# Platform auto generated files
openbb_platform/openbb/package/*
-
-# Reference files
-website/content/excel/reference/*
-website/content/excel/reference/*/*
-website/content/platform/data_models/*
-website/content/platform/reference/*
diff --git a/website/.gitignore b/website/.gitignore
index b2d6de30624..04ebeaf5138 100644
--- a/website/.gitignore
+++ b/website/.gitignore
@@ -18,3 +18,8 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
+
+# Reference files
+content/excel/reference/*
+content/platform/data_models/*
+content/platform/reference/*
diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json
index e93a51521c4..1cebe7a1928 100644
--- a/website/content/excel/functions.json
+++ b/website/content/excel/functions.json
@@ -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 for provider(s): fmp, polygon.",
+ "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.",
"name": "symbol",
"type": "string"
},
@@ -96,25 +96,19 @@
"type": "string"
},
{
- "description": "Options: fmp, polygon, tiingo, defaults to fmp.",
+ "description": "Options: fmp, polygon, defaults to fmp.",
"name": "provider",
"optional": true,
"type": "string"
},
{
- "description": "Number of days to look back. (provider: fmp)",
- "name": "timeseries",
- "optional": true,
- "type": "number"
- },
- {
- "description": "Data granularity. (provider: fmp, polygon, tiingo)",
+ "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)",
"name": "interval",
"optional": true,
"type": "string"
},
{
- "description": "Sort order of the data. (provider: polygon)",
+ "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)",
"name": "sort",
"optional": true,
"type": "string"
@@ -124,13 +118,6 @@
"name": "limit",
"optional": true,
"type": "number"
- },
- {
- "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo)",
- "dimensionality": "matrix",
- "name": "exchanges",
- "optional": true,
- "type": "any"
}
],
"result": {
@@ -167,7 +154,7 @@
"name": "CURRENCY.PRICE.HISTORICAL",
"parameters": [
{
- "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon.",
+ "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.",
"name": "symbol",
"type": "string"
},
@@ -184,19 +171,19 @@
"type": "string"
},
{
- "description": "Options: fmp, polygon, tiingo, defaults to fmp.",
+ "description": "Options: fmp, polygon, defaults to fmp.",
"name": "provider",
"optional": true,
"type": "string"
},
{
- "description": "Data granularity. (provider: fmp, polygon, tiingo)",
+ "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)",
"name": "interval",
"optional": true,
"type": "string"
},
{
- "description": "Sort order of the data. (provider: polygon)",
+ "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)",
"name": "sort",
"optional": true,
"type": "string"
@@ -289,6 +276,41 @@
}
},
{
+ "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 for provider(s): fmp.",
+ "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"
+ },
+ {
+ "description": "Options: fmp, defaults to fmp.",
+ "name": "provider",
+ "optional": true,
+ "type": "string"
+ }
+ ],
+ "result": {
+ "dimensionality": "matrix"
+ }
+ },
+ {
"description": "Get the complete options chain for a ticker.",
"helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/chains",
"id": "DERIVATIVES.OPTIONS.CHAINS",
@@ -335,6 +357,48 @@
"type": "string"
},
{
+ "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began. (provider: intrinio)",
+ "name": "start_date",
+ "optional": true,
+ "type": "string"
+ },
+ {
+ "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio)",
+ "name": "end_date",
+ "optional": true,
+ "type": "string"
+ },
+ {
+ "description": "The type of unusual activity to query for. (provider: intrinio)",
+ "name": "trade_type",
+ "optional": true,
+ "type": "string"
+ },
+ {
+ "description": "The sentiment type to query for. (provider: intrinio)",
+ "name": "sentiment",
+ "optional": true,
+ "type": "string"
+ },
+ {
+ "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)",
+ "name": "min_value",
+ "optional": true,
+ "type": "number"
+ },
+ {
+ "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)",
+ "name": "max_value",
+ "optional": true,
+ "type": "number"
+ },
+ {
+ "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio)",
+ "name": "limit",
+ "optional": true,
+ "type": "number"
+ },
+ {
"description": "The source of the data. Either realtime or delayed. (provider: intrinio)",
"name": "source",
"optional": true,
@@ -405,7 +469,7 @@
"type": "string"
},
{
- "description": "Country of the event. Multiple items allowed. (provider: tradingeconomics)",
+ "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)",
"name": "country",
"optional": true,
"type": "string"
@@ -469,7 +533,7 @@
"name": "ECONOMY.CPI",
"parameters": [
{
- "description": "The country to get data. Multiple items allowed for provider(s): fred.",
+ "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred.",
"name": "country",
"type": "string"
},
@@ -521,7 +585,7 @@
"name": "ECONOMY.FRED_REGIONAL",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.",
+ "description": "Symbol to get data for.",
"name": "symbol",
"type": "string"
},
@@ -680,7 +744,7 @@
"name": "ECONOMY.FRED_SERIES",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.",
"name": "symbol",
"type": "string"
},
@@ -1287,13 +1351,13 @@
"name": "EQUITY.ESTIMATES.ANALYST_SEARCH",
"parameters": [
{
- "description": "A comma separated list of analyst names to bring back. Omitting will bring back all available analysts.",
+ "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga.",
"name": "analyst_name",
"optional": true,
"type": "string"
},
{
- "description": "A comma separated list of firm names to bring back. Omitting will bring back all available firms.",
+ "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga.",
"name": "firm_name",
"optional": true,
"type": "string"
@@ -1305,16 +1369,16 @@
"type": "string"
},
{
- "description": "A comma separated list of analyst IDs to bring back. (provider: benzinga)",
+ "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)",
"name": "analyst_ids",
"optional": true,
- "type": "any"
+ "type": "string"
},
{
- "description": "A comma separated list of firm IDs to bring back. (provider: benzinga)",
+ "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)",
"name": "firm_ids",
"optional": true,
- "type": "any"
+ "type": "string"
},
{
"description": "Number of results returned. Limit 1000. (provider: benzinga)",
@@ -1329,10 +1393,10 @@
"type": "number"
},
{
- "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. (provider: benzinga)",
+ "description": "Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga)",
"name": "fields",
"optional": true,
- "type": "any"
+ "type": "string"
}
],
"result": {
@@ -1346,7 +1410,7 @@
"name": "EQUITY.ESTIMATES.CONSENSUS",
"parameters": [
{
- "description": "Symbol to get data for.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"name": "symbol",
"type": "string"
},
@@ -1368,27 +1432,27 @@
"name": "EQUITY.ESTIMATES.HISTORICAL",
"parameters": [
{
- "description": "Symbol to get data for.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"name": "symbol",
"type": "string"
},
{
- "description": "Time period of the data to return.",
- "name": "period",
+ "description": "Options: fmp, defaults to fmp.",
+ "name": "provider",
"optional": true,
"type": "string"
},
{
- "description": "The number of data entries to return.",
- "name": "limit",
+ "description": "Time period of the data to return. (provider: fmp)",
+ "name": "period",
"optional": true,
- "type": "number"
+ "type": "string"
},
{
- "description": "Options: fmp, defaults to fmp.",
- "name": "provider",
+ "description": "The number of data entries to return. (provider: fmp)",
+ "name": "limit",
"optional": true,
- "type": "string"
+ "type": "number"
}
],
"result": {
@@ -1402,7 +1466,7 @@
"name": "EQUITY.ESTIMATES.PRICE_TARGET",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): benzinga.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.",
"name": "symbol",
"optional": true,
"type": "string"
@@ -1462,19 +1526,19 @@
"type": "string"
},
{
- "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple items allowed. (provider: benzinga)",
+ "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)",
"name": "analyst_ids",
"optional": true,
"type": "any"
},
{
- "description": "Comma-separated list of firm IDs. Multiple items allowed. (provider: benzinga)",
+ "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)",
"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 items allowed. (provider: benzinga)",
+ "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. (provider: benzinga)",
"name": "fields",
"optional": true,
"type": "any"
@@ -1875,12 +1939,6 @@
"type": "number"
},
{
- "description": "Sort the data in ascending or descending order. (provider: fmp)",
- "name": "sort",
- "optional": true,
- "type": "string"
- },
- {
"description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)",
"name": "start_date",
"optional": true,
@@ -1922,12 +1980,12 @@
"name": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.",
"name": "symbol",
"type": "string"
},
{
- "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.",
+ "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.",
"name": "tag",
"type": "string"
},
@@ -2187,12 +2245,12 @@
"name": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.",
"name": "symbol",
"type": "string"
},
{
- "description": "Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.",
+ "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.",
"name": "tag",
"type": "string"
},
@@ -2236,27 +2294,21 @@
"name": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"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",
+ "description": "Options: fmp, defaults to fmp.",
+ "name": "provider",
"optional": true,
"type": "string"
},
{
- "description": "Options: fmp, defaults to fmp.",
- "name": "provider",
+ "description": "Year of the compensation. (provider: fmp)",
+ "name": "year",
"optional": true,
- "type": "string"
+ "type": "number"
}
],
"result": {
@@ -2270,7 +2322,7 @@
"name": "EQUITY.FUNDAMENTAL.METRICS",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.",
"name": "symbol",
"type": "string"
},
@@ -2310,7 +2362,7 @@
"name": "EQUITY.FUNDAMENTAL.MULTIPLES",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"name": "symbol",
"type": "string"
},
@@ -2354,7 +2406,7 @@
"name": "EQUITY.FUNDAMENTAL.RATIOS",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"name": "symbol",
"type": "string"
},
@@ -2377,7 +2429,7 @@
"type": "string"
},
{
- "description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)",
+ "description": "Include trailing twelve months (TTM) data. (provider: fmp)",
"name": "with_ttm",
"optional": true,
"type": "boolean"
@@ -2536,25 +2588,23 @@
}
},
{
- "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",
+ "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",
- "optional": true,
"type": "string"
},
{
- "description": "The number of data entries to return. Default is 252, the number of trading days in a year.",
- "name": "limit",
- "optional": true,
+ "description": "Year of the earnings call transcript.",
+ "name": "year",
"type": "number"
},
{
- "description": "Options: tiingo, defaults to tiingo.",
+ "description": "Options: fmp, defaults to fmp.",
"name": "provider",
"optional": true,
"type": "string"
@@ -2565,31 +2615,26 @@
}
},
{
- "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",
+ "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",
"parameters": [
{
- "description": "Symbol to get data for.",
- "name": "symbol",
- "type": "string"
- },
- {
- "description": "Year of the earnings call transcript.",
- "name": "year",
+ "description": "Options: fmp, intrinio, polygon, defaults to fmp.",
+ "name": "provider",
"optional": true,
- "type": "number"
+ "type": "string"
},
{
- "description": "Options: fmp, defaults to fmp.",
- "name": "provider",
+ "description": "The market to fetch data for. (provider: fmp)",
+ "name": "market",
"optional": true,
"type": "string"
},
{
- "description": "Date of the earnings call transcript. (provider: fmp)",
- "name": "earnings_date",
+ "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio)",
+ "name": "date",
"optional": true,
"type": "string"
}
@@ -2599,20 +2644,31 @@
}
},
{
- "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",
+ "description": "The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report\nthat is required to be filed by all institutional investment managers with at least\n$100 million in assets under management.\nManagers are required to file Form 13F within 45 days after the last day of the calendar quarter.\nMost funds wait until the end of this period in order to conceal\ntheir investment strategy from competitors and the public.",
+ "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/form_13f",
+ "id": "EQUITY.OWNERSHIP.FORM_13F",
+ "name": "EQUITY.OWNERSHIP.FORM_13F",
"parameters": [
{
- "description": "Options: fmp, polygon, defaults to fmp.",
- "name": "provider",
+ "description": "Symbol to get data for. A CIK or Symbol can be used.",
+ "name": "symbol",
+ "type": "string"
+ },
+ {
+ "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.",
+ "name": "date",
"optional": true,
"type": "string"
},
{
- "description": "The market to fetch data for. (provider: fmp)",
- "name": "market",
+ "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.",
+ "name": "limit",
+ "optional": true,
+ "type": "number"
+ },
+ {
+ "description": "Options: sec, defaults to sec.",
+ "name": "provider",
"optional": true,
"type": "string"
}
@@ -2691,7 +2747,7 @@
"type": "string"
},
{
- "description": "Options: fmp, intrinio, defaults to fmp.",
+ "description": "Options: fmp, defaults to fmp.",
"name": "provider",
"optional": true,
"type": "string"
@@ -2707,12 +2763,6 @@
"name": "date",
"optional": true,
"type": "string"
- },
- {
- "description": "The number of data entries to return. (provider: intrinio)",
- "name": "page_size",
- "optional": true,
- "type": "number"
}
],
"result": {
@@ -2747,12 +2797,6 @@
"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": {
@@ -2788,7 +2832,7 @@
"name": "EQUITY.PRICE.HISTORICAL",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.",
"name": "symbol",
"type": "string"
},
@@ -2811,24 +2855,12 @@
"type": "string"
},
{
- "description": "Options: fmp, intrinio, polygon, tiingo, defaults to fmp.",
+ "description": "Options: fmp, intrinio, polygon, defaults to fmp.",
"name": "provider",
"optional": true,
"type": "string"
},
{
- "description": "Number of days to look back (Only for interval 1d). (provider: fmp);\nThe number of results to return per page. (provider: intrinio);\nThe number of data entries to return. (provider: polygon)",
- "name": "limit",
- "optional": true,
- "type": "number"
- },
- {
- "description": "Sort the data in ascending or descending order. (provider: fmp);\nSort order of the data. (provider: polygon)",
- "name": "sort",
- "optional": true,
- "type": "string"
- },
- {
"description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)",
"name": "start_time",
"optional": true,
@@ -2853,16 +2885,28 @@
"type": "string"
},
{
- "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
- "name": "sleep",
+ "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)",
+ "name": "adjustment",
"optional": true,
- "type": "number"
+ "type": "string"
},
{
- "description": "Output time series is adjusted by historical split and dividend events. (provider: polygon)",
- "name": "adjusted",
+ "description": "Include Pre and Post market data. (provider: polygon)",
+ "name": "extended_hours",
"optional": true,
"type": "boolean"
+ },
+ {
+ "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)",
+ "name": "sort",
+ "optional": true,
+ "type": "string"
+ },
+ {
+ "description": "The number of data entries to return. (provider: polygon)",
+ "name": "limit",
+ "optional": true,
+ "type": "number"
}
],
"result": {
@@ -2899,25 +2943,25 @@
"type": "string"
},
{
- "description": "Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
+ "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"name": "timestamp_lt",
"optional": true,
"type": "string"
},
{
- "description": "Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
+ "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"name": "timestamp_gt",
"optional": true,
"type": "string"
},
{
- "description": "Query by datetime, less than or equal to.\nEither a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
+ "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"name": "timestamp_lte",
"optional": true,
"type": "string"
},
{
- "description": "Query by datetime, greater than or equal to.\nEither a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\nYYYY-MM-DDTH:M:S.000000000-04:00\". Include all nanoseconds and the 'T' between the day and hour.\n(provider: polygon)",
+ "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)",
"name": "timestamp_gte",
"optional": true,
"type": "string"
@@ -2934,7 +2978,7 @@
"name": "EQUITY.PRICE.PERFORMANCE",
"parameters": [
{
- "description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.",
"name": "symbol",
"type": "string"
},
@@ -2956,7 +3000,7 @@
"name": "EQUITY.PRICE.QUOTE",
"parameters": [
{
- "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio.",
+ "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.",
"name": "symbol",
"type": "string"
},
@@ -2984,7 +3028,7 @@
"na