diff options
author | montezdesousa <79287829+montezdesousa@users.noreply.github.com> | 2024-01-10 16:59:47 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-10 16:59:47 +0000 |
commit | b1157cda7d3f6fd7c577bfc04c4ab45c3d2fbe4c (patch) | |
tree | a5a08c0b3d7440fc973097df797913da9a2daa28 | |
parent | d7c69187300579f4a5226f2ce0321021c5e7635d (diff) |
Update excel docs (#5940)
* update basics
* update reference generator
-rw-r--r-- | website/content/excel/functions.json | 724 | ||||
-rw-r--r-- | website/content/excel/usage/basics.md | 4 | ||||
-rw-r--r-- | website/generate_excel_markdown.py | 66 |
3 files changed, 390 insertions, 404 deletions
diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json index be335898a82..54a2329f3b1 100644 --- a/website/content/excel/functions.json +++ b/website/content/excel/functions.json @@ -12,12 +12,6 @@ "type": "string" }, { - "description": "Options: fmp, polygon, tiingo, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -30,6 +24,12 @@ "type": "string" }, { + "description": "Options: fmp, polygon, tiingo, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Number of days to look back. (provider: fmp)", "name": "timeseries", "optional": true, @@ -90,14 +90,14 @@ "name": "CRYPTO.SEARCH", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", + "description": "Search query.", + "name": "query", "optional": true, "type": "string" }, { - "description": "Search query.", - "name": "query", + "description": "Options: fmp, defaults to fmp.", + "name": "provider", "optional": true, "type": "string" } @@ -118,12 +118,6 @@ "type": "string" }, { - "description": "Options: fmp, polygon, tiingo, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -136,6 +130,12 @@ "type": "string" }, { + "description": "Options: fmp, polygon, tiingo, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Data granularity. (provider: fmp, tiingo)", "name": "interval", "optional": true, @@ -270,14 +270,14 @@ "name": "DERIVATIVES.OPTIONS.UNUSUAL", "parameters": [ { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", + "description": "Symbol to get data for. (the underlying symbol)", + "name": "symbol", "optional": true, "type": "string" }, { - "description": "Symbol to get data for. (the underlying symbol)", - "name": "symbol", + "description": "Options: intrinio, defaults to intrinio.", + "name": "provider", "optional": true, "type": "string" }, @@ -299,12 +299,6 @@ "name": "ECONOMY.CALENDAR", "parameters": [ { - "description": "Options: fmp, tradingeconomics, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -317,6 +311,12 @@ "type": "string" }, { + "description": "Options: fmp, tradingeconomics, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Country of the event (provider: tradingeconomics)", "name": "country", "optional": true, @@ -352,12 +352,6 @@ "type": "any" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The unit of measurement for the data.\nOptions:\n- `growth_previous`: Percent growth from the previous period.\nIf monthly data, this is month-over-month, etc\n- `growth_same`: Percent growth from the same period in the previous year.\nIf looking at monthly data, this would be year-over-year, etc.\n- `index_2015`: Rescaled index value, such that the value in 2015 is 100.", "name": "units", "optional": true, @@ -386,6 +380,12 @@ "name": "end_date", "optional": true, "type": "string" + }, + { + "description": "Options: fred, defaults to fred.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -399,14 +399,14 @@ "name": "ECONOMY.FRED_SEARCH", "parameters": [ { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "The search word(s).", + "name": "query", "optional": true, "type": "string" }, { - "description": "The search word(s).", - "name": "query", + "description": "Options: fred, defaults to fred.", + "name": "provider", "optional": true, "type": "string" }, @@ -475,12 +475,6 @@ "type": "string" }, { - "description": "Options: fred, intrinio, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -499,6 +493,12 @@ "type": "number" }, { + "description": "Options: fred, intrinio, defaults to fred.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Frequency aggregation to convert high frequency data to lower frequency.\nNone = No change\na = Annual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)", "name": "frequency", "optional": true, @@ -540,12 +540,6 @@ "name": "ECONOMY.GDP.FORECAST", "parameters": [ { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", "name": "period", "optional": true, @@ -570,6 +564,12 @@ "type": "string" }, { + "description": "Options: oecd, defaults to oecd.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Country to get GDP for. (provider: oecd)", "name": "country", "optional": true, @@ -587,12 +587,6 @@ "name": "ECONOMY.GDP.NOMINAL", "parameters": [ { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", "name": "units", "optional": true, @@ -611,6 +605,12 @@ "type": "string" }, { + "description": "Options: oecd, defaults to oecd.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Country to get GDP for. (provider: oecd)", "name": "country", "optional": true, @@ -628,12 +628,6 @@ "name": "ECONOMY.GDP.REAL", "parameters": [ { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", "name": "units", "optional": true, @@ -652,6 +646,12 @@ "type": "string" }, { + "description": "Options: oecd, defaults to oecd.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Country to get GDP for. (provider: oecd)", "name": "country", "optional": true, @@ -669,12 +669,6 @@ "name": "ECONOMY.MONEY_MEASURES", "parameters": [ { - "description": "Options: federal_reserve, defaults to federal_reserve.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -691,6 +685,12 @@ "name": "adjusted", "optional": true, "type": "boolean" + }, + { + "description": "Options: federal_reserve, defaults to federal_reserve.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -721,12 +721,6 @@ "name": "EQUITY.CALENDAR.DIVIDEND", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -737,6 +731,12 @@ "name": "end_date", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -750,12 +750,6 @@ "name": "EQUITY.CALENDAR.EARNINGS", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -766,6 +760,12 @@ "name": "end_date", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -779,12 +779,6 @@ "name": "EQUITY.CALENDAR.IPO", "parameters": [ { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Symbol to get data for.", "name": "symbol", "optional": true, @@ -809,6 +803,12 @@ "type": "number" }, { + "description": "Options: intrinio, defaults to intrinio.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)", "name": "status", "optional": true, @@ -838,12 +838,6 @@ "name": "EQUITY.CALENDAR.SPLITS", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -854,6 +848,12 @@ "name": "end_date", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -889,12 +889,6 @@ "name": "EQUITY.DISCOVERY.FILINGS", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -919,6 +913,12 @@ "type": "number" }, { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Flag for whether or not the filing is done. (provider: fmp)", "name": "isDone", "optional": true, @@ -963,12 +963,6 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -979,6 +973,12 @@ "name": "limit", "optional": true, "type": "number" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1025,12 +1025,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1043,6 +1037,12 @@ "type": "number" }, { + "description": "Options: fmp, intrinio, polygon, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", "name": "fiscal_year", "optional": true, @@ -1143,16 +1143,16 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1171,12 +1171,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1189,6 +1183,12 @@ "type": "number" }, { + "description": "Options: fmp, intrinio, polygon, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", "name": "fiscal_year", "optional": true, @@ -1289,16 +1289,16 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1362,14 +1362,14 @@ "name": "EQUITY.FUNDAMENTAL.FILINGS", "parameters": [ { - "description": "Options: fmp, intrinio, sec, defaults to fmp.", - "name": "provider", + "description": "Symbol to get data for.", + "name": "symbol", "optional": true, "type": "string" }, { - "description": "Symbol to get data for.", - "name": "symbol", + "description": "Options: fmp, intrinio, sec, defaults to fmp.", + "name": "provider", "optional": true, "type": "string" }, @@ -1437,12 +1437,6 @@ "type": "string" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", "optional": true, @@ -1477,6 +1471,12 @@ "name": "sort", "optional": true, "type": "string" + }, + { + "description": "Options: intrinio, defaults to intrinio.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1545,12 +1545,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1563,6 +1557,12 @@ "type": "number" }, { + "description": "Options: fmp, intrinio, polygon, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", "name": "fiscal_year", "optional": true, @@ -1663,12 +1663,6 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The number of data entries to return.", "name": "limit", "optional": true, @@ -1679,6 +1673,12 @@ "name": "period", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1768,12 +1768,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1786,6 +1780,12 @@ "type": "number" }, { + "description": "Options: fmp, intrinio, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Include trailing twelve months (TTM) data. (provider: fmp)", "name": "with_ttm", "optional": true, @@ -1852,12 +1852,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1870,6 +1864,12 @@ "type": "number" }, { + "description": "Options: fmp, intrinio, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)", "name": "with_ttm", "optional": true, @@ -1898,12 +1898,6 @@ "type": "string" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1922,6 +1916,12 @@ "type": "number" }, { + "description": "Options: intrinio, defaults to intrinio.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", "name": "fiscal_year", "optional": true, @@ -1944,12 +1944,6 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1960,6 +1954,12 @@ "name": "structure", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -1978,12 +1978,6 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time period of the data to return.", "name": "period", "optional": true, @@ -1994,6 +1988,12 @@ "name": "structure", "optional": true, "type": "string" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -2012,16 +2012,16 @@ "type": "string" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" + }, + { + "description": "Options: intrinio, defaults to intrinio.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -2035,14 +2035,14 @@ "name": "EQUITY.FUNDAMENTAL.TRAILING_DIVIDEND_YIELD", "parameters": [ { - "description": "Options: tiingo, defaults to tiingo.", - "name": "provider", + "description": "Symbol to get data for.", + "name": "symbol", "optional": true, "type": "string" }, { - "description": "Symbol to get data for.", - "name": "symbol", + "description": "Options: tiingo, defaults to tiingo.", + "name": "provider", "optional": true, "type": "string" } @@ -2113,18 +2113,18 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "The number of data entries to return.", "name": "limit", "optional": true, "type": "number" }, { + "description": "Options: fmp, intrinio, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { "description": "Type of the transaction. (provider: fmp)", "name": "transactionType", "optional": true, @@ -2211,12 +2211,6 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "A specific date to get data for.", "name": "date", "optional": true, @@ -2227,6 +2221,12 @@ "name": "page", "optional": true, "type": "number" + }, + { + "description": "Options: fmp, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" } ], "result": { @@ -2267,12 +2267,6 @@ "type": "string" }, { - "description": "Options: fmp, intrinio, polygon, tiingo, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { "description": "Time interval of the data to return.", "name": "interval", "optional": true, @@ -2291,6 +2285,12 @@ "type": "string" }, { + "description": "Options: fmp, intrinio, polygon, tiingo, 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, |