summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTheodore Aptekarev <aptekarev@gmail.com>2024-06-18 15:53:42 +0300
committerGitHub <noreply@github.com>2024-06-18 15:53:42 +0300
commit02a566808c031b332b8587c4266378e052f011a2 (patch)
tree9b3c8ca5fad0846e0455170b1ef705e1f5350868
parent9d20e78db65750f5c367228cc1707a7a8ff45420 (diff)
parentb7088a21073a8d9a64f55bc73fa2d4d0054b1624 (diff)
Merge branch 'main' into docs/renamedocs/rename
-rw-r--r--website/content/excel/functions.json3811
-rw-r--r--website/content/excel/openapi.json15151
-rw-r--r--website/content/excel/openbb-functions.json173
-rw-r--r--website/generate_excel_markdown.py96
4 files changed, 11604 insertions, 7627 deletions
diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json
index 1cebe7a1928..c86e1b29f05 100644
--- a/website/content/excel/functions.json
+++ b/website/content/excel/functions.json
@@ -73,88 +73,13 @@
}
},
{
- "description": "Get historical price data for cryptocurrency pair(s) within a provider.",
- "helpUrl": "https://docs.openbb.co/excel/reference/crypto/price/historical",
- "id": "CRYPTO.PRICE.HISTORICAL",
- "name": "CRYPTO.PRICE.HISTORICAL",
- "parameters": [
- {
- "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"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Options: fmp, polygon, defaults to fmp.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "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. 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": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Search available cryptocurrency pairs within a provider.",
- "helpUrl": "https://docs.openbb.co/excel/reference/crypto/search",
- "id": "CRYPTO.SEARCH",
- "name": "CRYPTO.SEARCH",
- "parameters": [
- {
- "description": "Search query.",
- "name": "query",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Options: fmp, defaults to fmp.",
- "name": "provider",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
"description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.",
"helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical",
"id": "CURRENCY.PRICE.HISTORICAL",
"name": "CURRENCY.PRICE.HISTORICAL",
"parameters": [
{
- "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.",
+ "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed.",
"name": "symbol",
"type": "string"
},
@@ -171,104 +96,10 @@
"type": "string"
},
{
- "description": "Options: fmp, polygon, defaults to fmp.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "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)",
+ "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.",
"name": "interval",
"optional": true,
"type": "string"
- },
- {
- "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": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.",
- "helpUrl": "https://docs.openbb.co/excel/reference/currency/reference_rates",
- "id": "CURRENCY.REFERENCE_RATES",
- "name": "CURRENCY.REFERENCE_RATES",
- "parameters": [
- {
- "description": "Options: ecb, defaults to ecb.",
- "name": "provider",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.",
- "helpUrl": "https://docs.openbb.co/excel/reference/currency/search",
- "id": "CURRENCY.SEARCH",
- "name": "CURRENCY.SEARCH",
- "parameters": [
- {
- "description": "Options: fmp, intrinio, polygon, defaults to fmp.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Symbol of the pair to search. (provider: polygon)",
- "name": "symbol",
- "optional": true,
- "type": "string"
- },
- {
- "description": "A specific date to get data for. (provider: polygon)",
- "name": "date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Search for terms within the ticker and/or company name. (provider: polygon)",
- "name": "search",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)",
- "name": "active",
- "optional": true,
- "type": "boolean"
- },
- {
- "description": "Order data by ascending or descending. (provider: polygon)",
- "name": "order",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Sort field used for ordering. (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": {
@@ -282,7 +113,7 @@
"name": "CURRENCY.SNAPSHOTS",
"parameters": [
{
- "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.",
+ "description": "The base currency symbol. Multiple comma separated items allowed.",
"name": "base",
"optional": true,
"type": "string"
@@ -298,146 +129,6 @@
"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",
- "name": "DERIVATIVES.OPTIONS.CHAINS",
- "parameters": [
- {
- "description": "Symbol to get data for.",
- "name": "symbol",
- "type": "string"
- },
- {
- "description": "Options: intrinio, defaults to intrinio.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The end-of-day date for options chains data. (provider: intrinio)",
- "name": "date",
- "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/unusual",
- "id": "DERIVATIVES.OPTIONS.UNUSUAL",
- "name": "DERIVATIVES.OPTIONS.UNUSUAL",
- "parameters": [
- {
- "description": "Symbol to get data for. (the underlying symbol)",
- "name": "symbol",
- "optional": true,
- "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. 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,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Balance of Payments Reports.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/balance_of_payments",
- "id": "ECONOMY.BALANCE_OF_PAYMENTS",
- "name": "ECONOMY.BALANCE_OF_PAYMENTS",
- "parameters": [
- {
- "description": "Options: ecb, defaults to ecb.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The report type, the level of detail in the data. (provider: ecb)",
- "name": "report_type",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)",
- "name": "frequency",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)",
- "name": "country",
- "optional": true,
- "type": "any"
}
],
"result": {
@@ -463,812 +154,28 @@
"type": "string"
},
{
- "description": "Options: fmp, tradingeconomics, defaults to fmp.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)",
+ "description": "Country of the event. Multiple comma separated items allowed.",
"name": "country",
"optional": true,
"type": "string"
},
{
- "description": "Importance of the event. (provider: tradingeconomics)",
+ "description": "Importance of the event. Options: Low, Medium, High.",
"name": "importance",
"optional": true,
"type": "string"
},
{
- "description": "Grouping of events (provider: tradingeconomics)",
+ "description": "Grouping of events. Options: interest_rate, inflation, bonds, consumer, gdp, government, housing, labour, markets, money, prices, trade, business.",
"name": "group",
"optional": true,
"type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\nCLIs show short-term economic movements in qualitative rather than quantitative terms.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/composite_leading_indicator",
- "id": "ECONOMY.COMPOSITE_LEADING_INDICATOR",
- "name": "ECONOMY.COMPOSITE_LEADING_INDICATOR",
- "parameters": [
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Options: oecd, defaults to oecd.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Country to get GDP for. (provider: oecd)",
- "name": "country",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/cpi",
- "id": "ECONOMY.CPI",
- "name": "ECONOMY.CPI",
- "parameters": [
- {
- "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred.",
- "name": "country",
- "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,
- "type": "string"
- },
- {
- "description": "The frequency of the data.\nOptions: `monthly`, `quarter`, and `annual`.",
- "name": "frequency",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Whether you wish to obtain harmonized data.",
- "name": "harmonized",
- "optional": true,
- "type": "boolean"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Options: fred, defaults to fred.",
- "name": "provider",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Query the Geo Fred API for regional economic data by series group.\nThe series group ID is found by using `fred_search` and the `series_id` parameter.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_regional",
- "id": "ECONOMY.FRED_REGIONAL",
- "name": "ECONOMY.FRED_REGIONAL",
- "parameters": [
- {
- "description": "Symbol to get data for.",
- "name": "symbol",
- "type": "string"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The number of data entries to return.",
- "name": "limit",
- "optional": true,
- "type": "number"
- },
- {
- "description": "Options: fred, defaults to fred.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)",
- "name": "is_series_group",
- "optional": true,
- "type": "boolean"
- },
- {
- "description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)",
- "name": "region_type",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)",
- "name": "season",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True. (provider: fred)",
- "name": "units",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Frequency aggregation to convert high frequency data to lower frequency.\nParameter is only valid when `is_series_group` is True.\na = Annual\nsa= Semiannual\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,
- "type": "string"
- },
- {
- "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\nOnly valid when `is_series_group` is True.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)",
- "name": "aggregation_method",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Transformation type. Only valid when `is_series_group` is True.\nlin = Levels (No transformation)\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)",
- "name": "transform",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Search for FRED series or economic releases by ID or string.\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_search",
- "id": "ECONOMY.FRED_SEARCH",
- "name": "ECONOMY.FRED_SEARCH",
- "parameters": [
- {
- "description": "The search word(s).",
- "name": "query",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Options: fred, defaults to fred.",
- "name": "provider",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. (provider: fred)",
- "name": "is_release",
- "optional": true,
- "type": "boolean"
- },
- {
- "description": "A specific release ID to target. (provider: fred)",
- "name": "release_id",
- "optional": true,
- "type": "any"
- },
- {
- "description": "The number of data entries to return. (1-1000) (provider: fred)",
- "name": "limit",
- "optional": true,
- "type": "number"
- },
- {
- "description": "Offset the results in conjunction with limit. (provider: fred)",
- "name": "offset",
- "optional": true,
- "type": "number"
- },
- {
- "description": "Filter by an attribute. (provider: fred)",
- "name": "filter_variable",
- "optional": true,
- "type": "any"
- },
- {
- "description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)",
- "name": "filter_value",
- "optional": true,
- "type": "string"
- },
- {
- "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)",
- "name": "tag_names",
- "optional": true,
- "type": "string"
- },
- {
- "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. (provider: fred)",
- "name": "exclude_tag_names",
- "optional": true,
- "type": "string"
- },
- {
- "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas. (provider: fred)",
- "name": "series_id",
- "optional": true,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Get data by series ID from FRED.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_series",
- "id": "ECONOMY.FRED_SERIES",
- "name": "ECONOMY.FRED_SERIES",
- "parameters": [
- {
- "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.",
- "name": "symbol",
- "type": "string"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
},
{
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "The number of data entries to return.",
- "name": "limit",
- "optional": true,
- "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,
- "type": "any"
- },
- {
- "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)",
- "name": "aggregation_method",
- "optional": true,
- "type": "any"
- },
- {
- "description": "Transformation type\nNone = No transformation\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)",
- "name": "transform",
+ "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.",
+ "name": "calendar_id",
"optional": true,
"type": "any"
- },
- {
- "description": "Returns all pages of data from the API call at once. (provider: intrinio)",
- "name": "all_pages",
- "optional": true,
- "type": "boolean"
- },
- {
- "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)",
- "name": "sleep",
- "optional": true,
- "type": "number"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Forecasted GDP Data.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/forecast",
- "id": "ECONOMY.GDP.FORECAST",
- "name": "ECONOMY.GDP.FORECAST",
- "parameters": [
- {
- "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.",
- "name": "period",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "End date of the data, in YYYY-MM-DD format.",
- "name": "end_date",
- "optional": true,
- "type": "string"
- },
- {
- "description": "Type of GDP to get forecast of. Either nominal or real.",
- "name": "type",
- "optional": true,
- "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,
- "type": "string"
- }
- ],
- "result": {
- "dimensionality": "matrix"
- }
- },
- {
- "description": "Nominal GDP Data.",
- "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/nominal",
- "id": "ECONOMY.GDP.NOMINAL",
- "name": "ECONOMY.GDP.NOMINAL",
- "parameters": [
- {
- "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,
- "type": "string"
- },
- {
- "description": "Start date of the data, in YYYY-MM-DD format.",
- "name": "start_date",
- "optional": true,
- "type": "string"