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..321c0bfe509 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -18,3 +18,9 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + +# Reference files +content/excel/reference/* +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" @@ -288,6 +275,41 @@ "dimensionality": "matrix" } }, + { + "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", @@ -334,6 +356,48 @@ "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", @@ -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", - "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" + }, + { + "description": "Time period of the data to return. (provider: fmp)", + "name": "period", + "optional": true, + "type": "string" + }, + { + "description": "The number of data entries to return. (provider: fmp)", + "name": "limit", + "optional": true, + "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" @@ -1874,12 +1938,6 @@ "optional": true, "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", @@ -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", - "optional": true, - "type": "string" - }, { "description": "Options: fmp, defaults to fmp.", "name": "provider", "optional": true, "type": "string" + }, + { + "description": "Year of the compensation. (provider: fmp)", + "name": "year", + "optional": true, + "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" @@ -2535,35 +2587,6 @@ "dimensionality": "matrix" } }, - { - "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", - "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, - "type": "number" - }, - { - "description": "Options: tiingo, defaults to tiingo.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, { "description": "Get earnings call transcripts for a given company.", "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/transcript", @@ -2578,7 +2601,6 @@ { "description": "Year of the earnings call transcript.", "name": "year", - "optional": true, "type": "number" }, { @@ -2586,12 +2608,6 @@ "name": "provider", "optional": true, "type": "string" - }, - { - "description": "Date of the earnings call transcript. (provider: fmp)", - "name": "earnings_date", - "optional": true, - "type": "string" } ], "result": { @@ -2605,7 +2621,7 @@ "name": "EQUITY.MARKET_SNAPSHOTS", "parameters": [ { - "description": "Options: fmp, polygon, defaults to fmp.", + "description": "Options: fmp, intrinio, polygon, defaults to fmp.", "name": "provider", "optional": true, "type": "string" @@ -2615,6 +2631,46 @@ "name": "market", "optional": true, "type": "string" + }, + { + "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" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "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": "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 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" } ], "result": { @@ -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,23 +2855,11 @@ "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", @@ -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 @@ "name": "EQUITY.PROFILE", "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, intrinio.", "name": "symbol", "type": "string" }, @@ -3212,7 +3256,7 @@ "name": "ETF.COUNTRIES", "parameters": [ { - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3234,7 +3278,7 @@ "name": "ETF.EQUITY_EXPOSURE", "parameters": [ { - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", "name": "symbol", "type": "string" }, @@ -3249,6 +3293,94 @@ "dimensionality": "matrix" } }, + { + "description": "ETF Historical Market Price.", + "helpUrl": "https://docs.openbb.co/excel/reference/etf/historical", + "id": "ETF.HISTORICAL", + "name": "ETF.HISTORICAL", + "parameters": [ + { + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "name": "symbol", + "type": "string" + }, + { + "description": "Time interval of the data to return.", + "name": "interval", + "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": "Options: fmp, intrinio, polygon, defaults to fmp.", + "name": "provider", + "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, + "type": "string" + }, + { + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)", + "name": "end_time", + "optional": true, + "type": "string" + }, + { + "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)", + "name": "timezone", + "optional": true, + "type": "string" + }, + { + "description": "The source of the data. (provider: intrinio)", + "name": "source", + "optional": true, + "type": "string" + }, + { + "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)", + "name": "adjustment", + "optional": true, + "type": "string" + }, + { + "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": { + "dimensionality": "matrix" + } + }, { "description": "Get the holdings for an individual ETF.", "helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings", @@ -3261,13 +3393,13 @@ "type": "string" }, { - "description": "Options: fmp, sec, defaults to fmp.", + "description": "Options: fmp, intrinio, sec, defaults to fmp.", "name": "provider", "optional": true, "type": "string" }, { - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\nA specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)", + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\nA specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)", "name": "date", "optional": true, "type": "string" @@ -3324,7 +3456,7 @@ "name": "ETF.HOLDINGS_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" }, @@ -3346,12 +3478,12 @@ "name": "ETF.INFO", "parameters": [ { - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", "name": "symbol", "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", + "description": "Options: fmp, intrinio, defaults to fmp.", "name": "provider", "optional": true, "type": "string" @@ -3362,21 +3494,33 @@ } }, { - "description": "Price performance as a return, over different periods. This is a proxy for `equity.price.performance`.", + "description": "Price performance as a return, over different periods.", "helpUrl": "https://docs.openbb.co/excel/reference/etf/price_performance", "id": "ETF.PRICE_PERFORMANCE", "name": "ETF.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, intrinio.", "name": "symbol", "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", + "description": "Options: fmp, intrinio, defaults to fmp.", "name": "provider", "optional": true, "type": "string" + }, + { + "description": "The type of returns to return, a trailing or calendar window. (provider: intrinio)", + "name": "return_type", + "optional": true, + "type": "string" + }, + { + "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)", + "name": "adjustment", + "optional": true, + "type": "string" } ], "result": { @@ -3396,13 +3540,13 @@ "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", + "description": "Options: fmp, intrinio, defaults to fmp.", "name": "provider", "optional": true, "type": "string" }, { - "description": "The exchange code the ETF trades on. (provider: fmp)", + "description": "The exchange code the ETF trades on. (provider: fmp);\nTarget a specific exchange by providing the MIC code. (provider: intrinio)", "name": "exchange", "optional": true, "type": "string" @@ -3635,18 +3779,16 @@ "type": "string" }, { - "description": "The maturities in years.", - "dimensionality": "matrix", + "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", "name": "maturity", "optional": true, "type": "any" }, { - "description": "The category.", - "dimensionality": "matrix", + "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", "name": "category", "optional": true, - "type": "any" + "type": "string" }, { "description": "Options: fred, defaults to fred.", @@ -4200,101 +4342,7 @@ "name": "INDEX.MARKET", "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": "Options: fmp, intrinio, 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)", - "name": "interval", - "optional": true, - "type": "string" - }, - { - "description": "Sort the data in ascending or descending order. (provider: fmp);\nSort order. (provider: intrinio);\nSort order of the data. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "Index tag. (provider: intrinio)", - "name": "tag", - "optional": true, - "type": "string" - }, - { - "description": "Index type. (provider: intrinio)", - "name": "type", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: intrinio, polygon)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", - "name": "sleep", - "optional": true, - "type": "number" - }, - { - "description": "Timespan of the data. (provider: polygon)", - "name": "timespan", - "optional": true, - "type": "string" - }, - { - "description": "Whether the data is adjusted. (provider: polygon)", - "name": "adjusted", - "optional": true, - "type": "boolean" - }, - { - "description": "Multiplier of the timespan. (provider: polygon)", - "name": "multiplier", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Historical Index Levels.", - "helpUrl": "https://docs.openbb.co/excel/reference/index/price/historical", - "id": "INDEX.PRICE.HISTORICAL", - "name": "INDEX.PRICE.HISTORICAL", - "parameters": [ - { - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", "name": "symbol", "type": "string" }, @@ -4317,16 +4365,56 @@ "type": "string" }, { - "description": "The number of data entries to return.", + "description": "Options: fmp, intrinio, polygon, defaults to fmp.", + "name": "provider", + "optional": true, + "type": "string" + }, + { + "description": "The number of data entries to return. (provider: intrinio, polygon)", "name": "limit", "optional": true, "type": "number" }, { - "description": "Sort the data in ascending or descending order.", + "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" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Historical Index Levels.", + "helpUrl": "https://docs.openbb.co/excel/reference/index/price/historical", + "id": "INDEX.PRICE.HISTORICAL", + "name": "INDEX.PRICE.HISTORICAL", + "parameters": [ + { + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, 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": "Time interval of the data to return.", + "name": "interval", + "optional": true, + "type": "string" }, { "description": "Options: fmp, intrinio, polygon, defaults to fmp.", @@ -4335,10 +4423,16 @@ "type": "string" }, { - "description": "Number of days to look back. (provider: fmp)", - "name": "timeseries", + "description": "The number of data entries to return. (provider: intrinio, polygon)", + "name": "limit", "optional": true, "type": "number" + }, + { + "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" } ], "result": { @@ -4352,7 +4446,7 @@ "name": "NEWS.COMPANY", "parameters": [ { - "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon.", "name": "symbol", "optional": true, "type": "string" @@ -4376,7 +4470,7 @@ "type": "number" }, { - "description": "Options: benzinga, fmp, intrinio, polygon, tiingo, defaults to benzinga.", + "description": "Options: benzinga, fmp, intrinio, polygon, defaults to benzinga.", "name": "provider", "optional": true, "type": "string" @@ -4458,18 +4552,6 @@ "name": "page", "optional": true, "type": "number" - }, - { - "description": "Page offset, used in conjunction with limit. (provider: tiingo)", - "name": "offset", - "optional": true, - "type": "number" - }, - { - "description": "A comma-separated list of the domains requested. (provider: tiingo)", - "name": "source", - "optional": true, - "type": "string" } ], "result": { @@ -4501,7 +4583,7 @@ "type": "string" }, { - "description": "Options: benzinga, fmp, intrinio, tiingo, defaults to benzinga.", + "description": "Options: benzinga, fmp, intrinio, defaults to benzinga.", "name": "provider", "optional": true, "type": "string" @@ -4577,18 +4659,6 @@ "name": "content_types", "optional": true, "type": "string" - }, - { - "description": "Page offset, used in conjunction with limit. (provider: tiingo)", - "name": "offset", - "optional": true, - "type": "number" - }, - { - "description": "A comma-separated list of the domains requested. (provider: tiingo)", - "name": "source", - "optional": true, - "type": "string" } ], "result": { @@ -4736,7 +4806,6 @@ { "description": "Search query.", "name": "query", - "optional": true, "type": "string" }, { diff --git a/website/content/excel/openapi.json b/website/content/excel/openapi.json index f986aefdd43..7185ffd852e 100644 --- a/website/content/excel/openapi.json +++ b/website/content/excel/openapi.json @@ -13,7 +13,7 @@ "name": "MIT", "url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/LICENSE" }, - "version": "1" + "version": "4.1.6" }, "paths": { "/api/v1/crypto/price/historical": { @@ -37,8 +37,7 @@ "schema": { "enum": [ "fmp", - "polygon", - "tiingo" + "polygon" ], "type": "string", "title": "Provider" @@ -50,14 +49,14 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp", "polygon" ], "title": "Symbol" }, - "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": "start_date", @@ -97,25 +96,6 @@ }, "description": "End date of the data, in YYYY-MM-DD format." }, - { - "name": "timeseries", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "title": "fmp", - "description": "Number of days to look back. (provider: fmp)" - }, - "description": "Number of days to look back. (provider: fmp)" - }, { "name": "interval", "in": "query", @@ -124,13 +104,13 @@ "anyOf": [ { "enum": [ - "1min", - "5min", - "15min", - "30min", - "1hour", - "4hour", - "1day" + "1m", + "5m", + "15m", + "30m", + "1h", + "4h", + "1d" ], "type": "string" }, @@ -138,11 +118,11 @@ "type": "string" } ], - "title": "fmp,polygon,tiingo", - "description": "Data granularity. (provider: fmp, polygon, tiingo)", - "default": "1day" + "title": "fmp,polygon", + "description": "Time interval of the data to return. (provider: fmp);\n Time 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)", + "default": "1d" }, - "description": "Data granularity. (provider: fmp, polygon, tiingo)" + "description": "Time interval of the data to return. (provider: fmp);\n Time 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": "sort", @@ -155,10 +135,10 @@ ], "type": "string", "title": "polygon", - "description": "Sort order of the data. (provider: polygon)", - "default": "desc" + "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)", + "default": "asc" }, - "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": "limit", @@ -171,27 +151,6 @@ "default": 49999 }, "description": "The number of data entries to return. (provider: polygon)" - }, - { - "name": "exchanges", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "null" - } - ], - "title": "tiingo", - "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo)" - }, - "description": "To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] (provider: tiingo)" } ], "responses": { @@ -241,11 +200,34 @@ }, "model": "CryptoHistorical", "examples": [ - "obb.crypto.price.historical(symbol=\"BTCUSD\")", - "obb.crypto.price.historical(\"BTCUSD\", start_date=\"2024-01-01\", end_date=\"2024-01-31\")", - "obb.crypto.price.historical(\"ETH-USD\", provider=\"yfinance\", interval=\"1mo\", start_date=\"2024-01-01\", end_date=\"2024-12-31\")", - "obb.crypto.price.historical(\"BTCUSD,ETH-USD\", provider=\"yfinance\", interval=\"1d\", start_date=\"2024-01-01\", end_date=\"2024-01-31\")", - "obb.crypto.price.historical([\"BTCUSD\", \"ETH-USD\"], start_date=\"2024-01-01\", end_date=\"2024-01-31\")" + { + "scope": "api", + "parameters": { + "symbol": "BTCUSD", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "BTCUSD", + "start_date": "2024-01-01", + "end_date": "2024-01-31", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "BTCUSD,ETHUSD", + "start_date": "2024-01-01", + "end_date": "2024-01-31", + "provider": "polygon" + }, + "provider": "polygon" + } ] } }, @@ -268,7 +250,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -339,9 +325,21 @@ }, "model": "CryptoSearch", "examples": [ - "obb.crypto.search()", - "obb.crypto.search(\"BTCUSD\")", - "obb.crypto.search(\"ETH-USD\")" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "query": "BTCUSD", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -366,8 +364,7 @@ "schema": { "enum": [ "fmp", - "polygon", - "tiingo" + "polygon" ], "type": "string", "title": "Provider" @@ -379,13 +376,14 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ + "fmp", "polygon" ], "title": "Symbol" }, - "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": "start_date", @@ -433,13 +431,13 @@ "anyOf": [ { "enum": [ - "1min", - "5min", - "15min", - "30min", - "1hour", - "4hour", - "1day" + "1m", + "5m", + "15m", + "30m", + "1h", + "4h", + "1d" ], "type": "string" }, @@ -447,11 +445,11 @@ "type": "string" } ], - "title": "fmp,polygon,tiingo", - "description": "Data granularity. (provider: fmp, polygon, tiingo)", - "default": "1day" + "title": "fmp,polygon", + "description": "Time interval of the data to return. (provider: fmp);\n Time 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)", + "default": "1d" }, - "description": "Data granularity. (provider: fmp, polygon, tiingo)" + "description": "Time interval of the data to return. (provider: fmp);\n Time 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": "sort", @@ -464,10 +462,10 @@ ], "type": "string", "title": "polygon", - "description": "Sort order of the data. (provider: polygon)", - "default": "desc" + "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)", + "default": "asc" }, - "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": "limit", @@ -529,11 +527,35 @@ }, "model": "CurrencyHistorical", "examples": [ - "obb.currency.price.historical(symbol=\"EURUSD\")", - "# Filter historical data with specific start and end date.", - "obb.currency.price.historical(symbol='EURUSD', start_date='2023-01-01', end_date='20213-12-31')", - "# Get data with different granularity.", - "obb.currency.price.historical(symbol='EURUSD', interval='15m', provider='polygon')" + { + "scope": "api", + "parameters": { + "symbol": "EURUSD", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Filter historical data with specific start and end date.", + "parameters": { + "symbol": "EURUSD", + "start_date": "2023-01-01", + "end_date": "2023-12-31", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get data with different granularity.", + "parameters": { + "symbol": "EURUSD", + "provider": "polygon", + "interval": "15m" + }, + "provider": "polygon" + } ] } }, @@ -762,13 +784,41 @@ }, "model": "CurrencyPairs", "examples": [ - "obb.currency.search()", - "# Search for 'EURUSD' currency pair using 'polygon' as provider.", - "obb.currency.search(provider='polygon', symbol='EURUSD')", - "# Search for terms using 'polygon' as provider.", - "obb.currency.search(provider='polygon', search='Euro zone')", - "# Search for actively traded currency pairs on the queried date using 'polygon' as provider.", - "obb.currency.search(provider='polygon', date='2024-01-02', active=True)" + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Search for 'EURUSD' currency pair using 'intrinio' as provider.", + "parameters": { + "provider": "intrinio", + "symbol": "EURUSD" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Search for actively traded currency pairs on the queried date using 'polygon' as provider.", + "parameters": { + "provider": "polygon", + "date": "2024-01-02", + "active": 1.0 + }, + "provider": "polygon" + }, + { + "scope": "api", + "description": "Search for terms using 'polygon' as provider.", + "parameters": { + "provider": "polygon", + "search": "Euro zone" + }, + "provider": "polygon" + } ] } }, @@ -791,7 +841,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "ecb" + ], "const": "ecb", + "type": "string", "default": "ecb", "title": "Provider" } @@ -844,7 +898,165 @@ }, "model": "CurrencyReferenceRates", "examples": [ - "obb.currency.reference_rates()" + { + "scope": "api", + "parameters": { + "provider": "ecb" + }, + "provider": "ecb" + } + ] + } + }, + "/api/v1/currency/snapshots": { + "get": { + "tags": [ + "currency" + ], + "summary": "Snapshots", + "description": "Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.", + "operationId": "currency_snapshots", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp" + ], + "const": "fmp", + "type": "string", + "default": "fmp", + "title": "Provider" + } + }, + { + "name": "base", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.", + "multiple_items_allowed": [ + "fmp" + ], + "default": "usd", + "title": "Base" + }, + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp." + }, + { + "name": "quote_type", + "in": "query", + "required": false, + "schema": { + "enum": [ + "direct", + "indirect" + ], + "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.", + "default": "indirect", + "title": "Quote Type" + }, + "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": "counter_currencies", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "title": "Counter Currencies" + }, + "description": "An optional list of counter currency symbols to filter for. None returns all." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CurrencySnapshots" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "CurrencySnapshots", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.", + "parameters": { + "provider": "fmp", + "base": "USD,XAU", + "counter_currencies": "EUR,JPY,GBP", + "quote_type": "indirect" + }, + "provider": "fmp" + } ] } }, @@ -867,7 +1079,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -950,9 +1166,24 @@ }, "model": "OptionsChains", "examples": [ - "chains = obb.derivatives.options.chains(symbol=\"AAPL\", provider=\"intrinio\").to_df()", - "#### Use the \"date\" parameter to get the end-of-day-data for a specific date, where supported. ####", - "eod_chains = obb.derivatives.options.chains(symbol=\"AAPL\", date=\"2023-01-25\", provider=\"intrinio\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Use the \"date\" parameter to get the end-of-day-data for a specific date, where supported.", + "parameters": { + "symbol": "AAPL", + "date": "2023-01-25", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -975,7 +1206,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -998,6 +1233,144 @@ }, "description": "Symbol to get data for. (the underlying symbol)" }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "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)" + }, + "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": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "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)" + }, + "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": "trade_type", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "block", + "sweep", + "large" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The type of unusual activity to query for. (provider: intrinio)" + }, + "description": "The type of unusual activity to query for. (provider: intrinio)" + }, + { + "name": "sentiment", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "bullish", + "bearish", + "neutral" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The sentiment type to query for. (provider: intrinio)" + }, + "description": "The sentiment type to query for. (provider: intrinio)" + }, + { + "name": "min_value", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)" + }, + "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)" + }, + { + "name": "max_value", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)" + }, + "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "title": "intrinio", + "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)", + "default": 100000 + }, + "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": "source", "in": "query", @@ -1062,9 +1435,22 @@ }, "model": "OptionsUnusual", "examples": [ - "options = obb.derivatives.options.unusual().to_df()", - "#### Use the \"symbol\" parameter to get the most recent activity for a specific symbol. ####", - "options = obb.derivatives.options.unusual(symbol=\"TSLA\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Use the 'symbol' parameter to get the most recent activity for a specific symbol.", + "parameters": { + "symbol": "TSLA", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -1087,7 +1473,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -1278,7 +1668,22 @@ }, "model": "GdpForecast", "examples": [ - "obb.economy.gdp.forecast(period=\"annual\", type=\"real\")" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "period": "annual", + "type": "real", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -1301,7 +1706,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -1409,7 +1818,8 @@ "switzerland", "turkey", "united_kingdom", - "united_states" + "united_states", + "all" ], "type": "string", "title": "oecd", @@ -1466,7 +1876,21 @@ }, "model": "GdpNominal", "examples": [ - "obb.economy.gdp.nominal(units=\"usd\")" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "units": "usd", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -1489,7 +1913,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -1609,7 +2037,8 @@ "switzerland", "turkey", "united_kingdom", - "united_states" + "united_states", + "all" ], "type": "string", "title": "oecd", @@ -1666,7 +2095,21 @@ }, "model": "GdpReal", "examples": [ - "obb.economy.gdp.real(units=\"yoy\")" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "units": "yoy", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -1749,12 +2192,12 @@ } ], "title": "tradingeconomics", - "description": "Country of the event. Multiple items allowed. (provider: tradingeconomics)", + "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", "multiple_items_allowed": [ "tradingeconomics" ] }, - "description": "Country of the event. Multiple items allowed. (provider: tradingeconomics)" + "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)" }, { "name": "importance", @@ -1860,9 +2303,23 @@ }, "model": "EconomicCalendar", "examples": [ - "obb.economy.calendar(provider=\"fmp\", start_date=\"2020-03-01\", end_date=\"2020-03-31\")", - "#### By default, the calendar will be forward-looking. ####", - "obb.economy.calendar(provider=\"nasdaq\")" + { + "scope": "api", + "description": "By default, the calendar will be forward-looking.", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "provider": "fmp", + "start_date": "2020-03-01", + "end_date": "2020-03-31" + }, + "provider": "fmp" + } ] } }, @@ -1885,7 +2342,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -1896,13 +2357,64 @@ "required": true, "schema": { "type": "string", - "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.", + "choices": [ + "australia", + "austria", + "belgium", + "brazil", + "bulgaria", + "canada", + "chile", + "china", + "croatia", + "cyprus", + "czech_republic", + "denmark", + "estonia", + "euro_area", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "malta", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "romania", + "russian_federation", + "slovak_republic", + "slovakia", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states" + ], "multiple_items_allowed": [ "fred" ], "title": "Country" }, - "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": "units", @@ -2036,9 +2548,24 @@ }, "model": "ConsumerPriceIndex", "examples": [ - "obb.economy.cpi(countries=[\"japan\", \"china\", \"turkey\"]).to_df()", - "#### Use the `units` parameter to define the reference period for the change in values. ####", - "obb.economy.cpi(countries=[\"united_states\", \"united_kingdom\"], units=\"growth_previous\").to_df()" + { + "scope": "api", + "parameters": { + "country": "japan,china,turkey", + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "description": "Use the `units` parameter to define the reference period for the change in values.", + "parameters": { + "country": "united_states,united_kingdom", + "units": "growth_previous", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -2061,7 +2588,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -2114,7 +2645,13 @@ }, "model": "RiskPremium", "examples": [ - "obb.economy.risk_premium().to_df()" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -2137,7 +2674,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "ecb" + ], "const": "ecb", + "type": "string", "default": "ecb", "title": "Provider" } @@ -2252,9 +2793,30 @@ }, "model": "BalanceOfPayments", "examples": [ - "obb.economy.balance_of_payments(report_type=\"summary\").to_df().set_index(\"period\").T", - "#### The `country` parameter will override the `report_type`. ####", - "obb.economy.balance_of_payments(country=\"united_states\", provider=\"ecb\").to_df().set_index(\"period\").T" + { + "scope": "api", + "parameters": { + "provider": "ecb" + }, + "provider": "ecb" + }, + { + "scope": "api", + "parameters": { + "report_type": "summary", + "provider": "ecb" + }, + "provider": "ecb" + }, + { + "scope": "api", + "description": "The `country` parameter will override the `report_type`.", + "parameters": { + "country": "united_states", + "provider": "ecb" + }, + "provider": "ecb" + } ] } }, @@ -2277,7 +2839,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -2514,7 +3080,13 @@ }, "model": "FredSearch", "examples": [ - "obb.economy.fred_search()" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -2551,13 +3123,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fred" ], "title": "Symbol" }, - "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": "start_date", @@ -2767,11 +3339,33 @@ }, "model": "FredSeries", "examples": [ - "obb.economy.fred_series(\"NFCI\").to_df()", - "#### Multiple series can be passed in as a list. ####", - "obb.economy.fred_series([\"NFCI\",\"STLFSI4\"]).to_df()", - "#### Use the `transform` parameter to transform the data as change, log, or percent change. ####", - "obb.economy.fred_series(\"CBBTCUSD\", transform=\"pc1\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "NFCI", + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "description": "Multiple series can be passed in as a list.", + "parameters": { + "symbol": "NFCI,STLFSI4", + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "description": "Use the `transform` parameter to transform the data as change, log, or percent change.", + "parameters": { + "symbol": "CBBTCUSD", + "transform": "pc1", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -2794,7 +3388,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "federal_reserve" + ], "const": "federal_reserve", + "type": "string", "default": "federal_reserve", "title": "Provider" } @@ -2904,7 +3502,21 @@ }, "model": "MoneyMeasures", "examples": [ - "obb.economy.money_measures(adjusted=False).to_df()" + { + "scope": "api", + "parameters": { + "provider": "federal_reserve" + }, + "provider": "federal_reserve" + }, + { + "scope": "api", + "parameters": { + "adjusted": 0.0, + "provider": "federal_reserve" + }, + "provider": "federal_reserve" + } ] } }, @@ -2927,7 +3539,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -3144,11 +3760,33 @@ }, "model": "Unemployment", "examples": [ - "obb.economy.unemployment(country=\"all\", frequency=\"quarterly\")", - "#### Demographics for the statistics are selected with the `age` and `sex` parameters. ####", - "obb.economy.unemployment(", - "country=\"all\", frequency=\"quarterly\", age=\"25-54\"", - ").to_df().pivot(columns=\"country\", values=\"value\")" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "country": "all", + "frequency": "quarterly", + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "description": "Demographics for the statistics are selected with the `age` parameter.", + "parameters": { + "country": "all", + "frequency": "quarterly", + "age": "25-54", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -3171,7 +3809,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -3296,7 +3938,21 @@ }, "model": "CLI", "examples": [ - "obb.economy.composite_leading_indicator(country=\"all\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "country": "all", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -3319,7 +3975,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -3487,7 +4147,22 @@ }, "model": "STIR", "examples": [ - "obb.economy.short_term_interest_rate(country=\"all\", frequency=\"quarterly\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "country": "all", + "frequency": "quarterly", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -3510,7 +4185,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "oecd" + ], "const": "oecd", + "type": "string", "default": "oecd", "title": "Provider" } @@ -3678,7 +4357,22 @@ }, "model": "LTIR", "examples": [ - "obb.economy.long_term_interest_rate(country=\"all\", frequency=\"quarterly\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "oecd" + }, + "provider": "oecd" + }, + { + "scope": "api", + "parameters": { + "country": "all", + "frequency": "quarterly", + "provider": "oecd" + }, + "provider": "oecd" + } ] } }, @@ -3701,7 +4395,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -3712,13 +4410,10 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed for provider(s): fred.", - "multiple_items_allowed": [ - "fred" - ], + "description": "Symbol to get data for.", "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed for provider(s): fred." + "description": "Symbol to get data for." }, { "name": "start_date", @@ -3983,10 +4678,26 @@ }, "model": "FredRegional", "examples": [ - "#### With no date, the most recent report is returned. ####", - "obb.economy.fred_regional(\"NYICLAIMS\")", - "#### With a date, time series data is returned. ####", - "obb.economy.fred_regional(\"NYICLAIMS\", start_date=\"2021-01-01\")" + { + "scope": "api", + "parameters": { + "symbol": "NYICLAIMS", + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "description": "With a date, time series data is returned.", + "parameters": { + "symbol": "NYICLAIMS", + "start_date": "2021-01-01", + "end_date": "2021-12-31", + "limit": 10, + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -4009,7 +4720,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -4196,11 +4911,21 @@ }, "model": "CalendarIpo", "examples": [ - "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')" + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Get all IPOs available.", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -4223,7 +4948,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -4314,9 +5043,13 @@ }, "model": "CalendarDividend", "examples": [ - "obb.equity.calendar.dividend()", - "# Get dividend calendar for specific dates.", - "obb.equity.calendar.dividend(start_date='2024-02-01', end_date='2024-02-07')" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -4339,7 +5072,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -4430,9 +5167,23 @@ }, "model": "CalendarSplits", "examples": [ - "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')" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get stock splits calendar for specific dates.", + "parameters": { + "start_date": "2024-02-01", + "end_date": "2024-02-07", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -4455,7 +5206,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -4546,9 +5301,23 @@ }, "model": "CalendarEarnings", "examples": [ - "obb.equity.calendar.earnings()", - "# Get earnings calendar for specific dates.", - "obb.equity.calendar.earnings(start_date='2024-02-01', end_date='2024-02-07')" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get earnings calendar for specific dates.", + "parameters": { + "start_date": "2024-02-01", + "end_date": "2024-02-07", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -4571,7 +5340,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -4635,7 +5408,14 @@ }, "model": "EquityPeers", "examples": [ - "obb.equity.compare.peers(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -4679,13 +5459,14 @@ "type": "null" } ], - "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.", "multiple_items_allowed": [ - "benzinga" + "benzinga", + "fmp" ], "title": "Symbol" }, - "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": "limit", @@ -4852,26 +5633,26 @@ "required": false, "schema": { "anyOf": [ - { - "type": "string" - }, { "type": "array", "items": { "type": "string" } }, + { + "type": "string" + }, { "type": "null" } ], "title": "benzinga", - "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)", "multiple_items_allowed": [ "benzinga" ] }, - "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": "firm_ids", @@ -4879,26 +5660,26 @@ "required": false, "schema": { "anyOf": [ - { - "type": "string" - }, { "type": "array", "items": { "type": "string" } }, + { + "type": "string" + }, { "type": "null" } ], "title": "benzinga", - "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)", "multiple_items_allowed": [ "benzinga" ] }, - "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": "fields", @@ -4906,26 +5687,26 @@ "required": false, "schema": { "anyOf": [ - { - "type": "string" - }, { "type": "array", "items": { "type": "string" } }, + { + "type": "string" + }, { "type": "null" } ], "title": "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 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)", "multiple_items_allowed": [ "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 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": "with_grade", @@ -4987,7 +5768,26 @@ }, "model": "PriceTarget", "examples": [ - "obb.equity.estimates.price_target(start_date=\"2020-01-01\", end_date=\"2024-02-16\",limit=10, symbol=\"msft\", provider=\"benzinga\",action=\"downgrades\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "description": "Get price targets for Microsoft using 'benzinga' as provider.", + "parameters": { + "start_date": "2020-01-01", + "end_date": "2024-02-16", + "limit": 10, + "symbol": "msft", + "provider": "benzinga", + "action": "downgrades" + }, + "provider": "benzinga" + } ] } }, @@ -5010,7 +5810,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -5021,10 +5825,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "multiple_items_allowed": [ + "fmp" + ], "title": "Symbol" }, - "description": "Symbol to get data for." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." }, { "name": "period", @@ -5036,23 +5843,29 @@ "annual" ], "type": "string", - "description": "Time period of the data to return.", - "default": "annual", - "title": "Period" + "title": "fmp", + "description": "Time period of the data to return. (provider: fmp)", + "default": "annual" }, - "description": "Time period of the data to return." + "description": "Time period of the data to return. (provider: fmp)" }, { "name": "limit", "in": "query", "required": false, "schema": { - "type": "integer", - "description": "The number of data entries to return.", - "default": 30, - "title": "Limit" + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "fmp", + "description": "The number of data entries to return. (provider: fmp)" }, - "description": "The number of data entries to return." + "description": "The number of data entries to return. (provider: fmp)" } ], "responses": { @@ -5102,7 +5915,14 @@ }, "model": "AnalystEstimates", "examples": [ - "obb.equity.estimates.historical(\"AAPL\", period=\"quarter\", provider=\"fmp\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -5125,7 +5945,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -5136,10 +5960,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", + "multiple_items_allowed": [ + "fmp" + ], "title": "Symbol" }, - "description": "Symbol to get data for." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { @@ -5189,7 +6016,14 @@ }, "model": "PriceTargetConsensus", "examples": [ - "obb.equity.estimates.consensus(\"AAPL,MSFT\", provider=\"yfinance\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -5212,7 +6046,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "benzinga" + ], "const": "benzinga", + "type": "string", "default": "benzinga", "title": "Provider" } @@ -5230,10 +6068,13 @@ "type": "null" } ], - "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.", + "multiple_items_allowed": [ + "benzinga" + ], "title": "Analyst Name" }, - "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": "firm_name", @@ -5248,10 +6089,13 @@ "type": "null" } ], - "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.", + "multiple_items_allowed": [ + "benzinga" + ], "title": "Firm Name" }, - "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": "analyst_ids", @@ -5262,20 +6106,17 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } ], "title": "benzinga", - "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)", + "multiple_items_allowed": [ + "benzinga" + ] }, - "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": "firm_ids", @@ -5286,20 +6127,17 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } ], "title": "benzinga", - "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)", + "multiple_items_allowed": [ + "benzinga" + ] }, - "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": "limit", @@ -5348,20 +6186,17 @@ { "type": "string" }, - { - "type": "array", - "items": { - "type": "string" - } - }, { "type": "null" } ], "title": "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. (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)", + "multiple_items_allowed": [ + "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. (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)" } ], "responses": { @@ -5411,7 +6246,21 @@ }, "model": "AnalystSearch", "examples": [ - "obb.equity.estimates.analyst_search(firm_name=\"Wedbush\", provider=\"benzinga\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "parameters": { + "firm_name": "Wedbush", + "provider": "benzinga" + }, + "provider": "benzinga" + } ] } }, @@ -5434,7 +6283,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -5573,9 +6426,24 @@ }, "model": "DiscoveryFilings", "examples": [ - "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')" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get filings for the year 2023, limited to 100 results", + "parameters": { + "start_date": "2023-01-01", + "end_date": "2023-12-31", + "limit": 100, + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -5598,7 +6466,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -5609,13 +6481,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "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." } ], "responses": { @@ -5665,7 +6537,14 @@ }, "model": "EquityValuationMultiples", "examples": [ - "obb.equity.fundamental.multiples(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -6052,7 +6931,24 @@ }, "model": "BalanceSheet", "examples": [ - "obb.equity.fundamental.balance(symbol=\"AAPL\", period=\"annual\", limit=5)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 5, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -6075,7 +6971,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -6151,7 +7051,23 @@ }, "model": "BalanceSheetGrowth", "examples": [ - "obb.equity.fundamental.balance_growth(symbol=\"AAPL\", limit=10)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "limit": 10, + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -6524,7 +7440,24 @@ }, "model": "CashFlowStatement", "examples": [ - "obb.equity.fundamental.cash(symbol=\"AAPL\", period=\"annual\", limit=5)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 5, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -6547,7 +7480,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -6672,11 +7609,46 @@ }, "model": "ReportedFinancials", "examples": [ - "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')" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Get AAPL balance sheet with a limit of 10 items.", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "statement_type": "balance", + "limit": 10, + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Get reported income statement", + "parameters": { + "symbol": "AAPL", + "statement_type": "income", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Get reported cash flow statement", + "parameters": { + "symbol": "AAPL", + "statement_type": "cash", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -6699,7 +7671,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -6775,7 +7751,23 @@ }, "model": "CashFlowStatementGrowth", "examples": [ - "obb.equity.fundamental.cash_growth(symbol=\"AAPL\", limit=10)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "limit": 10, + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -6922,7 +7914,14 @@ }, "model": "HistoricalDividends", "examples": [ - "obb.equity.fundamental.dividends(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -6945,7 +7944,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -7027,7 +8030,14 @@ }, "model": "HistoricalEps", "examples": [ - "obb.equity.fundamental.historical_eps(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -7050,7 +8060,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -7114,7 +8128,14 @@ }, "model": "HistoricalEmployees", "examples": [ - "obb.equity.fundamental.employee_count(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -7137,7 +8158,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -7220,7 +8245,14 @@ }, "model": "SearchAttributes", "examples": [ - "obb.equity.fundamental.search_attributes(query='ebitda')" + { + "scope": "api", + "parameters": { + "query": "ebitda", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -7243,7 +8275,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -7254,13 +8290,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "intrinio" ], "title": "Symbol" }, - "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": "tag", @@ -7268,13 +8304,13 @@ "required": true, "schema": { "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.", "multiple_items_allowed": [ "intrinio" ], "title": "Tag" }, - "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." } ], "responses": { @@ -7324,7 +8360,15 @@ }, "model": "LatestAttributes", "examples": [ - "obb.equity.fundamental.latest_attributes(tag='ceo')" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "tag": "ceo", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -7347,7 +8391,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "intrinio" + ], "const": "intrinio", + "type": "string", "default": "intrinio", "title": "Provider" } @@ -7358,13 +8406,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "intrinio" ], "title": "Symbol" }, - "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": "tag", @@ -7372,13 +8420,13 @@ "required": true, "schema": { "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.", "multiple_items_allowed": [ "intrinio" ], "title": "Tag" }, - "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": "start_date", @@ -7552,7 +8600,15 @@ }, "model": "HistoricalAttributes", "examples": [ - "obb.equity.fundamental.historical_attributes(tag='ebitda')" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "tag": "ebitda", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -7945,7 +9001,24 @@ }, "model": "IncomeStatement", "examples": [ - "obb.equity.fundamental.income(symbol=\"AAPL\", period=\"annual\", limit=5)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 5, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -7968,7 +9041,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8060,7 +9137,24 @@ }, "model": "IncomeStatementGrowth", "examples": [ - "obb.equity.fundamental.income_growth(symbol=\"AAPL\", limit=10, period=\"annual\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "limit": 10, + "period": "annual", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -8097,24 +9191,32 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ - "fmp" + "fmp", + "intrinio" ], "title": "Symbol" }, - "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": "period", "in": "query", "required": false, "schema": { - "enum": [ - "annual", - "quarter" + "anyOf": [ + { + "enum": [ + "annual", + "quarter" + ], + "type": "string" + }, + { + "type": "null" + } ], - "type": "string", "description": "Time period of the data to return.", "default": "annual", "title": "Period" @@ -8207,7 +9309,24 @@ }, "model": "KeyMetrics", "examples": [ - "obb.equity.fundamental.metrics(symbol=\"AAPL\", period=\"annual\", limit=100)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 100, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -8230,7 +9349,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8294,7 +9417,14 @@ }, "model": "KeyExecutives", "examples": [ - "obb.equity.fundamental.management(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -8317,7 +9447,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8328,51 +9462,31 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "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": "start_date", + "name": "year", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "integer" }, { "type": "null" } ], - "description": "Start date of the data, in YYYY-MM-DD format.", - "title": "Start Date" + "title": "fmp", + "description": "Year of the compensation. (provider: fmp)" }, - "description": "Start date of the data, in YYYY-MM-DD format." - }, - { - "name": "end_date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "description": "End date of the data, in YYYY-MM-DD format.", - "title": "End Date" - }, - "description": "End date of the data, in YYYY-MM-DD format." + "description": "Year of the compensation. (provider: fmp)" } ], "responses": { @@ -8422,7 +9536,14 @@ }, "model": "ExecutiveCompensation", "examples": [ - "obb.equity.fundamental.management_compensation(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -8446,7 +9567,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8510,7 +9635,14 @@ }, "model": "CompanyOverview", "examples": [ - "obb.equity.fundamental.overview(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -8547,14 +9679,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ - "fmp", - "intrinio" + "fmp" ], "title": "Symbol" }, - "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": "period", @@ -8593,11 +9724,11 @@ "type": "null" } ], - "title": "fmp,intrinio", - "description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)", + "title": "fmp", + "description": "Include trailing twelve months (TTM) data. (provider: fmp)", "default": false }, - "description": "Include trailing twelve months (TTM) data. (provider: fmp, intrinio)" + "description": "Include trailing twelve months (TTM) data. (provider: fmp)" }, { "name": "fiscal_year", @@ -8665,7 +9796,24 @@ }, "model": "FinancialRatios", "examples": [ - "obb.equity.fundamental.ratios(symbol=\"AAPL\", period=\"annual\", limit=12)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 12, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -8688,7 +9836,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8784,7 +9936,24 @@ }, "model": "RevenueGeographic", "examples": [ - "obb.equity.fundamental.revenue_per_geography(symbol=\"AAPL\", period=\"annual\", structure=\"flat\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "structure": "flat", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -8807,7 +9976,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -8903,7 +10076,24 @@ }, "model": "RevenueBusinessLine", "examples": [ - "obb.equity.fundamental.revenue_per_segment(symbol=\"AAPL\", period=\"annual\", structure=\"flat\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "structure": "flat", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -9347,22 +10537,6 @@ }, "description": "The number of data entries to return." }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string", - "title": "fmp", - "description": "Sort the data in ascending or descending order. (provider: fmp)", - "default": "desc" - }, - "description": "Sort the data in ascending or descending order. (provider: fmp)" - }, { "name": "start_date", "in": "query", @@ -9500,7 +10674,21 @@ }, "model": "CompanyFilings", "examples": [ - "obb.equity.fundamental.filings(limit=100)" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "limit": 100, + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -9523,7 +10711,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -9587,7 +10779,14 @@ }, "model": "HistoricalSplits", "examples": [ - "obb.equity.fundamental.historical_splits(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -9610,7 +10809,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -9629,39 +10832,13 @@ { "name": "year", "in": "query", - "required": false, + "required": true, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "type": "integer", "description": "Year of the earnings call transcript.", "title": "Year" }, "description": "Year of the earnings call transcript." - }, - { - "name": "earnings_date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "fmp", - "description": "Date of the earnings call transcript. (provider: fmp)" - }, - "description": "Date of the earnings call transcript. (provider: fmp)" } ], "responses": { @@ -9711,120 +10888,15 @@ }, "model": "EarningsCallTranscript", "examples": [ - "obb.equity.fundamental.transcript(symbol='AAPL', year=2020)" - ] - } - }, - "/api/v1/equity/fundamental/trailing_dividend_yield": { - "get": { - "tags": [ - "equity" - ], - "summary": "Trailing Dividend Yield", - "description": "Get the 1 year trailing dividend yield for a given company over time.", - "operationId": "equity_fundamental_trailing_dividend_yield", - "security": [ { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ - { - "name": "provider", - "in": "query", - "required": false, - "schema": { - "const": "tiingo", - "default": "tiingo", - "title": "Provider" - } - }, - { - "name": "symbol", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Symbol to get data for.", - "title": "Symbol" + "scope": "api", + "parameters": { + "symbol": "AAPL", + "year": 2020, + "provider": "fmp" }, - "description": "Symbol to get data for." - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "The number of data entries to return. Default is 252, the number of trading days in a year.", - "default": 252, - "title": "Limit" - }, - "description": "The number of data entries to return. Default is 252, the number of trading days in a year." + "provider": "fmp" } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_TrailingDividendYield" - } - } - } - }, - "404": { - "description": "Not found" - }, - "400": { - "description": "No Results Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OpenBBErrorResponse" - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OpenBBErrorResponse" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - }, - "model": "TrailingDividendYield", - "examples": [ - "obb.equity.fundamental.trailing_dividend_yield(limit=252)" ] } }, @@ -9847,7 +10919,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -9900,24 +10976,6 @@ "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": { @@ -9967,7 +11025,23 @@ }, "model": "EquityOwnership", "examples": [ - "obb.equity.ownership.major_holders(symbol=\"AAPL\", page=0)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "page": 0, + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -9988,13 +11062,14 @@ { "name": "provider", "in": "query", - "required": true, + "required": false, "schema": { "enum": [ - "fmp", - "intrinio" + "fmp" ], + "const": "fmp", "type": "string", + "default": "fmp", "title": "Provider" } }, @@ -10046,25 +11121,6 @@ "description": "A specific date to get data for. (provider: fmp)" }, "description": "A specific date to get data for. (provider: fmp)" - }, - { - "name": "page_size", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "The number of data entries to return. (provider: intrinio)", - "default": 100 - }, - "description": "The number of data entries to return. (provider: intrinio)" } ], "responses": { @@ -10114,7 +11170,14 @@ }, "model": "InstitutionalOwnership", "examples": [ - "obb.equity.ownership.institutional(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -10330,7 +11393,23 @@ }, "model": "InsiderTrading", "examples": [ - "obb.equity.ownership.insider_trading(symbol=\"AAPL\", limit=500)" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "limit": 500, + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -10420,7 +11499,169 @@ }, "model": "ShareStatistics", "examples": [ - "obb.equity.ownership.share_statistics(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/equity/ownership/form_13f": { + "get": { + "tags": [ + "equity" + ], + "summary": "Form 13F", + "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.", + "operationId": "equity_ownership_form_13f", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "sec" + ], + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for. A CIK or Symbol can be used.", + "title": "Symbol" + }, + "description": "Symbol to get data for. A CIK or Symbol can be used." + }, + { + "name": "date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "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.", + "title": "Date" + }, + "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": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", + "default": 1, + "title": "Limit" + }, + "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_Form13FHR" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "Form13FHR", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "NVDA", + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "description": "Enter a date (calendar quarter ending) for a specific report.", + "parameters": { + "symbol": "BRK-A", + "date": "2016-09-30", + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "python", + "description": "Example finding Michael Burry's filings.", + "code": [ + "cik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik", + "# Use the `limit` parameter to return N number of reports from the most recent.", + "obb.equity.ownership.form_13f(cik, limit=2).to_df()" + ] + } ] } }, @@ -10457,14 +11698,14 @@ "required": true, "schema": { "type": "string", - "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.", "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 for provider(s): fmp, intrinio." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." }, { "name": "source", @@ -10537,7 +11778,14 @@ }, "model": "EquityQuote", "examples": [ - "obb.equity.price.quote(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -10560,7 +11808,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "polygon" + ], "const": "polygon", + "type": "string", "default": "polygon", "title": "Provider" } @@ -10625,9 +11877,9 @@ } ], "title": "polygon", - "description": "\n Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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)" }, - "description": "\n Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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_gt", @@ -10647,9 +11899,9 @@ } ], "title": "polygon", - "description": "\n Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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)" }, - "description": "\n Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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_lte", @@ -10669,9 +11921,9 @@ } ], "title": "polygon", - "description": "\n Query by datetime, less than or equal to.\n Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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)" }, - "description": "\n Query by datetime, less than or equal to.\n Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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_gte", @@ -10691,9 +11943,9 @@ } ], "title": "polygon", - "description": "\n Query by datetime, greater than or equal to.\n Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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)" }, - "description": "\n Query by datetime, greater than or equal to.\n Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string,\n YYYY-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)" } ], "responses": { @@ -10743,7 +11995,14 @@ }, "model": "EquityNBBO", "examples": [ - "obb.equity.price.nbbo(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "polygon" + }, + "provider": "polygon" + } ] } }, @@ -10769,8 +12028,7 @@ "enum": [ "fmp", "intrinio", - "polygon", - "tiingo" + "polygon" ], "type": "string", "title": "Provider" @@ -10782,15 +12040,14 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp", - "polygon", - "tiingo" + "polygon" ], "title": "Symbol" }, - "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": "interval", @@ -10849,44 +12106,6 @@ }, "description": "End date of the data, in YYYY-MM-DD format." }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "fmp,intrinio,polygon", - "description": "Number of days to look back (Only for interval 1d). (provider: fmp);\n The number of results to return per page. (provider: intrinio);\n The number of data entries to return. (provider: polygon)" - }, - "description": "Number of days to look back (Only for interval 1d). (provider: fmp);\n The number of results to return per page. (provider: intrinio);\n The number of data entries to return. (provider: polygon)" - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string", - "title": "fmp,polygon", - "description": "Sort the data in ascending or descending order. (provider: fmp);\n Sort order of the data. (provider: polygon)", - "default": "desc" - }, - "description": "Sort the data in ascending or descending order. (provider: fmp);\n Sort order of the data. (provider: polygon)" - }, { "name": "start_time", "in": "query", @@ -10930,10 +12149,17 @@ "in": "query", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "intrinio", "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)", - "default": "UTC" + "default": "America/New_York" }, "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)" }, @@ -10955,35 +12181,60 @@ "description": "The source of the data. (provider: intrinio)" }, { - "name": "sleep", + "name": "adjustment", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } + "enum": [ + "splits_only", + "unadjusted" ], - "title": "intrinio", - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", - "default": 1.0 + "type": "string", + "title": "polygon", + "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)", + "default": "splits_only" }, - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)" + "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)" }, { - "name": "adjusted", + "name": "extended_hours", "in": "query", "required": false, "schema": { "type": "boolean", "title": "polygon", - "description": "Output time series is adjusted by historical split and dividend events. (provider: polygon)", - "default": true + "description": "Include Pre and Post market data. (provider: polygon)", + "default": false }, - "description": "Output time series is adjusted by historical split and dividend events. (provider: polygon)" + "description": "Include Pre and Post market data. (provider: polygon)" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string", + "title": "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)", + "default": "asc" + }, + "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": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "title": "polygon", + "description": "The number of data entries to return. (provider: polygon)", + "default": 49999 + }, + "description": "The number of data entries to return. (provider: polygon)" } ], "responses": { @@ -11033,7 +12284,23 @@ }, "model": "EquityHistorical", "examples": [ - "obb.equity.price.historical(symbol=\"AAPL\", interval=\"1d\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "interval": "1d", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -11056,7 +12323,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -11067,13 +12338,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "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." } ], "responses": { @@ -11123,7 +12394,14 @@ }, "model": "PricePerformance", "examples": [ - "obb.equity.price.performance(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -11146,7 +12424,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -11248,7 +12530,14 @@ }, "model": "EquityFTD", "examples": [ - "obb.equity.shorts.fails_to_deliver(symbol='AAPL')" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -11420,7 +12709,13 @@ }, "model": "EquitySearch", "examples": [ - "obb.equity.search(query=\"AAPL\", is_symbol=False, use_cache=True)" + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -11443,7 +12738,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -11746,6 +13045,7 @@ { "enum": [ "amex", + "ams", "ase", "asx", "ath", @@ -11774,6 +13074,7 @@ "kuw", "lse", "mex", + "mutual_fund", "nasdaq", "neo", "nse", @@ -11878,7 +13179,13 @@ }, "model": "EquityScreener", "examples": [ - "obb.equity.screener()" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -11915,14 +13222,14 @@ "required": true, "schema": { "type": "string", - "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, intrinio.", "multiple_items_allowed": [ "fmp", "intrinio" ], "title": "Symbol" }, - "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, intrinio." } ], "responses": { @@ -11972,7 +13279,14 @@ }, "model": "EquityInfo", "examples": [ - "obb.equity.profile(symbol=\"AAPL\")" + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -11997,6 +13311,7 @@ "schema": { "enum": [ "fmp", + "intrinio", "polygon" ], "type": "string", @@ -12009,71 +13324,95 @@ "required": false, "schema": { "enum": [ - "AMEX", - "AMS", - "ASE", - "ASX", - "ATH", - "BME", - "BRU", - "BUD", - "BUE", - "CAI", - "CNQ", - "CPH", - "DFM", - "DOH", - "DUS", - "ETF", - "EURONEXT", - "HEL", - "HKSE", - "ICE", - "IOB", - "IST", - "JKT", - "JNB", - "JPX", - "KLS", - "KOE", - "KSC", - "KUW", - "LSE", - "MEX", - "MIL", - "NASDAQ", - "NEO", - "NSE", - "NYSE", - "NZE", - "OSL", - "OTC", - "PNK", - "PRA", - "RIS", - "SAO", - "SAU", - "SES", - "SET", - "SGO", - "SHH", - "SHZ", - "SIX", - "STO", - "TAI", - "TLV", - "TSX", - "TWO", - "VIE", - "WSE", - "XETRA" + "amex", + "ams", + "ase", + "asx", + "ath", + "bme", + "bru", + "bud", + "bue", + "cai", + "cnq", + "cph", + "dfm", + "doh", + "etf", + "euronext", + "hel", + "hkse", + "ice", + "iob", + "ist", + "jkt", + "jnb", + "jpx", + "kls", + "koe", + "ksc", + "kuw", + "lse", + "mex", + "mutual_fund", + "nasdaq", + "neo", + "nse", + "nyse", + "nze", + "osl", + "otc", + "pnk", + "pra", + "ris", + "sao", + "sau", + "set", + "sgo", + "shh", + "shz", + "six", + "sto", + "tai", + "tlv", + "tsx", + "two", + "vie", + "wse", + "xetra" ], "type": "string", "title": "fmp", "description": "The market to fetch data for. (provider: fmp)", - "default": "NASDAQ" + "default": "nasdaq" }, "description": "The market to fetch data for. (provider: fmp)" + }, + { + "name": "date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "string", + "format": "date-time" + }, + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "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)" + }, + "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)" } ], "responses": { @@ -12123,7 +13462,13 @@ }, "model": "MarketSnapshots", "examples": [ - "obb.equity.market_snapshots()" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12144,10 +13489,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { - "const": "fmp", - "default": "fmp", + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", "title": "Provider" } }, @@ -12187,14 +13535,39 @@ ], "type": "string" }, + { + "enum": [ + "xnas", + "arcx", + "bats", + "xnys", + "bvmf", + "xshg", + "xshe", + "xhkg", + "xbom", + "xnse", + "xidx", + "tase", + "xkrx", + "xkls", + "xmex", + "xses", + "roco", + "xtai", + "xbkk", + "xist" + ], + "type": "string" + }, { "type": "null" } ], - "title": "fmp", - "description": "The exchange code the ETF trades on. (provider: fmp)" + "title": "fmp,intrinio", + "description": "The exchange code the ETF trades on. (provider: fmp);\n Target a specific exchange by providing the MIC code. (provider: intrinio)" }, - "description": "The exchange code the ETF trades on. (provider: fmp)" + "description": "The exchange code the ETF trades on. (provider: fmp);\n Target a specific exchange by providing the MIC code. (provider: intrinio)" }, { "name": "is_active", @@ -12266,9 +13639,312 @@ }, "model": "EtfSearch", "examples": [ - "### An empty query returns the full list of ETFs from the provider. ###", - "obb.etf.search(\"\", provider=\"fmp\")", - "#### The query will return results from text-based fields containing the term. ####obb.etf.search(\"commercial real estate\", provider=\"fmp\")" + { + "scope": "api", + "description": "An empty query returns the full list of ETFs from the provider.", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "The query will return results from text-based fields containing the term.", + "parameters": { + "query": "commercial real estate", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/etf/historical": { + "get": { + "tags": [ + "etf" + ], + "summary": "Historical", + "description": "ETF Historical Market Price.", + "operationId": "etf_historical", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": true, + "schema": { + "enum": [ + "fmp", + "intrinio", + "polygon" + ], + "type": "string", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "multiple_items_allowed": [ + "fmp", + "polygon" + ], + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon." + }, + { + "name": "interval", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Time interval of the data to return.", + "default": "1d", + "title": "Interval" + }, + "description": "Time interval of the data to return." + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "description": "Start date of the data, in YYYY-MM-DD format.", + "title": "Start Date" + }, + "description": "Start date of the data, in YYYY-MM-DD format." + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "description": "End date of the data, in YYYY-MM-DD format.", + "title": "End Date" + }, + "description": "End date of the data, in YYYY-MM-DD format." + }, + { + "name": "start_time", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "time" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" + }, + "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" + }, + { + "name": "end_time", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "time" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" + }, + "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" + }, + { + "name": "timezone", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)", + "default": "America/New_York" + }, + "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)" + }, + { + "name": "source", + "in": "query", + "required": false, + "schema": { + "enum": [ + "realtime", + "delayed", + "nasdaq_basic" + ], + "type": "string", + "title": "intrinio", + "description": "The source of the data. (provider: intrinio)", + "default": "realtime" + }, + "description": "The source of the data. (provider: intrinio)" + }, + { + "name": "adjustment", + "in": "query", + "required": false, + "schema": { + "enum": [ + "splits_only", + "unadjusted" + ], + "type": "string", + "title": "polygon", + "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)", + "default": "splits_only" + }, + "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)" + }, + { + "name": "extended_hours", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "polygon", + "description": "Include Pre and Post market data. (provider: polygon)", + "default": false + }, + "description": "Include Pre and Post market data. (provider: polygon)" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ], + "type": "string", + "title": "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)", + "default": "asc" + }, + "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": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "title": "polygon", + "description": "The number of data entries to return. (provider: polygon)", + "default": 49999 + }, + "description": "The number of data entries to return. (provider: polygon)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_EtfHistorical" + } + } + } + }, + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "model": "EtfHistorical", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "SPY", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12289,10 +13965,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { - "const": "fmp", - "default": "fmp", + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", "title": "Provider" } }, @@ -12302,13 +13981,14 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", "multiple_items_allowed": [ - "fmp" + "fmp", + "intrinio" ], "title": "Symbol" }, - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp." + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio." } ], "responses": { @@ -12358,9 +14038,23 @@ }, "model": "EtfInfo", "examples": [ - "obb.etf.info(\"SPY\", provider=\"fmp\")", - "#### This function accepts multiple tickers. ####", - "obb.etf.info(\"SPY,IWM,QQQ,DJIA\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "SPY", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "This function accepts multiple tickers.", + "parameters": { + "symbol": "SPY,IWM,QQQ,DJIA", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12383,7 +14077,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -12447,7 +14145,14 @@ }, "model": "EtfSectors", "examples": [ - "obb.etf.sectors(\"SPY\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "SPY", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12470,7 +14175,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -12481,13 +14190,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "description": "Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp." + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { @@ -12537,7 +14246,14 @@ }, "model": "EtfCountries", "examples": [ - "obb.etf.countries(\"VT\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "VT", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12547,7 +14263,7 @@ "etf" ], "summary": "Price Performance", - "description": "Price performance as a return, over different periods. This is a proxy for `equity.price.performance`.", + "description": "Price performance as a return, over different periods.", "operationId": "etf_price_performance", "security": [ { @@ -12558,10 +14274,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { - "const": "fmp", - "default": "fmp", + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", "title": "Provider" } }, @@ -12571,13 +14290,46 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ - "fmp" + "fmp", + "intrinio" ], "title": "Symbol" }, - "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": "return_type", + "in": "query", + "required": false, + "schema": { + "enum": [ + "trailing", + "calendar" + ], + "type": "string", + "title": "intrinio", + "description": "The type of returns to return, a trailing or calendar window. (provider: intrinio)", + "default": "trailing" + }, + "description": "The type of returns to return, a trailing or calendar window. (provider: intrinio)" + }, + { + "name": "adjustment", + "in": "query", + "required": false, + "schema": { + "enum": [ + "splits_only", + "splits_and_dividends" + ], + "type": "string", + "title": "intrinio", + "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)", + "default": "splits_and_dividends" + }, + "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)" } ], "responses": { @@ -12586,7 +14338,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_PricePerformance" + "$ref": "#/components/schemas/OBBject_EtfPricePerformance" } } } @@ -12625,9 +14377,24 @@ } } }, - "model": "PricePerformance", + "model": "EtfPricePerformance", "examples": [ - "obb.etf.price_performance(\"SPY,QQQ,IWM,DJIA\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "QQQ", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "SPY,QQQ,IWM,DJIA", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12652,6 +14419,7 @@ "schema": { "enum": [ "fmp", + "intrinio", "sec" ], "type": "string", @@ -12687,9 +14455,9 @@ } ], "title": "fmp,sec", - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" }, - "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" + "description": "A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp);\n A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec)" }, { "name": "cik", @@ -12769,11 +14537,34 @@ }, "model": "EtfHoldings", "examples": [ - "obb.etf.holdings(\"XLK\", provider=\"fmp\").to_df()", - "#### Including a date (FMP, SEC) will return the holdings as per NPORT-P filings. ####", - "obb.etf.holdings(\"XLK\", date=\"2022-03-31\",provider=\"fmp\").to_df()", - "#### The same data can be returned from the SEC directly. ####", - "obb.etf.holdings(\"XLK\", date=\"2022-03-31\",provider=\"sec\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "XLK", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.", + "parameters": { + "symbol": "XLK", + "date": "2022-03-31", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "The same data can be returned from the SEC directly.", + "parameters": { + "symbol": "XLK", + "date": "2022-03-31", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -12796,7 +14587,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -12878,7 +14673,14 @@ }, "model": "EtfHoldingsDate", "examples": [ - "obb.etf.holdings_date(\"XLK\", provider=\"fmp\").results" + { + "scope": "api", + "parameters": { + "symbol": "XLK", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12901,7 +14703,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -12912,13 +14718,13 @@ "required": true, "schema": { "type": "string", - "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.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "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." } ], "responses": { @@ -12968,7 +14774,14 @@ }, "model": "EtfHoldingsPerformance", "examples": [ - "obb.etf.holdings_performance(\"XLK\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "XLK", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -12991,7 +14804,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -13002,13 +14819,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.", + "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", "multiple_items_allowed": [ "fmp" ], "title": "Symbol" }, - "description": "Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp." + "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { @@ -13058,9 +14875,23 @@ }, "model": "EtfEquityExposure", "examples": [ - "obb.etf.equity_exposure(\"MSFT\", provider=\"fmp\")", - "#### This function accepts multiple tickers. ####", - "obb.etf.equity_exposure(\"MSFT,AAPL\", provider=\"fmp\")" + { + "scope": "api", + "parameters": { + "symbol": "MSFT", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "This function accepts multiple tickers.", + "parameters": { + "symbol": "MSFT,AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -13083,7 +14914,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13199,7 +15034,21 @@ }, "model": "AMERIBOR", "examples": [ - "obb.fixedincome.rate.ameribor(parameter=\"30_day_ma\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "parameter": "30_day_ma", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13222,7 +15071,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13334,7 +15187,21 @@ }, "model": "SONIA", "examples": [ - "obb.fixedincome.rate.sonia(parameter=\"total_nominal_value\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "parameter": "total_nominal_value", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13357,7 +15224,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13448,7 +15319,13 @@ }, "model": "IORB", "examples": [ - "obb.fixedincome.rate.iorb()" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13586,7 +15463,21 @@ }, "model": "FEDFUNDS", "examples": [ - "obb.fixedincome.rate.effr(parameter=\"daily\", provider=\"fred\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "parameter": "daily", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13609,7 +15500,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13674,7 +15569,21 @@ }, "model": "PROJECTIONS", "examples": [ - "obb.fixedincome.rate.effr_forecast(long_run=True)" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "long_run": 1.0, + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13697,7 +15606,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13809,7 +15722,21 @@ }, "model": "ESTR", "examples": [ - "obb.fixedincome.rate.estr(parameter=\"number_of_active_banks\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "parameter": "number_of_active_banks", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13832,7 +15759,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -13940,7 +15871,21 @@ }, "model": "EuropeanCentralBankInterestRates", "examples": [ - "obb.fixedincome.rate.ecb(interest_rate_type=\"refinancing\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "interest_rate_type": "refinancing", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -13963,7 +15908,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -14073,7 +16022,22 @@ }, "model": "DiscountWindowPrimaryCreditRate", "examples": [ - "obb.fixedincome.rate.dpcredit(start_date=\"2023-02-01\", end_date=\"2023-05-01\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "start_date": "2023-02-01", + "end_date": "2023-05-01", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -14096,7 +16060,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -14210,7 +16178,21 @@ }, "model": "TreasuryConstantMaturity", "examples": [ - "obb.fixedincome.fixedincome.spreads.tcm(maturity=\"2y\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "maturity": "2y", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -14233,7 +16215,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -14350,7 +16336,21 @@ }, "model": "SelectedTreasuryConstantMaturity", "examples": [ - "obb.fixedincome.fixedincome.spreads.tcm_effr(maturity=\"10y\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "maturity": "10y", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -14373,7 +16373,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -14487,7 +16491,21 @@ }, "model": "SelectedTreasuryBill", "examples": [ - "obb.fixedincome.fixedincome.spreads.treasury_effr(maturity=\"6m\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "maturity": "6m", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -14510,7 +16528,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -14601,7 +16623,21 @@ }, "model": "USYieldCurve", "examples": [ - "obb.fixedincome.government.us_yield_curve(inflation_adjusted=True)" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "inflation_adjusted": 1.0, + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -14624,7 +16660,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "ecb" + ], "const": "ecb", + "type": "string", "default": "ecb", "title": "Provider" } @@ -14729,7 +16769,21 @@ }, "model": "EUYieldCurve", "examples": [ - "obb.fixedincome.government.eu_yield_curve(yield_curve_type=\"spot_rate\")" + { + "scope": "api", + "parameters": { + "provider": "ecb" + }, + "provider": "ecb" + }, + { + "scope": "api", + "parameters": { + "yield_curve_type": "spot_rate", + "provider": "ecb" + }, + "provider": "ecb" + } ] } }, @@ -14846,7 +16900,13 @@ }, "model": "TreasuryRates", "examples": [ - "obb.fixedincome.government.treasury_rates(provider=\"federal_reserve\")" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -14869,7 +16929,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15056,7 +17120,21 @@ }, "model": "ICEBofA", "examples": [ - "obb.fixedincome.corporate.ice_bofa(index_type=\"yield_to_worst\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "index_type": "yield_to_worst", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15079,7 +17157,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15208,7 +17290,21 @@ }, "model": "MoodyCorporateBondIndex", "examples": [ - "obb.fixedincome.corporate.moody(index_type=\"baa\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "index_type": "baa", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15231,7 +17327,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15319,7 +17419,21 @@ }, "model": "HighQualityMarketCorporateBond", "examples": [ - "obb.fixedincome.corporate.hqm(yield_curve=\"par\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "yield_curve": "par", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15342,7 +17456,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15390,38 +17508,41 @@ "in": "query", "required": false, "schema": { - "type": "array", - "items": { - "type": "number" - }, - "description": "The maturities in years.", - "default": [ - 10.0 + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } ], + "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", + "multiple_items_allowed": [ + "fred" + ], + "default": 10.0, "title": "Maturity" }, - "description": "The maturities in years." + "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred." }, { "name": "category", "in": "query", "required": false, "schema": { - "type": "array", - "items": { - "enum": [ - "par_yield", - "spot_rate" - ], - "type": "string" - }, - "description": "The category.", - "default": [ + "type": "string", + "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", + "choices": [ + "par_yield", "spot_rate" ], + "multiple_items_allowed": [ + "fred" + ], + "default": "spot_rate", "title": "Category" }, - "description": "The category." + "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred." } ], "responses": { @@ -15471,7 +17592,21 @@ }, "model": "SpotRate", "examples": [ - "obb.fixedincome.corporate.spot_rates(maturity=[10,20,30,50])" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "maturity": "10,20,30,50", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15494,7 +17629,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15638,7 +17777,21 @@ }, "model": "CommercialPaper", "examples": [ - "obb.fixedincome.corporate.commercial_paper(maturity=\"15d\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "maturity": "15d", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15661,7 +17814,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fred" + ], "const": "fred", + "type": "string", "default": "fred", "title": "Provider" } @@ -15771,7 +17928,21 @@ }, "model": "SOFR", "examples": [ - "obb.fixedincome.fixedincome.sofr(period=\"overnight\")" + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "period": "overnight", + "provider": "fred" + }, + "provider": "fred" + } ] } }, @@ -15809,14 +17980,15 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", "multiple_items_allowed": [ + "fmp", "intrinio", "polygon" ], "title": "Symbol" }, - "description": "Symbol to get data for. Multiple items allowed for provider(s): intrinio, polygon." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." }, { "name": "start_date", @@ -15882,60 +18054,33 @@ "schema": { "anyOf": [ { - "type": "integer", - "exclusiveMinimum": 0 + "type": "integer" }, { "type": "null" } ], - "description": "The number of data entries to return.", - "default": 10000, - "title": "Limit" + "title": "intrinio,polygon", + "description": "The number of data entries to return. (provider: intrinio, polygon)", + "default": 10000 }, - "description": "The number of data entries to return." + "description": "The number of data entries to return. (provider: intrinio, polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "enum": [ - "asc", - "desc" - ], - "type": "string" - }, - { - "type": "null" - } + "enum": [ + "asc", + "desc" ], - "description": "Sort the data in ascending or descending order.", - "default": "asc", - "title": "Sort" + "type": "string", + "title": "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)", + "default": "asc" }, - "description": "Sort the data in ascending or descending order." - }, - { - "name": "timeseries", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "title": "fmp", - "description": "Number of days to look back. (provider: fmp)" - }, - "description": "Number of days to look back. (provider: fmp)" + "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)" } ], "responses": { @@ -15985,9 +18130,23 @@ }, "model": "IndexHistorical", "examples": [ - "obb.index.price.historical(\"^GSPC\", provider=\"fmp\").to_df()", - "#### Not all providers have the same symbols. ####", - "obb.index.price.historical(\"SPX\", provider=\"intrinio\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "^GSPC", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Not all providers have the same symbols.", + "parameters": { + "symbol": "SPX", + "provider": "intrinio" + }, + "provider": "intrinio" + } ] } }, @@ -16026,10 +18185,15 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", + "multiple_items_allowed": [ + "fmp", + "intrinio", + "polygon" + ], "title": "Symbol" }, - "description": "Symbol to get data for." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." }, { "name": "start_date", @@ -16070,44 +18234,42 @@ "description": "End date of the data, in YYYY-MM-DD format." }, { - "name": "timeseries", + "name": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer", - "minimum": 0 + "type": "string" }, { "type": "null" } ], - "title": "fmp", - "description": "Number of days to look back. (provider: fmp)" + "description": "Time interval of the data to return.", + "default": "1d", + "title": "Interval" }, - "description": "Number of days to look back. (provider: fmp)" + "description": "Time interval of the data to return." }, { - "name": "interval", + "name": "limit", "in": "query", "required": false, "schema": { - "enum": [ - "1min", - "5min", - "15min", - "30min", - "1hour", - "4hour", - "1day" + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } ], - "type": "string", - "title": "fmp", - "description": "Data granularity. (provider: fmp)", - "default": "1day" + "title": "intrinio,polygon", + "description": "The number of data entries to return. (provider: intrinio, polygon)", + "default": 10000 }, - "description": "Data granularity. (provider: fmp)" + "description": "The number of data entries to return. (provider: intrinio, polygon)" }, { "name": "sort", @@ -16119,124 +18281,11 @@ "desc" ], "type": "string", - "title": "fmp,intrinio,polygon", - "description": "Sort the data in ascending or descending order. (provider: fmp);\n Sort order. (provider: intrinio);\n Sort order of the data. (provider: polygon)", - "default": "desc" - }, - "description": "Sort the data in ascending or descending order. (provider: fmp);\n Sort order. (provider: intrinio);\n Sort order of the data. (provider: polygon)" - }, - { - "name": "tag", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Index tag. (provider: intrinio)", - "default": "level" - }, - "description": "Index tag. (provider: intrinio)" - }, - { - "name": "type", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Index type. (provider: intrinio)" - }, - "description": "Index type. (provider: intrinio)" - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "title": "intrinio,polygon", - "description": "The number of data entries to return. (provider: intrinio, polygon)", - "default": 1000 - }, - "description": "The number of data entries to return. (provider: intrinio, polygon)" - }, - { - "name": "sleep", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", - "default": 1.0 - }, - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)" - }, - { - "name": "timespan", - "in": "query", - "required": false, - "schema": { - "enum": [ - "minute", - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "type": "string", "title": "polygon", - "description": "Timespan of the data. (provider: polygon)", - "default": "day" + "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)", + "default": "asc" }, - "description": "Timespan of the data. (provider: polygon)" - }, - { - "name": "adjusted", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "title": "polygon", - "description": "Whether the data is adjusted. (provider: polygon)", - "default": true - }, - "description": "Whether the data is adjusted. (provider: polygon)" - }, - { - "name": "multiplier", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "title": "polygon", - "description": "Multiplier of the timespan. (provider: polygon)", - "default": 1 - }, - "description": "Multiplier of the timespan. (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)" } ], "responses": { @@ -16286,7 +18335,14 @@ }, "model": "MarketIndices", "examples": [ - "obb.index.market(symbol=\"SPX\")" + { + "scope": "api", + "parameters": { + "symbol": "^IBEX", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -16309,7 +18365,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -16373,9 +18433,14 @@ }, "model": "IndexConstituents", "examples": [ - "obb.index.constituents(\"dowjones\", provider=\"fmp\").to_df()", - "#### Providers other than FMP will use the ticker symbol. ####", - "obb.index.constituents(\"BEP50P\", provider=\"cboe\").to_df()" + { + "scope": "api", + "parameters": { + "symbol": "dowjones", + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -16398,7 +18463,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "fmp" + ], "const": "fmp", + "type": "string", "default": "fmp", "title": "Provider" } @@ -16451,7 +18520,13 @@ }, "model": "AvailableIndices", "examples": [ - "obb.index.available(provider=\"yfinance\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + } ] } }, @@ -16477,8 +18552,7 @@ "enum": [ "benzinga", "fmp", - "intrinio", - "tiingo" + "intrinio" ], "type": "string", "title": "Provider" @@ -16746,43 +18820,6 @@ "description": "Content types of the news to retrieve. (provider: benzinga)" }, "description": "Content types of the news to retrieve. (provider: benzinga)" - }, - { - "name": "offset", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "tiingo", - "description": "Page offset, used in conjunction with limit. (provider: tiingo)", - "default": 0 - }, - "description": "Page offset, used in conjunction with limit. (provider: tiingo)" - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "tiingo", - "description": "A comma-separated list of the domains requested. (provider: tiingo)" - }, - "description": "A comma-separated list of the domains requested. (provider: tiingo)" } ], "responses": { @@ -16832,17 +18869,49 @@ }, "model": "WorldNews", "examples": [ - "obb.news.world(limit=2500)", - "# Get news on the specified dates.", - "obb.news.world(start_date='2024-02-01', end_date='2024-02-07')", - "# Display the headlines of the news.", - "obb.news.world(display='headline', provider='benzinga')", - "# Get news by topics.", - "obb.news.world(topics='finance', provider='benzinga')", - "# Get news by source using 'tingo' as provider.", - "obb.news.world(provider='tiingo', source='bloomberg')", - "# Filter aticles by term using 'biztoc' as provider.", - "obb.news.world(provider='biztoc', term='apple')" + { + "scope": "api", + "parameters": { + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "limit": 100, + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Get news on the specified dates.", + "parameters": { + "start_date": "2024-02-01", + "end_date": "2024-02-07", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Display the headlines of the news.", + "parameters": { + "display": "headline", + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "description": "Get news by topics.", + "parameters": { + "topics": "finance", + "provider": "benzinga" + }, + "provider": "benzinga" + } ] } }, @@ -16869,8 +18938,7 @@ "benzinga", "fmp", "intrinio", - "polygon", - "tiingo" + "polygon" ], "type": "string", "title": "Provider" @@ -16889,17 +18957,16 @@ "type": "null" } ], - "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo.", + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon.", "multiple_items_allowed": [ "benzinga", "fmp", "intrinio", - "polygon", - "tiingo" + "polygon" ], "title": "Symbol" }, - "description": "Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon." }, { "name": "start_date", @@ -17197,43 +19264,6 @@ "default": 0 }, "description": "Page number of the results. Use in combination with limit. (provider: fmp)" - }, - { - "name": "offset", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "tiingo", - "description": "Page offset, used in conjunction with limit. (provider: tiingo)", - "default": 0 - }, - "description": "Page offset, used in conjunction with limit. (provider: tiingo)" - }, - { - "name": "source", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "tiingo", - "description": "A comma-separated list of the domains requested. (provider: tiingo)" - }, - "description": "A comma-separated list of the domains requested. (provider: tiingo)" } ], "responses": { @@ -17283,15 +19313,61 @@ }, "model": "CompanyNews", "examples": [ - "obb.news.company(limit=2500)", - "# Get news on the specified dates.", - "obb.news.company(symbol='AAPL', start_date='2024-02-01', end_date='2024-02-07')", - "# Display the headlines of the news.", - "obb.news.company(symbol='AAPL', display='headline', provider='benzinga')", - "# Get news for multiple symbols.", - "obb.news.company(symbol='aapl,tsla')", - "# Get news company's ISIN.", - "obb.news.company(symbol='NVDA', isin='US0378331005')" + { + "scope": "api", + "parameters": { + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "parameters": { + "limit": 100, + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "description": "Get news on the specified dates.", + "parameters": { + "symbol": "AAPL", + "start_date": "2024-02-01", + "end_date": "2024-02-07", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Display the headlines of the news.", + "parameters": { + "symbol": "AAPL", + "display": "headline", + "provider": "benzinga" + }, + "provider": "benzinga" + }, + { + "scope": "api", + "description": "Get news for multiple symbols.", + "parameters": { + "symbol": "aapl,tsla", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "Get news company's ISIN.", + "parameters": { + "symbol": "NVDA", + "isin": "US0378331005", + "provider": "benzinga" + }, + "provider": "benzinga" + } ] } }, @@ -17314,7 +19390,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17378,8 +19458,14 @@ }, "model": "CikMap", "examples": [ - "obb.regulators.sec.cik_map(symbol=\"MSFT\").results.cik", - " 0000789019" + { + "scope": "api", + "parameters": { + "symbol": "MSFT", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -17402,7 +19488,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17486,7 +19576,21 @@ }, "model": "InstitutionsSearch", "examples": [ - "obb.regulators.sec.institutions_search(query=\"blackstone real estate\").to_df()" + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "query": "blackstone real estate", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -17509,7 +19613,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17611,23 +19719,36 @@ }, "model": "SchemaFiles", "examples": [ - "data = obb.regulators.sec.schema_files()", - "data.files[0]", - " https://xbrl.fasb.org/us-gaap/", - "#### The directory structure can be navigated by constructing a URL from the 'results' list. ####", - "url = data.files[0]+data.files[-1]", - "#### The URL base will always be the 0 position in the list, feed the URL back in as a parameter. ####", - "obb.regulators.sec.schema_files(url=url).results.files", - " ['https://xbrl.fasb.org/us-gaap/2024/'", - " 'USGAAP2024FileList.xml'", - " 'dis/'", - " 'dqcrules/'", - " 'ebp/'", - " 'elts/'", - " 'entire/'", - " 'meta/'", - " 'stm/'", - " 'us-gaap-2024.zip']" + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "python", + "description": "Get a list of schema files.", + "code": [ + "data = obb.regulators.sec.schema_files().results", + "data.files[0]", + "'https://xbrl.fasb.org/us-gaap/'", + "# The directory structure can be navigated by constructing a URL from the 'results' list.", + "url = data.files[0]+data.files[-1]", + "# The URL base will always be the 0 position in the list, feed the URL back in as a parameter.", + "obb.regulators.sec.schema_files(url=url).results.files", + "['https://xbrl.fasb.org/us-gaap/2024/'", + "'USGAAP2024FileList.xml'", + "'dis/'", + "'dqcrules/'", + "'ebp/'", + "'elts/'", + "'entire/'", + "'meta/'", + "'stm/'", + "'us-gaap-2024.zip']" + ] + } ] } }, @@ -17650,7 +19771,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17658,11 +19783,10 @@ { "name": "query", "in": "query", - "required": false, + "required": true, "schema": { "type": "string", "description": "Search query.", - "default": "", "title": "Query" }, "description": "Search query." @@ -17734,8 +19858,14 @@ }, "model": "SymbolMap", "examples": [ - "obb.regulators.sec.symbol_map(\"0000789019\").results.symbol", - " MSFT" + { + "scope": "api", + "parameters": { + "query": "0000789019", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -17758,7 +19888,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17811,7 +19945,13 @@ }, "model": "RssLitigation", "examples": [ - "obb.regulators.sec.rss_litigation().to_dict(\"records\")[0]" + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -17834,7 +19974,11 @@ "in": "query", "required": false, "schema": { + "enum": [ + "sec" + ], "const": "sec", + "type": "string", "default": "sec", "title": "Provider" } @@ -17918,7 +20062,21 @@ }, "model": "SicSearch", "examples": [ - "obb.regulators.sec.sic_search(\"real estate investment trusts\").results" + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "query": "real estate investment trusts", + "provider": "sec" + }, + "provider": "sec" + } ] } }, @@ -17945,6 +20103,7 @@ } ], "description": "Get information on a symbol, or a comma separated list of symbols.", + "default": "", "title": "Q" }, "description": "Get information on a symbol, or a comma separated list of symbols." @@ -17956,23 +20115,16 @@ "schema": { "anyOf": [ { - "enum": [ - "stock", - "etf", - "index", - "indices", - "all", - null - ] + "type": "string" }, { "type": "null" } ], - "description": "Filter by type.", + "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list.", "title": "Type" }, - "description": "Filter by type." + "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list." }, { "name": "ignore_type", @@ -17981,13 +20133,7 @@ "schema": { "anyOf": [ { - "enum": [ - "stock", - "etf", - "index", - "indices", - null - ] + "type": "string" }, { "type": "null" @@ -18023,6 +20169,32 @@ } } }, + "/search/currencies": { + "get": { + "tags": [ + "search" + ], + "summary": "Currencies", + "description": "Get supported tickers from the OpenBB SDK API.", + "operationId": "unique_currencies", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Response Unique Currencies" + } + } + } + } + } + } + }, "/search/fred": { "get": { "tags": [ @@ -18216,7 +20388,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/UDFSymbolSearch" + "$ref": "#/components/schemas/UDFSearchResult" }, "title": "Response Query Udf Search" } @@ -18235,28 +20407,6 @@ } } } - }, - "/": { - "get": { - "summary": "Root", - "operationId": "root__get", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "additionalProperties": { - "type": "string" - }, - "type": "object", - "title": "Response Root Get" - } - } - } - } - } - } } }, "components": { @@ -18364,8 +20514,8 @@ ], "title": "Overall Success Rate", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "overall_avg_return_percentile": { "anyOf": [ @@ -18378,8 +20528,8 @@ ], "title": "Overall Avg Return Percentile", "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "total_ratings_percentile": { "anyOf": [ @@ -18392,8 +20542,8 @@ ], "title": "Total Ratings Percentile", "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "total_ratings": { "anyOf": [ @@ -18442,8 +20592,8 @@ ], "title": "Overall Average Return", "description": "The average percent (normalized) price difference per rating since the date of recommendation", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "overall_std_dev": { "anyOf": [ @@ -18456,8 +20606,8 @@ ], "title": "Overall Std Dev", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_1m": { "anyOf": [ @@ -18494,8 +20644,8 @@ ], "title": "Average Return 1M", "description": "The average percent (normalized) price difference per rating over the last month", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_1m": { "anyOf": [ @@ -18508,8 +20658,8 @@ ], "title": "Std Dev 1M", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_3m": { "anyOf": [ @@ -18546,8 +20696,8 @@ ], "title": "Average Return 3M", "description": "The average percent (normalized) price difference per rating over the last 3 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_3m": { "anyOf": [ @@ -18560,8 +20710,8 @@ ], "title": "Std Dev 3M", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_6m": { "anyOf": [ @@ -18598,8 +20748,8 @@ ], "title": "Average Return 6M", "description": "The average percent (normalized) price difference per rating over the last 6 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_6m": { "anyOf": [ @@ -18612,8 +20762,8 @@ ], "title": "Std Dev 6M", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_9m": { "anyOf": [ @@ -18650,8 +20800,8 @@ ], "title": "Average Return 9M", "description": "The average percent (normalized) price difference per rating over the last 9 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_9m": { "anyOf": [ @@ -18664,8 +20814,8 @@ ], "title": "Std Dev 9M", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_1y": { "anyOf": [ @@ -18702,8 +20852,8 @@ ], "title": "Average Return 1Y", "description": "The average percent (normalized) price difference per rating over the last 1 year", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_1y": { "anyOf": [ @@ -18716,8 +20866,8 @@ ], "title": "Std Dev 1Y", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_2y": { "anyOf": [ @@ -18754,8 +20904,8 @@ ], "title": "Average Return 2Y", "description": "The average percent (normalized) price difference per rating over the last 2 years", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_2y": { "anyOf": [ @@ -18768,8 +20918,8 @@ ], "title": "Std Dev 2Y", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "gain_count_3y": { "anyOf": [ @@ -18806,8 +20956,8 @@ ], "title": "Average Return 3Y", "description": "The average percent (normalized) price difference per rating over the last 3 years", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "std_dev_3y": { "anyOf": [ @@ -18820,8 +20970,8 @@ ], "title": "Std Dev 3Y", "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -19337,7 +21487,7 @@ } ], "title": "Images", - "description": "Images associated with the news." + "description": "Images associated with the article." }, "text": { "anyOf": [ @@ -19495,6 +21645,9 @@ }, "ChartFormat": { "type": "string", + "enum": [ + "plotly" + ], "const": "plotly", "title": "ChartFormat" }, @@ -21210,8 +23363,8 @@ ], "title": "Rate", "description": "Yield curve rate, as a normalized percent.", - "frontend_multiply": 100, - "unit_measurement": "percent." + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -21233,102 +23386,242 @@ "description": "The date of the data." }, "estimated_revenue_low": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Revenue Low", "description": "Estimated revenue low." }, "estimated_revenue_high": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Revenue High", "description": "Estimated revenue high." }, "estimated_revenue_avg": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Revenue Avg", "description": "Estimated revenue average." }, - "estimated_ebitda_low": { - "type": "integer", - "title": "Estimated Ebitda Low", - "description": "Estimated EBITDA low." - }, - "estimated_ebitda_high": { - "type": "integer", - "title": "Estimated Ebitda High", - "description": "Estimated EBITDA high." - }, - "estimated_ebitda_avg": { - "type": "integer", - "title": "Estimated Ebitda Avg", - "description": "Estimated EBITDA average." - }, - "estimated_ebit_low": { - "type": "integer", - "title": "Estimated Ebit Low", - "description": "Estimated EBIT low." - }, - "estimated_ebit_high": { - "type": "integer", - "title": "Estimated Ebit High", - "description": "Estimated EBIT high." - }, - "estimated_ebit_avg": { - "type": "integer", - "title": "Estimated Ebit Avg", - "description": "Estimated EBIT average." - }, - "estimated_net_income_low": { - "type": "integer", - "title": "Estimated Net Income Low", - "description": "Estimated net income low." - }, - "estimated_net_income_high": { - "type": "integer", - "title": "Estimated Net Income High", - "description": "Estimated net income high." - }, - "estimated_net_income_avg": { - "type": "integer", - "title": "Estimated Net Income Avg", - "description": "Estimated net income average." - }, "estimated_sga_expense_low": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Sga Expense Low", "description": "Estimated SGA expense low." }, "estimated_sga_expense_high": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Sga Expense High", "description": "Estimated SGA expense high." }, "estimated_sga_expense_avg": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Estimated Sga Expense Avg", "description": "Estimated SGA expense average." }, + "estimated_ebitda_low": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebitda Low", + "description": "Estimated EBITDA low." + }, + "estimated_ebitda_high": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebitda High", + "description": "Estimated EBITDA high." + }, + "estimated_ebitda_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebitda Avg", + "description": "Estimated EBITDA average." + }, + "estimated_ebit_low": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebit Low", + "description": "Estimated EBIT low." + }, + "estimated_ebit_high": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebit High", + "description": "Estimated EBIT high." + }, + "estimated_ebit_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Ebit Avg", + "description": "Estimated EBIT average." + }, + "estimated_net_income_low": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Net Income Low", + "description": "Estimated net income low." + }, + "estimated_net_income_high": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Net Income High", + "description": "Estimated net income high." + }, + "estimated_net_income_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Net Income Avg", + "description": "Estimated net income average." + }, "estimated_eps_avg": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Estimated Eps Avg", "description": "Estimated EPS average." }, "estimated_eps_high": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Estimated Eps High", "description": "Estimated EPS high." }, "estimated_eps_low": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Estimated Eps Low", "description": "Estimated EPS low." }, "number_analyst_estimated_revenue": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Number Analyst Estimated Revenue", "description": "Number of analysts who estimated revenue." }, "number_analysts_estimated_eps": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Number Analysts Estimated Eps", "description": "Number of analysts who estimated EPS." } @@ -21337,27 +23630,7 @@ "type": "object", "required": [ "symbol", - "date", - "estimated_revenue_low", - "estimated_revenue_high", - "estimated_revenue_avg", - "estimated_ebitda_low", - "estimated_ebitda_high", - "estimated_ebitda_avg", - "estimated_ebit_low", - "estimated_ebit_high", - "estimated_ebit_avg", - "estimated_net_income_low", - "estimated_net_income_high", - "estimated_net_income_avg", - "estimated_sga_expense_low", - "estimated_sga_expense_high", - "estimated_sga_expense_avg", - "estimated_eps_avg", - "estimated_eps_high", - "estimated_eps_low", - "number_analyst_estimated_revenue", - "number_analysts_estimated_eps" + "date" ], "title": "FMPAnalystEstimates", "description": "FMP Analyst Estimates Data." @@ -23031,8 +25304,7 @@ "type": "null" } ], - "title": "Free Cash Flow", - "description": "Free cash flow." + "title": "Free Cash Flow" }, "link": { "anyOf": [ @@ -23920,18 +26192,6 @@ "title": "Adj Close", "description": "The adjusted close price." }, - "unadjusted_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Unadjusted Volume", - "description": "Unadjusted volume of the symbol." - }, "change": { "anyOf": [ { @@ -23942,7 +26202,7 @@ } ], "title": "Change", - "description": "Change in the price of the symbol from the previous day." + "description": "Change in the price from the previous close." }, "change_percent": { "anyOf": [ @@ -23954,31 +26214,9 @@ } ], "title": "Change Percent", - "description": "Change % in the price of the symbol." - }, - "label": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Label", - "description": "Human readable format of the date." - }, - "change_over_time": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Over Time", - "description": "Change % in the price of the symbol over a period of time." + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -24113,7 +26351,8 @@ "vwap": { "anyOf": [ { - "type": "number" + "type": "number", + "exclusiveMinimum": 0.0 }, { "type": "null" @@ -24134,18 +26373,6 @@ "title": "Adj Close", "description": "The adjusted close price." }, - "unadjusted_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Unadjusted Volume", - "description": "Unadjusted volume of the symbol." - }, "change": { "anyOf": [ { @@ -24156,7 +26383,7 @@ } ], "title": "Change", - "description": "Change in the price of the symbol from the previous day." + "description": "Change in the price from the previous close." }, "change_percent": { "anyOf": [ @@ -24168,31 +26395,9 @@ } ], "title": "Change Percent", - "description": "Change % in the price of the symbol." - }, - "label": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Label", - "description": "Human readable format of the date." - }, - "change_over_time": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Over Time", - "description": "Change % in the price of the symbol over a period of time." + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -24259,6 +26464,193 @@ "title": "FMPCurrencyPairs", "description": "FMP Currency Available Pairs Data." }, + "FMPCurrencySnapshots": { + "properties": { + "base_currency": { + "type": "string", + "title": "Base Currency", + "description": "The base, or domestic, currency." + }, + "counter_currency": { + "type": "string", + "title": "Counter Currency", + "description": "The counter, or foreign, currency." + }, + "last_rate": { + "type": "number", + "title": "Last Rate", + "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'." + }, + "open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Open", + "description": "The open price." + }, + "high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "High", + "description": "The high price." + }, + "low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Low", + "description": "The low price." + }, + "close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Close", + "description": "The close price." + }, + "volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume", + "description": "The trading volume." + }, + "prev_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Close", + "description": "The previous close price." + }, + "change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change", + "description": "The change in the price from the previous close." + }, + "change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change Percent", + "description": "The change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ma_50": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ma 50", + "description": "The 50-day moving average." + }, + "ma_200": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ma 200", + "description": "The 200-day moving average." + }, + "year_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year High", + "description": "The 52-week high." + }, + "year_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Low", + "description": "The 52-week low." + }, + "last_rate_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Rate Timestamp", + "description": "The timestamp of the last rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "base_currency", + "counter_currency", + "last_rate" + ], + "title": "FMPCurrencySnapshots", + "description": "FMP Currency Snapshots Data." + }, "FMPDiscoveryFilings": { "properties": { "symbol": { @@ -24668,19 +27060,7 @@ } ], "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "label": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Label", - "description": "Human readable format of the date." + "description": "Symbol of the equity." }, "adj_close": { "anyOf": [ @@ -24716,7 +27096,7 @@ } ], "title": "Change", - "description": "Change in the price of the symbol from the previous day." + "description": "Change in the price from the previous close." }, "change_percent": { "anyOf": [ @@ -24728,19 +27108,9 @@ } ], "title": "Change Percent", - "description": "Change % in the price of the symbol." - }, - "change_over_time": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Over Time", - "description": "Change % in the price of the symbol over a period of time." + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -26011,7 +28381,7 @@ } ], "title": "Prev Close", - "description": "The closing price of the previous trading day." + "description": "The previous close price." }, "change": { "anyOf": [ @@ -26152,9 +28522,6 @@ "type": "string", "format": "date-time" }, - { - "type": "string" - }, { "type": "null" } @@ -27112,7 +29479,7 @@ "shares": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" @@ -27133,7 +29500,7 @@ "title": "Weight", "description": "The weight of the equity in the ETF, as a normalized percent.", "x-frontend_multiply": 100, - "x-units_measurement": "percent" + "x-unit_measurement": "percent" }, "market_value": { "anyOf": [ @@ -27473,6 +29840,11 @@ }, "FMPEtfHoldingsPerformance": { "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "The ticker symbol." + }, "one_day": { "anyOf": [ { @@ -27613,6 +29985,20 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, + "two_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Two Year", + "description": "Two-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, "three_year": { "anyOf": [ { @@ -27627,6 +30013,20 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, + "four_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Four Year", + "description": "Four-year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, "five_year": { "anyOf": [ { @@ -27668,11 +30068,6 @@ "description": "Return from the beginning of the time series.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "The ticker symbol." } }, "additionalProperties": true, @@ -28095,85 +30490,175 @@ "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." }, + "company_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Company Name", + "description": "The name of the company." + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry", + "description": "The industry of the company." + }, + "year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Year", + "description": "Year of the compensation." + }, + "name_and_position": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name And Position", + "description": "Name and position." + }, + "salary": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "Salary", + "description": "Salary." + }, + "bonus": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "Bonus", + "description": "Bonus payments." + }, + "stock_award": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "Stock Award", + "description": "Stock awards." + }, + "incentive_plan_compensation": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "Incentive Plan Compensation", + "description": "Incentive plan compensation." + }, + "all_other_compensation": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "All Other Compensation", + "description": "All other compensation." + }, + "total": { + "anyOf": [ + { + "type": "number", + "minimum": 0.0 + }, + { + "type": "null" + } + ], + "title": "Total", + "description": "Total compensation." + }, "filing_date": { - "type": "string", - "format": "date", + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], "title": "Filing Date", "description": "Date of the filing." }, "accepted_date": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Accepted Date", "description": "Date the filing was accepted." }, - "name_and_position": { - "type": "string", - "title": "Name And Position", - "description": "Name and position of the executive." - }, - "year": { - "type": "integer", - "title": "Year", - "description": "Year of the compensation." - }, - "salary": { - "type": "number", - "minimum": 0.0, - "title": "Salary", - "description": "Salary of the executive." - }, - "bonus": { - "type": "number", - "minimum": 0.0, - "title": "Bonus", - "description": "Bonus of the executive." - }, - "stock_award": { - "type": "number", - "minimum": 0.0, - "title": "Stock Award", - "description": "Stock award of the executive." - }, - "incentive_plan_compensation": { - "type": "number", - "minimum": 0.0, - "title": "Incentive Plan Compensation", - "description": "Incentive plan compensation of the executive." - }, - "all_other_compensation": { - "type": "number", - "minimum": 0.0, - "title": "All Other Compensation", - "description": "All other compensation of the executive." - }, - "total": { - "type": "number", - "minimum": 0.0, - "title": "Total", - "description": "Total compensation of the executive." - }, "url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Url", - "description": "URL of the filing data." + "description": "URL to the filing data." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "filing_date", - "accepted_date", - "name_and_position", - "year", - "salary", - "bonus", - "stock_award", - "incentive_plan_compensation", - "all_other_compensation", - "total", - "url" + "symbol" ], "title": "FMPExecutiveCompensation", "description": "FMP Executive Compensation Data." @@ -29165,29 +31650,47 @@ "title": "Date", "description": "The date of the data." }, - "label": { - "type": "string", - "title": "Label", - "description": "Label of the historical stock splits." - }, "numerator": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Numerator", - "description": "Numerator of the historical stock splits." + "description": "Numerator of the split." }, "denominator": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Denominator", - "description": "Denominator of the historical stock splits." + "description": "Denominator of the split." + }, + "split_ratio": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Split Ratio", + "description": "Split ratio." } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "label", - "numerator", - "denominator" + "date" ], "title": "FMPHistoricalSplits", "description": "FMP Historical Splits Data." @@ -29224,18 +31727,6 @@ "title": "Fiscal Year", "description": "The fiscal year of the fiscal period." }, - "symbol": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, "filing_date": { "anyOf": [ { @@ -30012,7 +32503,7 @@ "title": "Volume", "description": "The trading volume." }, - "adj_close": { + "vwap": { "anyOf": [ { "type": "number" @@ -30021,20 +32512,8 @@ "type": "null" } ], - "title": "Adj Close", - "description": "The adjusted close price." - }, - "unadjusted_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Unadjusted Volume", - "description": "Unadjusted volume of the symbol." + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, "change": { "anyOf": [ @@ -30046,7 +32525,7 @@ } ], "title": "Change", - "description": "Change in the price of the symbol from the previous day." + "description": "Change in the price from the previous close." }, "change_percent": { "anyOf": [ @@ -30058,31 +32537,9 @@ } ], "title": "Change Percent", - "description": "Change % in the price of the symbol." - }, - "label": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Label", - "description": "Human readable format of the date." - }, - "change_over_time": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Over Time", - "description": "Change % in the price of the symbol over a period of time." + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -31334,155 +33791,6 @@ "title": "FMPKeyMetrics", "description": "FMP Key Metrics Data." }, - "FMPMarketIndices": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data." - }, - "open": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Open", - "description": "The open price." - }, - "high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "High", - "description": "The high price." - }, - "low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Low", - "description": "The low price." - }, - "close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Close", - "description": "The close price." - }, - "volume": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." - }, - "adj_close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Close", - "description": "The adjusted close price." - }, - "unadjusted_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Unadjusted Volume", - "description": "Unadjusted volume of the symbol." - }, - "change": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change", - "description": "Change in the price of the symbol from the previous day." - }, - "change_percent": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Percent", - "description": "Change % in the price of the symbol." - }, - "label": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Label", - "description": "Human readable format of the date." - }, - "change_over_time": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Over Time", - "description": "Change % in the price of the symbol over a period of time." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FMPMarketIndices", - "description": "FMP Market Indices Data." - }, "FMPMarketSnapshots": { "properties": { "symbol": { @@ -31538,6 +33846,18 @@ "title": "Close", "description": "The close price." }, + "volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume", + "description": "The trading volume." + }, "prev_close": { "anyOf": [ { @@ -31560,7 +33880,7 @@ } ], "title": "Change", - "description": "The change in price." + "description": "The change in price from the previous close." }, "change_percent": { "anyOf": [ @@ -31572,21 +33892,11 @@ } ], "title": "Change Percent", - "description": "The change, as a percent." + "description": "The change in price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "volume": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." - }, - "price": { + "last_price": { "anyOf": [ { "type": "number" @@ -31595,20 +33905,25 @@ "type": "null" } ], - "title": "Price", + "title": "Last Price", "description": "The last price of the stock." }, - "avg_volume": { + "last_price_timestamp": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date" + }, + { + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Avg Volume", - "description": "Average volume of the stock." + "title": "Last Price Timestamp", + "description": "The timestamp of the last price." }, "ma50": { "anyOf": [ @@ -31658,10 +33973,22 @@ "title": "Year Low", "description": "The 52-week low." }, + "volume_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume Avg", + "description": "Average daily trading volume." + }, "market_cap": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" @@ -31670,18 +33997,6 @@ "title": "Market Cap", "description": "Market cap of the stock." }, - "shares_outstanding": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Shares Outstanding", - "description": "Number of shares outstanding." - }, "eps": { "anyOf": [ { @@ -31706,6 +34021,30 @@ "title": "Pe", "description": "Price to earnings ratio." }, + "shares_outstanding": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Shares Outstanding", + "description": "Number of shares outstanding." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "The company name associated with the symbol." + }, "exchange": { "anyOf": [ { @@ -31718,44 +34057,22 @@ "title": "Exchange", "description": "The exchange of the stock." }, - "timestamp": { + "earnings_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Timestamp", - "description": "The timestamp of the data." - }, - "earnings_announcement": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Earnings Announcement", - "description": "The earnings announcement of the stock." - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name", - "description": "The name associated with the stock symbol." + "title": "Earnings Date", + "description": "The upcoming earnings announcement date." } }, "additionalProperties": true, @@ -31768,6 +34085,11 @@ }, "FMPPricePerformance": { "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "The ticker symbol." + }, "one_day": { "anyOf": [ { @@ -31908,6 +34230,20 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, + "two_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Two Year", + "description": "Two-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, "three_year": { "anyOf": [ { @@ -31922,6 +34258,20 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, + "four_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Four Year", + "description": "Four-year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, "five_year": { "anyOf": [ { @@ -31963,11 +34313,6 @@ "description": "Return from the beginning of the time series.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "The ticker symbol." } }, "additionalProperties": true, @@ -32582,6 +34927,83 @@ ], "title": "Exchange" }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry" + }, + "sector": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sector" + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country" + }, + "cik": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cik" + }, + "isin": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isin" + }, + "cusip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cusip" + }, "type": { "anyOf": [ { @@ -32646,8 +35068,8 @@ ], "title": "Week 4", "description": "4 week Treasury bills rate (secondary market).", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_1": { "anyOf": [ @@ -32660,8 +35082,8 @@ ], "title": "Month 1", "description": "1 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_2": { "anyOf": [ @@ -32674,8 +35096,8 @@ ], "title": "Month 2", "description": "2 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_3": { "anyOf": [ @@ -32688,8 +35110,8 @@ ], "title": "Month 3", "description": "3 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_6": { "anyOf": [ @@ -32702,8 +35124,8 @@ ], "title": "Month 6", "description": "6 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_1": { "anyOf": [ @@ -32716,8 +35138,8 @@ ], "title": "Year 1", "description": "1 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_2": { "anyOf": [ @@ -32730,8 +35152,8 @@ ], "title": "Year 2", "description": "2 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_3": { "anyOf": [ @@ -32744,8 +35166,8 @@ ], "title": "Year 3", "description": "3 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_5": { "anyOf": [ @@ -32758,8 +35180,8 @@ ], "title": "Year 5", "description": "5 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_7": { "anyOf": [ @@ -32772,8 +35194,8 @@ ], "title": "Year 7", "description": "7 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_10": { "anyOf": [ @@ -32786,8 +35208,8 @@ ], "title": "Year 10", "description": "10 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_20": { "anyOf": [ @@ -32800,8 +35222,8 @@ ], "title": "Year 20", "description": "20 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_30": { "anyOf": [ @@ -32814,8 +35236,8 @@ ], "title": "Year 30", "description": "30 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -32855,7 +35277,7 @@ } ], "title": "Images", - "description": "Images associated with the news." + "description": "Images associated with the article." }, "text": { "anyOf": [ @@ -33684,8 +36106,8 @@ ], "title": "Week 4", "description": "4 week Treasury bills rate (secondary market).", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_1": { "anyOf": [ @@ -33698,8 +36120,8 @@ ], "title": "Month 1", "description": "1 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_2": { "anyOf": [ @@ -33712,8 +36134,8 @@ ], "title": "Month 2", "description": "2 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_3": { "anyOf": [ @@ -33726,8 +36148,8 @@ ], "title": "Month 3", "description": "3 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "month_6": { "anyOf": [ @@ -33740,8 +36162,8 @@ ], "title": "Month 6", "description": "6 month Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_1": { "anyOf": [ @@ -33754,8 +36176,8 @@ ], "title": "Year 1", "description": "1 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_2": { "anyOf": [ @@ -33768,8 +36190,8 @@ ], "title": "Year 2", "description": "2 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_3": { "anyOf": [ @@ -33782,8 +36204,8 @@ ], "title": "Year 3", "description": "3 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_5": { "anyOf": [ @@ -33796,8 +36218,8 @@ ], "title": "Year 5", "description": "5 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_7": { "anyOf": [ @@ -33810,8 +36232,8 @@ ], "title": "Year 7", "description": "7 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_10": { "anyOf": [ @@ -33824,8 +36246,8 @@ ], "title": "Year 10", "description": "10 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_20": { "anyOf": [ @@ -33838,8 +36260,8 @@ ], "title": "Year 20", "description": "20 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "year_30": { "anyOf": [ @@ -33852,8 +36274,8 @@ ], "title": "Year 30", "description": "30 year Treasury rate.", - "frontend_multiply": 100, - "unit_measurement": "percent" + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, @@ -35488,7 +37910,7 @@ } ], "title": "Status", - "description": "\n The status of the IPO. Upcoming IPOs have not taken place yet but are expected to.\n Priced IPOs have taken place.\n Withdrawn IPOs were expected to take place, but were subsequently withdrawn and did not take place\n " + "description": "The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn." }, "exchange": { "anyOf": [ @@ -35500,7 +37922,7 @@ } ], "title": "Exchange", - "description": "\n The acronym of the stock exchange that the company is going to trade publicly on.\n Typically NYSE or NASDAQ.\n " + "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ." }, "offer_amount": { "anyOf": [ @@ -35536,7 +37958,7 @@ } ], "title": "Share Price Lowest", - "description": "\n The expected lowest price per share at which the IPO will be offered.\n Before an IPO is priced, companies typically provide a range of prices per share at which\n they expect to offer the IPO (typically available for upcoming IPOs).\n " + "description": "The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs)." }, "share_price_highest": { "anyOf": [ @@ -35548,7 +37970,7 @@ } ], "title": "Share Price Highest", - "description": "\n The expected highest price per share at which the IPO will be offered.\n Before an IPO is priced, companies typically provide a range of prices per share at which\n they expect to offer the IPO (typically available for upcoming IPOs).\n " + "description": "The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs)." }, "share_count": { "anyOf": [ @@ -35572,7 +37994,7 @@ } ], "title": "Share Count Lowest", - "description": "\n The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced,\n companies typically provide a range of shares that they expect to offer in the IPO\n (typically available for upcoming IPOs).\n " + "description": "The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs)." }, "share_count_highest": { "anyOf": [ @@ -35584,7 +38006,7 @@ } ], "title": "Share Count Highest", - "description": "\n The expected highest number of shares that will be offered in the IPO. Before an IPO is priced,\n companies typically provide a range of shares that they expect to offer in the IPO\n (typically available for upcoming IPOs).\n " + "description": "The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs)." }, "announcement_url": { "anyOf": [ @@ -35608,7 +38030,7 @@ } ], "title": "Sec Report Url", - "description": "\n The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing,\n which is required to be filed before an IPO takes place.\n " + "description": "The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place." }, "open_price": { "anyOf": [ @@ -35656,7 +38078,7 @@ } ], "title": "Day Change", - "description": "\n The percentage change between the open price and the close price on the first trading day\n (only available for priced IPOs).\n " + "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs)." }, "week_change": { "anyOf": [ @@ -35668,7 +38090,7 @@ } ], "title": "Week Change", - "description": "\n The percentage change between the open price on the first trading day and the close price approximately\n a week after the first trading day (only available for priced IPOs).\n " + "description": "The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs)." }, "month_change": { "anyOf": [ @@ -35680,7 +38102,7 @@ } ], "title": "Month Change", - "description": "\n The percentage change between the open price on the first trading day and the close price approximately\n a month after the first trading day (only available for priced IPOs).\n " + "description": "The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs)." }, "id": { "anyOf": [ @@ -35766,6 +38188,30 @@ "title": "Reported Currency", "description": "The currency in which the balance sheet is reported." }, + "net_income_continuing_operations": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Income Continuing Operations", + "description": "Net Income (Continuing Operations)" + }, + "net_income_discontinued_operations": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Income Discontinued Operations", + "description": "Net Income (Discontinued Operations)" + }, "net_income": { "anyOf": [ { @@ -35886,30 +38332,6 @@ "title": "Net Cash From Discontinued Operating Activities", "description": "Net Cash from Discontinued Operating Activities" }, - "net_income_continuing_operations": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Net Income Continuing Operations", - "description": "Net Income (Continuing Operations)" - }, - "net_income_discontinued_operations": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Net Income Discontinued Operations", - "description": "Net Income (Discontinued Operations)" - }, "net_cash_from_operating_activities": { "anyOf": [ { @@ -36675,6 +39097,164 @@ "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, + "average": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Average", + "description": "Average trade price of an individual equity during the interval." + }, + "change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change", + "description": "Change in the price of the symbol from the previous day." + }, + "change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change Percent", + "description": "Percent change in the price of the symbol from the previous day.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "adj_open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj Open", + "description": "The adjusted open price." + }, + "adj_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj High", + "description": "The adjusted high price." + }, + "adj_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj Low", + "description": "The adjusted low price." + }, + "adj_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj Close", + "description": "The adjusted close price." + }, + "adj_volume": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj Volume", + "description": "The adjusted volume." + }, + "fifty_two_week_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Fifty Two Week High", + "description": "52 week high price for the symbol." + }, + "fifty_two_week_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Fifty Two Week Low", + "description": "52 week low price for the symbol." + }, + "factor": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Factor", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices." + }, + "split_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Split Ratio", + "description": "Ratio of the equity split, if a split occurred." + }, + "dividend": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend", + "description": "Dividend amount, if a dividend was paid." + }, "close_time": { "anyOf": [ { @@ -36700,30 +39280,6 @@ "title": "Interval", "description": "The data time frequency." }, - "average": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Average", - "description": "Average trade price of an individual equity during the interval." - }, - "change": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change", - "description": "Change in the price of the symbol from the previous day." - }, "intra_period": { "anyOf": [ { @@ -36735,138 +39291,6 @@ ], "title": "Intra Period", "description": "If true, the equity price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period" - }, - "adj_open": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Open", - "description": "Adjusted open price during the period." - }, - "adj_high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj High", - "description": "Adjusted high price during the period." - }, - "adj_low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Low", - "description": "Adjusted low price during the period." - }, - "adj_close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Close", - "description": "Adjusted closing price during the period." - }, - "adj_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Volume", - "description": "Adjusted volume during the period." - }, - "factor": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Factor", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices." - }, - "split_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Split Ratio", - "description": "Ratio of the equity split, if a equity split occurred." - }, - "dividend": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend", - "description": "Dividend amount, if a dividend was paid." - }, - "percent_change": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Percent Change", - "description": "Percent change in the price of the symbol from the previous day." - }, - "fifty_two_week_high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Fifty Two Week High", - "description": "52 week high price for the symbol." - }, - "fifty_two_week_low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Fifty Two Week Low", - "description": "52 week low price for the symbol." } }, "additionalProperties": true, @@ -37759,7 +40183,7 @@ } ], "title": "Prev Close", - "description": "The closing price of the previous trading day." + "description": "The previous close price." }, "change": { "anyOf": [ @@ -37921,6 +40345,2211 @@ "title": "IntrinioEquitySearch", "description": "Intrinio Equity Search Data." }, + "IntrinioEtfHoldings": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "The common name for the holding." + }, + "security_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Security Type", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')" + }, + "isin": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isin", + "description": "The International Securities Identification Number." + }, + "ric": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ric", + "description": "The Reuters Instrument Code." + }, + "sedol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sedol", + "description": "The Stock Exchange Daily Official List." + }, + "share_class_figi": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Share Class Figi", + "description": "The OpenFIGI symbol for the holding." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The country or region of the holding." + }, + "maturity_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Maturity Date", + "description": "The maturity date for the debt security, if available." + }, + "contract_expiry_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Contract Expiry Date", + "description": "Expiry date for the futures contract held, if available." + }, + "coupon": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Coupon", + "description": "The coupon rate of the debt security, if available." + }, + "balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Balance", + "description": "The number of units of the security held, if available." + }, + "unit": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Unit", + "description": "The units of the 'balance' field." + }, + "units_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Units Per Share", + "description": "Number of units of the security held per share outstanding of the ETF, if available." + }, + "face_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Face Value", + "description": "The face value of the debt security, if available." + }, + "derivatives_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Derivatives Value", + "description": "The notional value of derivatives contracts held." + }, + "value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Value", + "description": "The market value of the holding, on the 'as_of' date." + }, + "weight": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Weight", + "description": "The weight of the holding, as a normalized percent." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Updated", + "description": "The 'as_of' date for the holding." + } + }, + "additionalProperties": true, + "type": "object", + "title": "IntrinioEtfHoldings", + "description": "Intrinio ETF Holdings Data." + }, + "IntrinioEtfInfo": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the ETF." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description", + "description": "Description of the fund." + }, + "inception_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Inception Date", + "description": "Inception date of the ETF." + }, + "fund_listing_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Fund Listing Date", + "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange." + }, + "data_change_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Data Change Date", + "description": "The last date on which there was a change in a classifications data field for this ETF." + }, + "etn_maturity_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Etn Maturity Date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN." + }, + "is_listed": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Is Listed", + "description": "If true, the ETF is still listed on an exchange." + }, + "close_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Close Date", + "description": "The date on which the ETF was de-listed if it is no longer listed." + }, + "exchange": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchange", + "description": "The exchange Market Identifier Code (MIC)." + }, + "isin": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isin", + "description": "International Securities Identification Number (ISIN)." + }, + "ric": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ric", + "description": "Reuters Instrument Code (RIC)." + }, + "sedol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sedol", + "description": "Stock Exchange Daily Official List (SEDOL)." + }, + "figi_symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Figi Symbol", + "description": "Financial Instrument Global Identifier (FIGI) symbol." + }, + "share_class_figi": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Share Class Figi", + "description": "Financial Instrument Global Identifier (FIGI)." + }, + "firstbridge_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Firstbridge Id", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF)." + }, + "firstbridge_parent_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Firstbridge Parent Id", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable." + }, + "intrinio_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Intrinio Id", + "description": "Intrinio unique identifier for the security." + }, + "intraday_nav_symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Intraday Nav Symbol", + "description": "Intraday Net Asset Value (NAV) symbol." + }, + "primary_symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Primary Symbol", + "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes." + }, + "etp_structure_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Etp Structure Type", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure." + }, + "legal_structure": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Legal Structure", + "description": "Legal structure of the fund." + }, + "issuer": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Issuer", + "description": "Issuer of the ETF." + }, + "etn_issuing_bank": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Etn Issuing Bank", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank." + }, + "fund_family": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fund Family", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor." + }, + "investment_style": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Investment Style", + "description": "Investment style of the ETF." + }, + "derivatives_based": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Derivatives Based", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio." + }, + "income_category": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Income Category", + "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income" + }, + "asset_class": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Asset Class", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)." + }, + "other_asset_types": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Other Asset Types", + "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets." + }, + "single_category_designation": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Single Category Designation", + "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market." + }, + "beta_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Beta Type", + "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately." + }, + "beta_details": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Beta Details", + "description": "This field provides further detail within the traditional and smart beta categories." + }, + "market_cap_range": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Market Cap Range", + "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)" + }, + "market_cap_weighting_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Market Cap Weighting Type", + "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type." + }, + "index_weighting_scheme": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Weighting Scheme", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type." + }, + "index_linked": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Linked", + "description": "This field identifies whether an ETF is index linked or active." + }, + "index_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Name", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable." + }, + "index_symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Symbol", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF." + }, + "parent_index": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Index", + "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable." + }, + "index_family": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Family", + "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider." + }, + "broader_index_family": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Broader Index Family", + "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider." + }, + "index_provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Provider", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable." + }, + "index_provider_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Index Provider Code", + "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable." + }, + "replication_structure": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Replication Structure", + "description": "The replication structure of the Exchange Traded Product (ETP)." + }, + "growth_value_tilt": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Growth Value Tilt", + "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'." + }, + "growth_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Growth Type", + "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores." + }, + "value_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Value Type", + "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores." + }, + "sector": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sector", + "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to." + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry", + "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to." + }, + "industry_group": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry Group", + "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to." + }, + "cross_sector_theme": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cross Sector Theme", + "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)" + }, + "natural_resources_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Natural Resources Type", + "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure." + }, + "us_or_excludes_us": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Us Or Excludes Us", + "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US." + }, + "developed_emerging": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Developed Emerging", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to." + }, + "specialized_region": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Specialized Region", + "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)" + }, + "continent": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Continent", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent." + }, + "latin_america_sub_group": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Latin America Sub Group", + "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure." + }, + "europe_sub_group": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Europe Sub Group", + "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure." + }, + "asia_sub_group": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Asia Sub Group", + "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure." + }, + "specific_country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Specific Country", + "description": "This field is populated if the ETF provides targeted exposure to a specific country." + }, + "china_listing_location": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "China Listing Location", + "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities." + }, + "us_state": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Us State", + "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies." + }, + "real_estate": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Real Estate", + "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market." + }, + "fundamental_weighting_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fundamental Weighting Type", + "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology." + }, + "dividend_weighting_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Dividend Weighting Type", + "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology." + }, + "bond_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Bond Type", + "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF." + }, + "government_bond_types": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Government Bond Types", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure." + }, + "municipal_bond_region": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Municipal Bond Region", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure." + }, + "municipal_vrdo": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Municipal Vrdo", + "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations." + }, + "mortgage_bond_types": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Mortgage Bond Types", + "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities." + }, + "bond_tax_status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Bond Tax Status", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities." + }, + "credit_quality": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Credit Quality", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range." + }, + "average_maturity": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Average Maturity", + "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range." + }, + "specific_maturity_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Specific Maturity Year", + "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year." + }, + "commodity_types": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Commodity Types", + "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF." + }, + "energy_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Energy Type", + "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF." + }, + "agricultural_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Agricultural Type", + "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF." + }, + "livestock_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Livestock Type", + "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF." + }, + "metal_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Metal Type", + "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF." + }, + "inverse_leveraged": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Inverse Leveraged", + "description": "This field is populated if the ETF provides inverse or leveraged exposure." + }, + "target_date_multi_asset_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Target Date Multi Asset Type", + "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF." + }, + "currency_pair": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency Pair", + "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure." + }, + "social_environmental_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Social Environmental Type", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme." + }, + "clean_energy_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Clean Energy Type", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field." + }, + "dividend_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Dividend Type", + "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus." + }, + "regular_dividend_payor_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Regular Dividend Payor Type", + "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field." + }, + "quant_strategies_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Quant Strategies Type", + "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy." + }, + "other_quant_models": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Other Quant Models", + "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF." + }, + "hedge_fund_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Hedge Fund Type", + "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy." + }, + "excludes_financials": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Excludes Financials", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective." + }, + "excludes_technology": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Excludes Technology", + "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective." + }, + "holds_only_nyse_stocks": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Only Nyse Stocks", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE." + }, + "holds_only_nasdaq_stocks": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Only Nasdaq Stocks", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq." + }, + "holds_mlp": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Mlp", + "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy." + }, + "holds_preferred_stock": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Preferred Stock", + "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy." + }, + "holds_closed_end_funds": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Closed End Funds", + "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy." + }, + "holds_adr": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Holds Adr", + "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy." + }, + "laddered": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Laddered", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure." + }, + "zero_coupon": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Zero Coupon", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills." + }, + "floating_rate": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Floating Rate", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds." + }, + "build_america_bonds": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Build America Bonds", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds." + }, + "dynamic_futures_roll": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dynamic Futures Roll", + "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs." + }, + "currency_hedged": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Currency Hedged", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure." + }, + "includes_short_exposure": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Includes Short Exposure", + "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF." + }, + "ucits": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Ucits", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant" + }, + "registered_countries": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Registered Countries", + "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe." + }, + "issuer_country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Issuer Country", + "description": "2 letter ISO country code for the country where the issuer is located." + }, + "domicile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Domicile", + "description": "2 letter ISO country code for the country where the ETP is domiciled." + }, + "listing_country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Listing Country", + "description": "2 letter ISO country code for the country of the primary listing." + }, + "listing_region": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Listing Region", + "description": "Geographic region in the country of the primary listing falls." + }, + "bond_currency_denomination": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Bond Currency Denomination", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities." + }, + "base_currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Base Currency", + "description": "Base currency in which NAV is reported." + }, + "listing_currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Listing Currency", + "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code." + }, + "number_of_holdings": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Holdings", + "description": "The number of holdings in the ETF." + }, + "month_end_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Month End Assets", + "description": "Net assets in millions of dollars as of the most recent month end." + }, + "net_expense_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Expense Ratio", + "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "etf_portfolio_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Etf Portfolio Turnover", + "description": "The percentage of positions turned over in the last 12 months.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "name", + "inception_date" + ], + "title": "IntrinioEtfInfo", + "description": "Intrinio ETF Info Data." + }, + "IntrinioEtfPricePerformance": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "one_day": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Day", + "description": "One-day return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "wtd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Wtd", + "description": "Week to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "one_week": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Week", + "description": "One-week return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "mtd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mtd", + "description": "Month to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "one_month": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Month", + "description": "One-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "qtd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Qtd", + "description": "Quarter to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "three_month": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Three Month", + "description": "Three-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "six_month": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Six Month", + "description": "Six-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ytd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ytd", + "description": "Year to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "one_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Year", + "description": "One-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "two_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Two Year", + "description": "Two-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "three_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Three Year", + "description": "Three-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "four_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Four Year", + "description": "Four-year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "five_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Five Year", + "description": "Five-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ten_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ten Year", + "description": "Ten-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "max": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Max", + "description": "Return from the beginning of the time series.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "max_annualized": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Max Annualized", + "description": "Annualized rate of return from inception.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volatility_one_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volatility One Year", + "description": "Trailing one-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volatility_three_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volatility Three Year", + "description": "Trailing three-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volatility_five_year": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volatility Five Year", + "description": "Trailing five-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume", + "description": "The trading volume." + }, + "volume_avg_30": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volume Avg 30", + "description": "The one-month average daily volume." + }, + "volume_avg_90": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volume Avg 90", + "description": "The three-month average daily volume." + }, + "volume_avg_180": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volume Avg 180", + "description": "The six-month average daily volume." + }, + "beta": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Beta", + "description": "Beta compared to the S&P 500." + }, + "nav": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Nav", + "description": "Net asset value per share." + }, + "year_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year High", + "description": "The 52-week high price." + }, + "year_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Low", + "description": "The 52-week low price." + }, + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "The market capitalization." + }, + "shares_outstanding": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Shares Outstanding", + "description": "The number of shares outstanding." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Updated", + "description": "The date of the data." + } + }, + "additionalProperties": true, + "type": "object", + "title": "IntrinioEtfPricePerformance", + "description": "Intrinio ETF Performance Data." + }, + "IntrinioEtfSearch": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data.(ETF)" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the ETF." + }, + "exchange": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchange", + "description": "The exchange MIC code." + }, + "figi_ticker": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Figi Ticker", + "description": "The OpenFIGI ticker." + }, + "ric": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ric", + "description": "The Reuters Instrument Code." + }, + "isin": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isin", + "description": "The International Securities Identification Number." + }, + "sedol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sedol", + "description": "The Stock Exchange Daily Official List." + }, + "intrinio_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Intrinio Id", + "description": "The unique Intrinio ID for the security." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioEtfSearch", + "description": "Intrinio ETF Search Data." + }, "IntrinioFinancialRatios": { "properties": { "period_ending": { @@ -39522,95 +44151,6 @@ "title": "IntrinioInsiderTrading", "description": "Intrinio Insider Trading Data." }, - "IntrinioInstitutionalOwnership": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "cik": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." - }, - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "name": { - "type": "string", - "title": "Name", - "description": "Name of the institutional owner." - }, - "value": { - "type": "number", - "title": "Value", - "description": "Value of the institutional owner." - }, - "amount": { - "type": "number", - "title": "Amount", - "description": "Amount of the institutional owner." - }, - "sole_voting_authority": { - "type": "number", - "title": "Sole Voting Authority", - "description": "Sole voting authority of the institutional owner." - }, - "shared_voting_authority": { - "type": "number", - "title": "Shared Voting Authority", - "description": "Shared voting authority of the institutional owner." - }, - "no_voting_authority": { - "type": "number", - "title": "No Voting Authority", - "description": "No voting authority of the institutional owner." - }, - "previous_amount": { - "type": "number", - "title": "Previous Amount", - "description": "Previous amount of the institutional owner." - }, - "amount_change": { - "type": "number", - "title": "Amount Change", - "description": "Amount change of the institutional owner." - }, - "amount_percent_change": { - "type": "number", - "title": "Amount Percent Change", - "description": "Amount percent change of the institutional owner." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol", - "date", - "name", - "value", - "amount", - "sole_voting_authority", - "shared_voting_authority", - "no_voting_authority", - "previous_amount", - "amount_change", - "amount_percent_change" - ], - "title": "IntrinioInstitutionalOwnership", - "description": "Intrinio Institutional Ownership Data." - }, "IntrinioKeyMetrics": { "properties": { "symbol": { @@ -39649,42 +44189,464 @@ "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, + "price_to_book": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Book", + "description": "Price to book ratio." + }, + "price_to_tangible_book": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Tangible Book", + "description": "Price to tangible book ratio." + }, + "price_to_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price To Revenue", + "description": "Price to revenue ratio." + }, + "quick_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Quick Ratio", + "description": "Quick ratio." + }, + "gross_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gross Margin", + "description": "Gross margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ebit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ebit Margin", + "description": "EBIT margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "profit_margin": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Profit Margin", + "description": "Profit margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "eps": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps", + "description": "Basic earnings per share." + }, + "eps_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps Growth", + "description": "EPS growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "revenue_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revenue Growth", + "description": "Revenue growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ebitda_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ebitda Growth", + "description": "EBITDA growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ebit_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ebit Growth", + "description": "EBIT growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "net_income_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Income Growth", + "description": "Net income growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "free_cash_flow_to_firm_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow To Firm Growth", + "description": "Free cash flow to firm growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "invested_capital_growth": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Invested Capital Growth", + "description": "Invested capital growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Assets", + "description": "Return on assets, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Equity", + "description": "Return on equity, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "return_on_invested_capital": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Return On Invested Capital", + "description": "Return on invested capital, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "ebitda": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Ebitda", + "description": "Earnings before interest, taxes, depreciation, and amortization." + }, + "ebit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Ebit", + "description": "Earnings before interest and taxes." + }, + "long_term_debt": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Long Term Debt", + "description": "Long-term debt." + }, + "total_debt": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Debt", + "description": "Total debt." + }, + "total_capital": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Capital", + "description": "The sum of long-term debt and total shareholder equity." + }, + "enterprise_value": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Enterprise Value", + "description": "Enterprise value." + }, + "free_cash_flow_to_firm": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Free Cash Flow To Firm", + "description": "Free cash flow to firm." + }, + "altman_z_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Altman Z Score", + "description": "Altman Z-score." + }, "beta": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Beta", - "description": "Beta relative to the broad market calculated on a rolling three-year basis." - }, - "volume": { - "type": "number", - "title": "Volume", - "description": "Volume" - }, - "fifty_two_week_high": { - "type": "number", - "title": "Fifty Two Week High", - "description": "52 week high" - }, - "fifty_two_week_low": { - "type": "number", - "title": "Fifty Two Week Low", - "description": "52 week low" + "description": "Beta relative to the broad market (rolling three-year)." }, "dividend_yield": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Dividend Yield", "description": "Dividend yield, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" + }, + "earnings_yield": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Earnings Yield", + "description": "Earnings yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "last_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Last Price", + "description": "Last price of the stock." + }, + "year_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year High", + "description": "52 week high" + }, + "year_low": { + "type": "number", + "title": "Year Low", + "description": "52 week low" + }, + "volume_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume Avg", + "description": "Average daily volume." + }, + "short_interest": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Short Interest", + "description": "Number of shares reported as sold short." + }, + "shares_outstanding": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Shares Outstanding", + "description": "Weighted average shares outstanding (TTM)." + }, + "days_to_cover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Days To Cover", + "description": "Days to cover short interest, based on average daily volume." } }, "additionalProperties": true, "type": "object", - "required": [ - "beta", - "volume", - "fifty_two_week_high", - "fifty_two_week_low" - ], "title": "IntrinioKeyMetrics", "description": "Intrinio Key Metrics Data." }, @@ -39731,13 +44693,12 @@ "title": "IntrinioLatestAttributes", "description": "Intrinio Latest Attributes Data." }, - "IntrinioMarketIndices": { + "IntrinioMarketSnapshots": { "properties": { - "date": { + "symbol": { "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, "open": { "anyOf": [ @@ -39798,15 +44759,176 @@ ], "title": "Volume", "description": "The trading volume." + }, + "prev_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Close", + "description": "The previous close price." + }, + "change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change", + "description": "The change in price from the previous close." + }, + "change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change Percent", + "description": "The change in price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "last_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Last Price", + "description": "The last trade price." + }, + "last_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Last Size", + "description": "The last trade size." + }, + "last_volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Last Volume", + "description": "The last trade volume." + }, + "last_trade_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Trade Timestamp", + "description": "The timestamp of the last trade." + }, + "bid_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Bid Size", + "description": "The size of the last bid price. Bid price and size is not always available." + }, + "bid_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Bid Price", + "description": "The last bid price. Bid price and size is not always available." + }, + "ask_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ask Price", + "description": "The last ask price. Ask price and size is not always available." + }, + "ask_size": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Ask Size", + "description": "The size of the last ask price. Ask price and size is not always available." + }, + "last_bid_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Bid Timestamp", + "description": "The timestamp of the last bid price. Bid price and size is not always available." + }, + "last_ask_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Ask Timestamp", + "description": "The timestamp of the last ask price. Ask price and size is not always available." } }, "additionalProperties": true, "type": "object", "required": [ - "date" + "symbol" ], - "title": "IntrinioMarketIndices", - "description": "Intrinio Market Indices Data." + "title": "IntrinioMarketSnapshots", + "description": "Intrinio Market Snapshots Data." }, "IntrinioOptionsChains": { "properties": { @@ -40346,16 +45468,64 @@ "title": "Contract Symbol", "description": "Contract symbol for the option." }, + "trade_timestamp": { + "type": "string", + "format": "date-time", + "title": "Trade Timestamp", + "description": "The datetime of order placement." + }, "trade_type": { "type": "string", + "enum": [ + "block", + "sweep", + "large" + ], "title": "Trade Type", "description": "The type of unusual trade." }, "sentiment": { "type": "string", + "enum": [ + "bullish", + "bearish", + "neutral" + ], "title": "Sentiment", "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price." }, + "bid_at_execution": { + "type": "number", + "title": "Bid At Execution", + "description": "Bid price at execution." + }, + "ask_at_execution": { + "type": "number", + "title": "Ask At Execution", + "description": "Ask price at execution." + }, + "average_price": { + "type": "number", + "title": "Average Price", + "description": "The average premium paid per option contract." + }, + "underlying_price_at_execution": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Underlying Price At Execution", + "description": "Price of the underlying security at execution of trade." + }, + "total_size": { + "type": "integer", + "title": "Total Size", + "description": "The total number of contracts involved in a single transaction." + }, "total_value": { "anyOf": [ { @@ -40367,52 +45537,20 @@ ], "title": "Total Value", "description": "The aggregated value of all option contract premiums included in the trade." - }, - "total_size": { - "type": "integer", - "title": "Total Size", - "description": "The total number of contracts involved in a single transaction." - }, - "average_price": { - "type": "number", - "title": "Average Price", - "description": "The average premium paid per option contract." - }, - "ask_at_execution": { - "type": "number", - "title": "Ask At Execution", - "description": "Ask price at execution." - }, - "bid_at_execution": { - "type": "number", - "title": "Bid At Execution", - "description": "Bid price at execution." - }, - "underlying_price_at_execution": { - "type": "number", - "title": "Underlying Price At Execution", - "description": "Price of the underlying security at execution of trade." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "title": "Timestamp", - "description": "The UTC timestamp of order placement." } }, "additionalProperties": true, "type": "object", "required": [ "contract_symbol", + "trade_timestamp", "trade_type", "sentiment", - "total_value", - "total_size", - "average_price", - "ask_at_execution", "bid_at_execution", - "underlying_price_at_execution", - "timestamp" + "ask_at_execution", + "average_price", + "total_size", + "total_value" ], "title": "IntrinioOptionsUnusual", "description": "Intrinio Unusual Options Data." @@ -40836,7 +45974,7 @@ } ], "title": "Images", - "description": "Images associated with the news." + "description": "Images associated with the article." }, "text": { "anyOf": [ @@ -42321,9 +47459,6 @@ }, { "$ref": "#/components/schemas/PolygonCompanyNews" - }, - { - "$ref": "#/components/schemas/TiingoCompanyNews" } ], "discriminator": { @@ -42332,8 +47467,7 @@ "benzinga": "#/components/schemas/BenzingaCompanyNews", "fmp": "#/components/schemas/FMPCompanyNews", "intrinio": "#/components/schemas/IntrinioCompanyNews", - "polygon": "#/components/schemas/PolygonCompanyNews", - "tiingo": "#/components/schemas/TiingoCompanyNews" + "polygon": "#/components/schemas/PolygonCompanyNews" } } }, @@ -42574,17 +47708,13 @@ }, { "$ref": "#/components/schemas/PolygonCryptoHistorical" - }, - { - "$ref": "#/components/schemas/TiingoCryptoHistorical" } ], "discriminator": { "propertyName": "provider", "mapping": { "fmp": "#/components/schemas/FMPCryptoHistorical", - "polygon": "#/components/schemas/PolygonCryptoHistorical", - "tiingo": "#/components/schemas/TiingoCryptoHistorical" + "polygon": "#/components/schemas/PolygonCryptoHistorical" } } }, @@ -42746,17 +47876,13 @@ }, { "$ref": "#/components/schemas/PolygonCurrencyHistorical" - }, - { - "$ref": "#/components/schemas/TiingoCurrencyHistorical" } ], "discriminator": { "propertyName": "provider", "mapping": { "fmp": "#/components/schemas/FMPCurrencyHistorical", - "polygon": "#/components/schemas/PolygonCurrencyHistorical", - "tiingo": "#/components/schemas/TiingoCurrencyHistorical" + "polygon": "#/components/schemas/PolygonCurrencyHistorical" } } }, @@ -42989,6 +48115,88 @@ "title": "OBBject_CurrencyReferenceRates", "description": "OBBject with results of type CurrencyReferenceRates" }, + "OBBject_CurrencySnapshots": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPCurrencySnapshots" + } + ], + "discriminator": { + "propertyName": "provider", + "mapping": { + "fmp": "#/components/schemas/FMPCurrencySnapshots" + } + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results.", + "has_list": true, + "is_union": false, + "model": "CurrencySnapshots" + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_CurrencySnapshots", + "description": "OBBject with results of type CurrencySnapshots" + }, "OBBject_DiscountWindowPrimaryCreditRate": { "properties": { "_id": { @@ -43586,9 +48794,6 @@ }, { "$ref": "#/components/schemas/PolygonEquityHistorical" - }, - { - "$ref": "#/components/schemas/TiingoEquityHistorical" } ], "discriminator": { @@ -43596,8 +48801,7 @@ "mapping": { "fmp": "#/components/schemas/FMPEquityHistorical", "intrinio": "#/components/schemas/IntrinioEquityHistorical", - "polygon": "#/components/schemas/PolygonEquityHistorical", - "tiingo": "#/components/schemas/TiingoEquityHistorical" + "polygon": "#/components/schemas/PolygonEquityHistorical" } } }, @@ -44490,6 +49694,96 @@ "title": "OBBject_EtfEquityExposure", "description": "OBBject with results of type EtfEquityExposure" }, + "OBBject_EtfHistorical": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPEquityHistorical" + }, + { + "$ref": "#/components/schemas/IntrinioEquityHistorical" + }, + { + "$ref": "#/components/schemas/PolygonEquityHistorical" + } + ], + "discriminator": { + "propertyName": "provider", + "mapping": { + "fmp": "#/components/schemas/FMPEquityHistorical", + "intrinio": "#/components/schemas/IntrinioEquityHistorical", + "polygon": "#/components/schemas/PolygonEquityHistorical" + } + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results.", + "has_list": true, + "is_union": false, + "model": "EtfHistorical" + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_EtfHistorical", + "description": "OBBject with results of type EtfHistorical" + }, "OBBject_EtfHoldings": { "properties": { "_id": { @@ -44504,6 +49798,9 @@ { "$ref": "#/components/schemas/FMPEtfHoldings" }, + { + "$ref": "#/components/schemas/IntrinioEtfHoldings" + }, { "$ref": "#/components/schemas/SecEtfHoldings" } @@ -44512,6 +49809,7 @@ "propertyName": "provider", "mapping": { "fmp": "#/components/schemas/FMPEtfHoldings", + "intrinio": "#/components/schemas/IntrinioEtfHoldings", "sec": "#/components/schemas/SecEtfHoldings" } } @@ -44753,12 +50051,16 @@ "oneOf": [ { "$ref": "#/components/schemas/FMPEtfInfo" + }, + { + "$ref": "#/components/schemas/IntrinioEtfInfo" } ], "discriminator": { "propertyName": "provider", "mapping": { - "fmp": "#/components/schemas/FMPEtfInfo" + "fmp": "#/components/schemas/FMPEtfInfo", + "intrinio": "#/components/schemas/IntrinioEtfInfo" } } }, @@ -44822,6 +50124,92 @@ "title": "OBBject_EtfInfo", "description": "OBBject with results of type EtfInfo" }, + "OBBject_EtfPricePerformance": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPPricePerformance" + }, + { + "$ref": "#/components/schemas/IntrinioEtfPricePerformance" + } + ], + "discriminator": { + "propertyName": "provider", + "mapping": { + "fmp": "#/components/schemas/FMPPricePerformance", + "intrinio": "#/components/schemas/IntrinioEtfPricePerformance" + } + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results.", + "has_list": true, + "is_union": false, + "model": "EtfPricePerformance" + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_EtfPricePerformance", + "description": "OBBject with results of type EtfPricePerformance" + }, "OBBject_EtfSearch": { "properties": { "_id": { @@ -44835,12 +50223,16 @@ "oneOf": [ { "$ref": "#/components/schemas/FMPEtfSearch" + }, + { + "$ref": "#/components/schemas/IntrinioEtfSearch" } ], "discriminator": { "propertyName": "provider", "mapping": { - "fmp": "#/components/schemas/FMPEtfSearch" + "fmp": "#/components/schemas/FMPEtfSearch", + "intrinio": "#/components/schemas/IntrinioEtfSearch" } } }, @@ -45322,6 +50714,88 @@ "title": "OBBject_FinancialRatios", "description": "OBBject with results of type FinancialRatios" }, + "OBBject_Form13FHR": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/SecForm13FHR" + } + ], + "discriminator": { + "propertyName": "provider", + "mapping": { + "sec": "#/components/schemas/SecForm13FHR" + } + } + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results.", + "has_list": true, + "is_union": false, + "model": "Form13FHR" + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Warnings", + "description": "List of warnings." + }, + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_Form13FHR", + "description": "OBBject with results of type Form13FHR" + }, "OBBject_FredRegional": { "properties": { "_id": { @@ -46921,16 +52395,12 @@ "oneOf": [ { "$ref": "#/components/schemas/FMPInstitutionalOwnership" - }, - { - "$ref": "#/components/schemas/IntrinioInstitutionalOwnership" } ], "discriminator": { "propertyName": "provider", "mapping": { - "fmp": "#/components/schemas/FMPInstitutionalOwnership", - "intrinio": "#/components/schemas/IntrinioInstitutionalOwnership" + "fmp": "#/components/schemas/FMPInstitutionalOwnership" } } }, @@ -47171,30 +52641,21 @@ "oneOf": [ { "$ref": "#/components/schemas/FMPKeyMetrics" + }, + { + "$ref": "#/components/schemas/IntrinioKeyMetrics" } ], "discriminator": { "propertyName": "provider", "mapping": { - "fmp": "#/components/schemas/FMPKeyMetrics" + "fmp": "#/components/schemas/FMPKeyMetrics", + "intrinio": "#/components/schemas/IntrinioKeyMetrics" } } }, "type": "array" }, - { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioKeyMetrics" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioKeyMetrics" - } - } - }, { "type": "null" } @@ -47202,7 +52663,7 @@ "title": "Results", "description": "Serializable results.", "has_list": true, - "is_union": true, + "is_union": false, "model": "KeyMetrics" }, "provider": { @@ -47429,21 +52890,21 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPMarketIndices" + "$ref": "#/components/schemas/FMPIndexHistorical" }, { - "$ref": "#/components/schemas/IntrinioMarketIndices" + "$ref": "#/components/schemas/IntrinioIndexHistorical" }, { - "$ref": "#/components/schemas/PolygonMarketIndices" + "$ref": "#/components/schemas/PolygonIndexHistorical" } ], "discriminator": { "propertyName": "provider", "mapping": { - "fmp": "#/components/schemas/FMPMarketIndices", - "intrinio": "#/components/schemas/IntrinioMarketIndices", - "polygon": "#/components/schemas/PolygonMarketIndices" + "fmp": "#/components/schemas/FMPIndexHistorical", + "intrinio": "#/components/schemas/IntrinioIndexHistorical", + "polygon": "#/components/schemas/PolygonIndexHistorical" } } }, @@ -47521,6 +52982,9 @@ { "$ref": "#/components/schemas/FMPMarketSnapshots" }, + { + "$ref": "#/components/schemas/IntrinioMarketSnapshots" + }, { "$ref": "#/components/schemas/PolygonMarketSnapshots" } @@ -47529,6 +52993,7 @@ "propertyName": "provider", "mapping": { "fmp": "#/components/schemas/FMPMarketSnapshots", + "intrinio": "#/components/schemas/IntrinioMarketSnapshots", "polygon": "#/components/schemas/PolygonMarketSnapshots" } } @@ -48180,17 +53645,20 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPPriceTargetConsensus" + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPPriceTargetConsensus" + } + ], + "discriminator": { + "propertyName": "provider", + "mapping": { + "fmp": "#/components/schemas/FMPPriceTargetConsensus" + } } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPriceTargetConsensus" - } - } + }, + "type": "array" }, { "type": "null" @@ -48198,7 +53666,7 @@ ], "title": "Results", "description": "Serializable results.", - "has_list": false, + "has_list": true, "is_union": false, "model": "PriceTargetConsensus" }, @@ -49560,88 +55028,6 @@ "title": "OBBject_SymbolMap", "description": "OBBject with results of type SymbolMap" }, - "OBBject_TrailingDividendYield": { - "properties": { - "_id": { - "type": "string", - "title": " Id" - }, - "results": { - "anyOf": [ - { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/TiingoTrailingDivYield" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "tiingo": "#/components/schemas/TiingoTrailingDivYield" - } - } - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "TrailingDividendYield" - }, - "provider": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Provider", - "description": "Provider name." - }, - "warnings": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Warning_" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Warnings", - "description": "List of warnings." - }, - "chart": { - "anyOf": [ - { - "$ref": "#/components/schemas/Chart" - }, - { - "type": "null" - } - ], - "description": "Chart object." - }, - "extra": { - "type": "object", - "title": "Extra", - "description": "Extra info." - } - }, - "type": "object", - "title": "OBBject_TrailingDividendYield", - "description": "OBBject with results of type TrailingDividendYield" - }, "OBBject_TreasuryConstantMaturity": { "properties": { "_id": { @@ -49993,9 +55379,6 @@ }, { "$ref": "#/components/schemas/IntrinioWorldNews" - }, - { - "$ref": "#/components/schemas/TiingoWorldNews" } ], "discriminator": { @@ -50003,8 +55386,7 @@ "mapping": { "benzinga": "#/components/schemas/BenzingaWorldNews", "fmp": "#/components/schemas/FMPWorldNews", - "intrinio": "#/components/schemas/IntrinioWorldNews", - "tiingo": "#/components/schemas/TiingoWorldNews" + "intrinio": "#/components/schemas/IntrinioWorldNews" } } }, @@ -51214,7 +56596,8 @@ "vwap": { "anyOf": [ { - "type": "number" + "type": "number", + "exclusiveMinimum": 0.0 }, { "type": "null" @@ -51527,7 +56910,7 @@ } ], "title": "Sequence Num", - "description": "\n The sequence number represents the sequence in which message events happened.\n These are increasing and unique per ticker symbol, but will not always be sequential\n (e.g., 1, 2, 6, 9, 10, 11)\n " + "description": "The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11)" }, "participant_timestamp": { "anyOf": [ @@ -51540,7 +56923,7 @@ } ], "title": "Participant Timestamp", - "description": "\n The nanosecond accuracy Participant/Exchange Unix Timestamp.\n This is the timestamp of when the quote was actually generated at the exchange.\n " + "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange." }, "sip_timestamp": { "anyOf": [ @@ -51553,7 +56936,7 @@ } ], "title": "Sip Timestamp", - "description": "\n The nanosecond accuracy SIP Unix Timestamp.\n This is the timestamp of when the SIP received this quote from the exchange which produced it.\n " + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it." }, "trf_timestamp": { "anyOf": [ @@ -51566,7 +56949,7 @@ } ], "title": "Trf Timestamp", - "description": "\n The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp.\n This is the timestamp of when the trade reporting facility received this quote.\n " + "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote." } }, "additionalProperties": true, @@ -52237,96 +57620,6 @@ "title": "PolygonIndexHistorical", "description": "Polygon Index Historical Data." }, - "PolygonMarketIndices": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data." - }, - "open": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Open", - "description": "The open price." - }, - "high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "High", - "description": "The high price." - }, - "low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Low", - "description": "The low price." - }, - "close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Close", - "description": "The close price." - }, - "volume": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." - }, - "transactions": { - "anyOf": [ - { - "type": "integer", - "exclusiveMinimum": 0.0 - }, - { - "type": "null" - } - ], - "title": "Transactions", - "description": "Number of transactions for the symbol in the time period." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "PolygonMarketIndices", - "description": "Polygon Market Indices Data." - }, "PolygonMarketSnapshots": { "properties": { "symbol": { @@ -52382,6 +57675,18 @@ "title": "Close", "description": "The close price." }, + "volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Volume", + "description": "The trading volume." + }, "prev_close": { "anyOf": [ { @@ -52404,7 +57709,7 @@ } ], "title": "Change", - "description": "The change in price." + "description": "The change in price from the previous close." }, "change_percent": { "anyOf": [ @@ -52416,19 +57721,9 @@ } ], "title": "Change Percent", - "description": "The change, as a percent." - }, - "volume": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." + "description": "The change in price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "vwap": { "anyOf": [ @@ -53455,7 +58750,7 @@ } ], "title": "Is Paid Kind", - "description": "If the debt security payments are are paid in kind." + "description": "If the debt security payments are paid in kind." }, "derivative_category": { "anyOf": [ @@ -54019,6 +59314,129 @@ "title": "SecEtfHoldings", "description": "SEC ETF Holdings Data." }, + "SecForm13FHR": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end-of-quarter date of the filing." + }, + "issuer": { + "type": "string", + "title": "Issuer", + "description": "The name of the issuer." + }, + "cusip": { + "type": "string", + "title": "Cusip", + "description": "The CUSIP of the security." + }, + "asset_class": { + "type": "string", + "title": "Asset Class", + "description": "The title of the asset class for the security." + }, + "security_type": { + "anyOf": [ + { + "type": "string", + "enum": [ + "SH", + "PRN" + ] + }, + { + "type": "null" + } + ], + "title": "Security Type", + "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'." + }, + "option_type": { + "anyOf": [ + { + "type": "string", + "enum": [ + "call", + "put" + ] + }, + { + "type": "null" + } + ], + "title": "Option Type", + "description": "Defined when the holdings being reported are put or call options. Only long positions are reported." + }, + "voting_authority_sole": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Voting Authority Sole", + "description": "The number of shares for which the Manager exercises sole voting authority (none)." + }, + "voting_authority_shared": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Voting Authority Shared", + "description": "The number of shares for which the Manager exercises a defined shared voting authority (none)." + }, + "voting_authority_other": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Voting Authority Other", + "description": "The number of shares for which the Manager exercises other shared voting authority (none)." + }, + "principal_amount": { + "type": "integer", + "title": "Principal Amount", + "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported" + }, + "value": { + "type": "integer", + "title": "Value", + "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter." + }, + "weight": { + "type": "number", + "title": "Weight", + "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "issuer", + "cusip", + "asset_class", + "principal_amount", + "value", + "weight" + ], + "title": "SecForm13FHR", + "description": "SEC Form 13F-HR Data." + }, "SecInstitutionsSearch": { "properties": { "name": { @@ -54356,20 +59774,13 @@ "title": "TEEconomicCalendar", "description": "Trading Economics Economic Calendar Data." }, - "TiingoCompanyNews": { + "UDFSearchResult": { "properties": { - "date": { + "symbol": { "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. Here it is the published date of the article." + "title": "Symbol" }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the article." - }, - "text": { + "full_name": { "anyOf": [ { "type": "string" @@ -54378,17 +59789,54 @@ "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Full Name" }, - "images": { + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + }, + "short_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Short Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "exchange": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchange" + }, + "ticker": { + "type": "string", + "title": "Ticker" + }, + "logo_urls": { "anyOf": [ { "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "type": "string" }, "type": "array" }, @@ -54396,531 +59844,22 @@ "type": "null" } ], - "title": "Images", - "description": "Images associated with the article." + "title": "Logo Urls" }, - "url": { + "type": { "type": "string", - "title": "Url", - "description": "URL to the article." - }, - "symbols": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Symbols", - "description": "Symbols associated with the article." - }, - "tags": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tags", - "description": "Tags associated with the news article." - }, - "article_id": { - "type": "integer", - "title": "Article Id", - "description": "Unique ID of the news article." - }, - "source": { - "type": "string", - "title": "Source", - "description": "News source." - }, - "crawl_date": { - "type": "string", - "format": "date-time", - "title": "Crawl Date", - "description": "Date the news article was crawled." + "title": "Type" } }, - "additionalProperties": true, "type": "object", "required": [ - "date", - "title", - "url", - "article_id", - "source", - "crawl_date" + "symbol", + "description", + "ticker", + "type" ], - "title": "TiingoCompanyNews", - "description": "Tiingo Company News data." - }, - "TiingoCryptoHistorical": { - "properties": { - "date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" - } - ], - "title": "Date", - "description": "The date of the data." - }, - "open": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Open", - "description": "The open price." - }, - "high": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "High", - "description": "The high price." - }, - "low": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Low", - "description": "The low price." - }, - "close": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Close", - "description": "The close price." - }, - "volume": { - "type": "number", - "title": "Volume", - "description": "The trading volume." - }, - "vwap": { - "anyOf": [ - { - "type": "number", - "exclusiveMinimum": 0.0 - }, - { - "type": "null" - } - ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." - }, - "transactions": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Transactions", - "description": "Number of transactions for the symbol in the time period." - }, - "volume_notional": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Volume Notional", - "description": "The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close", - "volume" - ], - "title": "TiingoCryptoHistorical", - "description": "Tiingo Crypto Historical Price Data." - }, - "TiingoCurrencyHistorical": { - "properties": { - "date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" - } - ], - "title": "Date", - "description": "The date of the data." - }, - "open": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Open", - "description": "The open price." - }, - "high": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "High", - "description": "The high price." - }, - "low": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Low", - "description": "The low price." - }, - "close": { - "type": "number", - "exclusiveMinimum": 0.0, - "title": "Close", - "description": "The close price." - }, - "volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." - }, - "vwap": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close" - ], - "title": "TiingoCurrencyHistorical", - "description": "Tiingo Currency Historical Price Data." - }, - "TiingoEquityHistorical": { - "properties": { - "date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" - } - ], - "title": "Date", - "description": "The date of the data." - }, - "open": { - "type": "number", - "title": "Open", - "description": "The open price." - }, - "high": { - "type": "number", - "title": "High", - "description": "The high price." - }, - "low": { - "type": "number", - "title": "Low", - "description": "The low price." - }, - "close": { - "type": "number", - "title": "Close", - "description": "The close price." - }, - "volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Volume", - "description": "The trading volume." - }, - "vwap": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." - }, - "adj_open": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Open", - "description": "Adjusted open price during the period." - }, - "adj_high": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj High", - "description": "Adjusted high price during the period." - }, - "adj_low": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Low", - "description": "Adjusted low price during the period." - }, - "adj_close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Close", - "description": "Adjusted closing price during the period." - }, - "adj_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Volume", - "description": "Adjusted volume during the period." - }, - "split_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Split Ratio", - "description": "Ratio of the equity split, if a equity split occurred." - }, - "dividend": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend", - "description": "Dividend amount, if a dividend was paid." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close" - ], - "title": "TiingoEquityHistorical", - "description": "Tiingo Equity Historical Price Data." - }, - "TiingoTrailingDivYield": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "trailing_dividend_yield": { - "type": "number", - "title": "Trailing Dividend Yield", - "description": "Trailing dividend yield." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "trailing_dividend_yield" - ], - "title": "TiingoTrailingDivYield", - "description": "Tiingo Trailing Dividend Yield Data." - }, - "TiingoWorldNews": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. The published date of the article." - }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the article." - }, - "images": { - "anyOf": [ - { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Images", - "description": "Images associated with the news." - }, - "text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Text", - "description": "Text/body of the article." - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Url", - "description": "URL to the article." - }, - "symbols": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Symbols", - "description": "Ticker tagged in the fetched news." - }, - "article_id": { - "type": "integer", - "title": "Article Id", - "description": "Unique ID of the news article." - }, - "site": { - "type": "string", - "title": "Site", - "description": "News source." - }, - "tags": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tags", - "description": "Tags associated with the news article." - }, - "crawl_date": { - "type": "string", - "format": "date-time", - "title": "Crawl Date", - "description": "Date the news article was crawled." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "title", - "article_id", - "site", - "crawl_date" - ], - "title": "TiingoWorldNews", - "description": "Tiingo World News Data." + "title": "UDFSearchResult", + "description": "UDF Symbol Search Model." }, "UDFSubsession": { "properties": { @@ -55150,6 +60089,28 @@ "title": "Currency Code", "default": "USD" }, + "sector": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sector" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Industry" + }, "fractional": { "anyOf": [ { @@ -55198,7 +60159,6 @@ "30", "60", "D", - "1D", "W", "M", "3M", @@ -55312,86 +60272,6 @@ "title": "UDFSymbol", "description": "UDF Symbol Model." }, - "UDFSymbolSearch": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol" - }, - "full_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Full Name" - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "short_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Short Name" - }, - "description": { - "type": "string", - "title": "Description" - }, - "exchange": { - "type": "string", - "title": "Exchange" - }, - "ticker": { - "type": "string", - "title": "Ticker" - }, - "logo_urls": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Logo Urls" - }, - "type": { - "type": "string", - "title": "Type" - } - }, - "type": "object", - "required": [ - "symbol", - "description", - "exchange", - "ticker", - "type" - ], - "title": "UDFSymbolSearch" - }, "ValidationError": { "properties": { "loc": { diff --git a/website/generate_excel_markdown.py b/website/generate_excel_markdown.py index a4405786216..555215edb70 100644 --- a/website/generate_excel_markdown.py +++ b/website/generate_excel_markdown.py @@ -33,114 +33,14 @@ class CommandLib: } API_PREFIX = "/api/v1" - # These examples will be generated in the core, but we keep them here meanwhile - EXAMPLE_PARAMS: Dict[str, Dict] = { + EXAMPLES: Dict[str, Dict] = { "/get": { - "array": '{"a","b","c";"d","e","f"}', - "rows": '"d"', - "columns": '"c"', + "Example 0": '=OBB.GET({"a","b","c";"d","e","f"})', + "Example 1": '=OBB.GET({"a","b","c";"d","e","f"},"d","c")', }, "/byod": { - "widget": '"widget_name"', - "backend": '"backend_name"', - }, - "crypto": { - "symbol": '"BTCUSD"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "query": '"coin"', - }, - "currency": { - "symbol": '"EURUSD"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - }, - "derivatives": { - "symbol": '"AAPL"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - }, - "/derivatives/futures/curve": { - "symbol": '"NG"', - }, - "economy": { - "countries": '"united_states"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "units": '"growth_previous"', - "frequency": '"quarterly"', - "harmonized": "TRUE", - "query": '"gdp"', - "symbol": '"GFDGDPA188S"', - "limit": 5, - "period": '"quarter"', - "type": '"real"', - "adjusted": "TRUE", - }, - "/economy/fred_regional": { - "symbol": '"NYICLAIMS"', - }, - "equity": { - "symbol": '"AAPL"', - "tag": '"ebitda"', - "query": '"ebitda"', - "year": 2022, - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "limit": 5, - "form_type": '"10-K"', - "period": '"annual"', - "frequency": '"quarterly"', - "type": "", - "sort": '"desc"', - "structure": '"flat"', - "date": '"2023-05-07"', - "page": 1, - "interval": '"1d"', - "is_symbol": "FALSE", - }, - "/equity/fundamental/reported_financials": { - "symbol": '"AAPL"', - "period": '"annual"', - "statement_type": '"balance"', - "limit": 5, - }, - "etf": { - "symbol": '"SPY"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "query": '"global"', - }, - "fixedincome": { - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "maturity": '"90d"', - "category": '"nonfinancial"', - "grade": '"aa"', - "date": '"2023-05-07"', - "yield_curve": '"spot"', - "index_type": '"yield"', - "inflation_adjusted": "TRUE", - "interest_rate_type": '"deposit"', - }, - "index": { - "symbol": '"^GSPC"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "index": '"sp500"', - }, - "news": { - "symbol": '"AAPL"', - "symbols": '"AAPL,MSFT"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "limit": 5, - }, - "regulators": { - "symbol": '"AAPL"', - "start_date": '"2023-01-01"', - "end_date": '"2023-12-31"', - "query": '"AAPL"', + "Example 0": '=OBB.BYOD("widget_name")', + "Example 1": '=OBB.BYOD("widget_name","backend_name")', }, } @@ -262,35 +162,41 @@ class CommandLib: return {} def _get_examples( - self, cmd: str, signature_: str, parameters: dict, sep: str = "," - ) -> dict: + self, cmd: str, sig_parameters: Dict, sep: str = "," + ) -> Dict[str, str]: """Get the examples of the command.""" - sig = signature_.split("(")[0] + "(" - category = signature_.split(".")[1].lower() - - def get_p_value(cmd, p_name) -> str: - if cmd in self.EXAMPLE_PARAMS: - return self.EXAMPLE_PARAMS[cmd].get(p_name, "") - return self.EXAMPLE_PARAMS.get(category, {}).get(p_name, "") - - required_eg = sig - for p_name, p_info in parameters.items(): - if p_info["required"]: - p_value = get_p_value(cmd, p_name) - required_eg += f"{p_value}{sep}" - required_eg = required_eg.strip(f"{sep} ") + ")" - - standard_eg = sig - for p_name, p_info in parameters.items(): - if p_name == "provider": - break - p_value = get_p_value(cmd, p_name) - standard_eg += f"{p_value}{sep}" - standard_eg = standard_eg.strip(f"{sep} ") + ")" - if cmd in ("/get", "/byod"): - return {"Required": required_eg, "Standard": standard_eg} - return {"Required": required_eg} + return self.EXAMPLES[cmd] + + # API examples + examples = self._traverse( + ["paths", self.API_PREFIX + cmd, "get", "examples"], self.openapi + ) + sig = "=OBB." + self.xl_funcs[cmd].get("name", "") + ex_reference: Dict[str, str] = {} + for i, ex in enumerate(examples): + ex_code = "" + if ex.get("scope") == "api": + ex_code += sig + "(" + ex_parameters = ex.get("parameters", {}) + for p_name, p_info in sig_parameters.items(): + p_type = p_info.get("type", {}) + if p_value := ex_parameters.get(p_name): + if p_type == "Text": + ex_code += f'"{p_value}"{sep}' + elif p_type == "Boolean": + p_type = "TRUE" if bool(p_value) else "FALSE" + ex_code += f"{p_type}{sep}" + else: + ex_code += f"{p_value}{sep}" + else: + ex_code += sep + ex_code = ex_code.strip(sep) + ex_code += ")" + # Some example are repeated, we only want to add them once + if ex_code not in ex_reference.values(): + ex_reference[f"Example {i}"] = ex_code + return ex_reference def get_info(self, cmd: str) -> Dict[str, Any]: """Get the info for a command.""" @@ -303,7 +209,7 @@ class CommandLib: signature_ = self._get_signature(cmd, parameters) data = self._get_data(cmd) return_ = self.xl_funcs[cmd].get("result", {}).get("dimensionality", "") - examples = self._get_examples(cmd, signature_, parameters) + examples = self._get_examples(cmd, parameters) return { "name": name, "description": description, @@ -423,7 +329,7 @@ class Editor: def get_examples() -> str: if cmd_examples := cmd_info["examples"]: - examples = "### Example\n\n" + examples = "## Examples\n\n" for _, v in cmd_examples.items(): # examples += f"### {k}\n\n" examples += f"```{self.interface}\n"