diff --git a/.pylintrc b/.pylintrc index 7dafd86d99eb..f0e599298418 100644 --- a/.pylintrc +++ b/.pylintrc @@ -54,7 +54,7 @@ confidence= # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call # disable=too-many-instance-attributes,len-as-condition,too-few-public-methods,anomalous-backslash-in-string,no-else-return,simplifiable-if-statement,too-many-arguments,duplicate-code,no-name-in-module,no-member,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,missing-docstring,invalid-name,bad-whitespace,consider-using-enumerate,unexpected-keyword-arg -disable=useless-return,missing-docstring,invalid-name,import-error,broad-except,unnecessary-lambda,missing-timeout,duplicate-code,consider-using-generator,unbalanced-tuple-unpacking,use-list-literal,no-name-in-module,use-sequence-for-iteration,use-dict-literal,unspecified-encoding,unsubscriptable-object,broad-exception-raised +disable=useless-return,missing-docstring,invalid-name,import-error,broad-except,unnecessary-lambda,missing-timeout,duplicate-code,consider-using-generator,unbalanced-tuple-unpacking,use-list-literal,no-name-in-module,use-sequence-for-iteration,use-dict-literal,unspecified-encoding,unsubscriptable-object,broad-exception-raised,possibly-used-before-assignment # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/website/content/cli/configuration.md b/website/content/cli/configuration.md index 9ade9e69d4b5..90216554af7b 100644 --- a/website/content/cli/configuration.md +++ b/website/content/cli/configuration.md @@ -18,12 +18,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. +In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/user_guides/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. :::important API credentials are defined in the `user_settings.json` file. -Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). +Find all data providers [here](/platform/user_guides/extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). Define default data sources by following the pattern outlined [here](data-sources) ::: diff --git a/website/content/cli/data-sources.md b/website/content/cli/data-sources.md index aa79329da1f2..7ded01b8bea7 100644 --- a/website/content/cli/data-sources.md +++ b/website/content/cli/data-sources.md @@ -26,7 +26,7 @@ Many commands have multiple data sources associated with it. This page describes :::important API credentials are defined in the `user_settings.json` file. -Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). +Find all data providers [here](/platform/user_guides/extensions/), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). ::: ## Data Source In-Command diff --git a/website/content/cli/installation.md b/website/content/cli/installation.md index b26cb5166590..abde7a52b966 100644 --- a/website/content/cli/installation.md +++ b/website/content/cli/installation.md @@ -25,9 +25,24 @@ The OpenBB Platform CLI is a wrapper around the [Platform](/platform), and shoul Please refer to the [OpenBB Platform install documentation](/platform/installation) for instructions and more information. :::info -If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components. +If the OpenBB Platform is not already installed, the `openbb-cli` package will install all available components. ::: +### Windows + +The machine may need to have an installation of Visual C++ Build Tools available. Download the elements highlighted in the images below. + +
+"Microsoft Visual C++ 14.0 or greater is required" + +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then continue. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135) + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3) + +
+ ### Linux Requirements Linux users will need to take additional steps prior to installation. @@ -71,26 +86,20 @@ Welcome to OpenBB Platform CLI v1.0.0 Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code. -Next, navigate into the folder: `~/OpenBBTerminal/cli` +Next, navigate into the folder: `~/OpenBBTerminal/openbb_platform` :::tip -The Python environment should have `toml` and `poetry` installed. +The Python environment should have `poetry` installed. ```bash -pip install toml poetry +pip install poetry ``` ::: Finally, enter: ```console -poetry install -``` - -Alternatively, install locally with `pip`: - -```bash -pip install -e . +python dev_install.py -e --cli ``` ## Installing New Modules diff --git a/website/content/excel/functions.json b/website/content/excel/functions.json index 1cebe7a1928b..c86e1b29f054 100644 --- a/website/content/excel/functions.json +++ b/website/content/excel/functions.json @@ -73,13 +73,13 @@ } }, { - "description": "Get historical price data for cryptocurrency pair(s) within a provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/crypto/price/historical", - "id": "CRYPTO.PRICE.HISTORICAL", - "name": "CRYPTO.PRICE.HISTORICAL", + "description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.", + "helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical", + "id": "CURRENCY.PRICE.HISTORICAL", + "name": "CURRENCY.PRICE.HISTORICAL", "parameters": [ { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -96,28 +96,10 @@ "type": "string" }, { - "description": "Options: fmp, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", + "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", "name": "interval", "optional": true, "type": "string" - }, - { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", - "optional": true, - "type": "number" } ], "result": { @@ -125,22 +107,28 @@ } }, { - "description": "Search available cryptocurrency pairs within a provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/crypto/search", - "id": "CRYPTO.SEARCH", - "name": "CRYPTO.SEARCH", + "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": "Search query.", - "name": "query", + "description": "The base currency symbol. Multiple comma separated items allowed.", + "name": "base", "optional": true, "type": "string" }, { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", + "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" } ], "result": { @@ -148,16 +136,11 @@ } }, { - "description": "Currency Historical Price. Currency historical data.\n\nCurrency historical prices refer to the past exchange rates of one currency against\nanother over a specific period.\nThis data provides insight into the fluctuations and trends in the foreign exchange market,\nhelping analysts, traders, and economists understand currency performance,\nevaluate economic health, and make predictions about future movements.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/price/historical", - "id": "CURRENCY.PRICE.HISTORICAL", - "name": "CURRENCY.PRICE.HISTORICAL", + "description": "Get the upcoming, or historical, economic calendar of global events.", + "helpUrl": "https://docs.openbb.co/excel/reference/economy/calendar", + "id": "ECONOMY.CALENDAR", + "name": "ECONOMY.CALENDAR", "parameters": [ - { - "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "name": "symbol", - "type": "string" - }, { "description": "Start date of the data, in YYYY-MM-DD format.", "name": "start_date", @@ -171,28 +154,28 @@ "type": "string" }, { - "description": "Options: fmp, polygon, defaults to fmp.", - "name": "provider", + "description": "Country of the event. Multiple comma separated items allowed.", + "name": "country", "optional": true, "type": "string" }, { - "description": "Time interval of the data to return. (provider: fmp);\nTime interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", - "name": "interval", + "description": "Importance of the event. Options: Low, Medium, High.", + "name": "importance", "optional": true, "type": "string" }, { - "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", - "name": "sort", + "description": "Grouping of events. Options: interest_rate, inflation, bonds, consumer, gdp, government, housing, labour, markets, money, prices, trade, business.", + "name": "group", "optional": true, "type": "string" }, { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed.", + "name": "calendar_id", "optional": true, - "type": "number" + "type": "any" } ], "result": { @@ -200,15 +183,14 @@ } }, { - "description": "Current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/reference_rates", - "id": "CURRENCY.REFERENCE_RATES", - "name": "CURRENCY.REFERENCE_RATES", + "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/compare/peers", + "id": "EQUITY.COMPARE.PEERS", + "name": "EQUITY.COMPARE.PEERS", "parameters": [ { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" } ], @@ -217,58 +199,16 @@ } }, { - "description": "Currency Search.\n\nSearch available currency pairs.\nCurrency pairs are the national currencies from two countries coupled for trading on\nthe foreign exchange (FX) marketplace.\nBoth currencies will have exchange rates on which the trade will have its position basis.\nAll trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.\n(ref: Investopedia)\nMajor currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.", - "helpUrl": "https://docs.openbb.co/excel/reference/currency/search", - "id": "CURRENCY.SEARCH", - "name": "CURRENCY.SEARCH", + "description": "Get consensus price target and recommendation.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/consensus", + "id": "EQUITY.ESTIMATES.CONSENSUS", + "name": "EQUITY.ESTIMATES.CONSENSUS", "parameters": [ { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Symbol of the pair to search. (provider: polygon)", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "optional": true, "type": "string" - }, - { - "description": "A specific date to get data for. (provider: polygon)", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Search for terms within the ticker and/or company name. (provider: polygon)", - "name": "search", - "optional": true, - "type": "string" - }, - { - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)", - "name": "active", - "optional": true, - "type": "boolean" - }, - { - "description": "Order data by ascending or descending. (provider: polygon)", - "name": "order", - "optional": true, - "type": "string" - }, - { - "description": "Sort field used for ordering. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: polygon)", - "name": "limit", - "optional": true, - "type": "number" } ], "result": { @@ -276,34 +216,27 @@ } }, { - "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", + "description": "Get historical analyst estimates for earnings and revenue.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/historical", + "id": "EQUITY.ESTIMATES.HISTORICAL", + "name": "EQUITY.ESTIMATES.HISTORICAL", "parameters": [ { - "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp.", - "name": "base", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "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", + "description": "Time period of the data to return. Options: quarter, annual.", + "name": "period", "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", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" } ], "result": { @@ -311,98 +244,94 @@ } }, { - "description": "Get the complete options chain for a ticker.", - "helpUrl": "https://docs.openbb.co/excel/reference/derivatives/options/chains", - "id": "DERIVATIVES.OPTIONS.CHAINS", - "name": "DERIVATIVES.OPTIONS.CHAINS", + "description": "Get analyst price targets by company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/price_target", + "id": "EQUITY.ESTIMATES.PRICE_TARGET", + "name": "EQUITY.ESTIMATES.PRICE_TARGET", "parameters": [ { - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", + "optional": true, "type": "string" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" }, { - "description": "The end-of-day date for options chains data. (provider: intrinio)", - "name": "date", + "description": "Options: benzinga, fmp, defaults to benzinga.", + "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/unusual", - "id": "DERIVATIVES.OPTIONS.UNUSUAL", - "name": "DERIVATIVES.OPTIONS.UNUSUAL", - "parameters": [ + }, { - "description": "Symbol to get data for. (the underlying symbol)", - "name": "symbol", + "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters.", + "name": "page", "optional": true, - "type": "string" + "type": "number" }, { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", + "description": "Date for calendar data, shorthand for date_from and date_to.", + "name": "date", "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)", + "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. 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.", "name": "end_date", "optional": true, "type": "string" }, { - "description": "The type of unusual activity to query for. (provider: intrinio)", - "name": "trade_type", + "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD.", + "name": "updated", "optional": true, - "type": "string" + "type": "any" + }, + { + "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated", + "name": "importance", + "optional": true, + "type": "number" }, { - "description": "The sentiment type to query for. (provider: intrinio)", - "name": "sentiment", + "description": "Filter by a specific action_company. Options: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates, terminates, removes, suspends, firm_dissolved.", + "name": "action", "optional": true, "type": "string" }, { - "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)", - "name": "min_value", + "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed.", + "name": "analyst_ids", "optional": true, - "type": "number" + "type": "any" }, { - "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)", - "name": "max_value", + "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed.", + "name": "firm_ids", "optional": true, - "type": "number" + "type": "any" }, { - "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", + "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.", + "name": "fields", "optional": true, - "type": "number" + "type": "any" }, { - "description": "The source of the data. Either realtime or delayed. (provider: intrinio)", - "name": "source", + "description": "Include upgrades and downgrades in the response.", + "name": "with_grade", "optional": true, - "type": "string" + "type": "boolean" } ], "result": { @@ -410,34 +339,27 @@ } }, { - "description": "Balance of Payments Reports.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/balance_of_payments", - "id": "ECONOMY.BALANCE_OF_PAYMENTS", - "name": "ECONOMY.BALANCE_OF_PAYMENTS", + "description": "Get the balance sheet for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance", + "id": "EQUITY.FUNDAMENTAL.BALANCE", + "name": "EQUITY.FUNDAMENTAL.BALANCE", "parameters": [ { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The report type, the level of detail in the data. (provider: ecb)", - "name": "report_type", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)", - "name": "frequency", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)", - "name": "country", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "any" + "type": "number" } ], "result": { @@ -445,46 +367,27 @@ } }, { - "description": "Get the upcoming, or historical, economic calendar of global events.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/calendar", - "id": "ECONOMY.CALENDAR", - "name": "ECONOMY.CALENDAR", + "description": "Get the cash flow statement for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash", + "id": "EQUITY.FUNDAMENTAL.CASH", + "name": "EQUITY.FUNDAMENTAL.CASH", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, tradingeconomics, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", - "name": "country", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "Importance of the event. (provider: tradingeconomics)", - "name": "importance", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Grouping of events (provider: tradingeconomics)", - "name": "group", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" } ], "result": { @@ -492,11 +395,16 @@ } }, { - "description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/composite_leading_indicator", - "id": "ECONOMY.COMPOSITE_LEADING_INDICATOR", - "name": "ECONOMY.COMPOSITE_LEADING_INDICATOR", + "description": "Get historical dividend data for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/dividends", + "id": "EQUITY.FUNDAMENTAL.DIVIDENDS", + "name": "EQUITY.FUNDAMENTAL.DIVIDENDS", "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", @@ -508,18 +416,6 @@ "name": "end_date", "optional": true, "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" } ], "result": { @@ -527,3402 +423,28 @@ } }, { - "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/cpi", - "id": "ECONOMY.CPI", - "name": "ECONOMY.CPI", + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/filings", + "id": "EQUITY.FUNDAMENTAL.FILINGS", + "name": "EQUITY.FUNDAMENTAL.FILINGS", "parameters": [ { - "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred.", - "name": "country", - "type": "string" - }, - { - "description": "The unit of measurement for the data.\nOptions:\n- `growth_previous`: Percent growth from the previous period.\nIf monthly data, this is month-over-month, etc\n- `growth_same`: Percent growth from the same period in the previous year.\nIf looking at monthly data, this would be year-over-year, etc.\n- `index_2015`: Rescaled index value, such that the value in 2015 is 100.", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "The frequency of the data.\nOptions: `monthly`, `quarter`, and `annual`.", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "Whether you wish to obtain harmonized data.", - "name": "harmonized", - "optional": true, - "type": "boolean" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Query the Geo Fred API for regional economic data by series group.\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_regional", - "id": "ECONOMY.FRED_REGIONAL", - "name": "ECONOMY.FRED_REGIONAL", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)", - "name": "is_series_group", - "optional": true, - "type": "boolean" - }, - { - "description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)", - "name": "region_type", - "optional": true, - "type": "string" - }, - { - "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)", - "name": "season", - "optional": true, - "type": "string" - }, - { - "description": "The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when `is_series_group` is True. (provider: fred)", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "Frequency aggregation to convert high frequency data to lower frequency.\nParameter is only valid when `is_series_group` is True.\na = Annual\nsa= Semiannual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\nOnly valid when `is_series_group` is True.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)", - "name": "aggregation_method", - "optional": true, - "type": "string" - }, - { - "description": "Transformation type. Only valid when `is_series_group` is True.\nlin = Levels (No transformation)\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)", - "name": "transform", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for FRED series or economic releases by ID or string.\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_search", - "id": "ECONOMY.FRED_SEARCH", - "name": "ECONOMY.FRED_SEARCH", - "parameters": [ - { - "description": "The search word(s).", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Is release? If True, other search filter variables are ignored. If no query text or release_id is supplied, this defaults to True. (provider: fred)", - "name": "is_release", - "optional": true, - "type": "boolean" - }, - { - "description": "A specific release ID to target. (provider: fred)", - "name": "release_id", - "optional": true, - "type": "any" - }, - { - "description": "The number of data entries to return. (1-1000) (provider: fred)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Offset the results in conjunction with limit. (provider: fred)", - "name": "offset", - "optional": true, - "type": "number" - }, - { - "description": "Filter by an attribute. (provider: fred)", - "name": "filter_variable", - "optional": true, - "type": "any" - }, - { - "description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)", - "name": "filter_value", - "optional": true, - "type": "string" - }, - { - "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)", - "name": "tag_names", - "optional": true, - "type": "string" - }, - { - "description": "A semicolon delimited list of tag names that series match none of. Example: 'imports;services'. Requires that variable tag_names also be set to limit the number of matching series. (provider: fred)", - "name": "exclude_tag_names", - "optional": true, - "type": "string" - }, - { - "description": "A FRED Series ID to return series group information for. This returns the required information to query for regional data. Not all series that are in FRED have geographical data. Entering a value for series_id will override all other parameters. Multiple series_ids can be separated by commas. (provider: fred)", - "name": "series_id", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data by series ID from FRED.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/fred_series", - "id": "ECONOMY.FRED_SERIES", - "name": "ECONOMY.FRED_SERIES", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.", - "name": "symbol", - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fred, intrinio, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Frequency aggregation to convert high frequency data to lower frequency.\nNone = No change\na = Annual\nq = Quarterly\nm = Monthly\nw = Weekly\nd = Daily\nwef = Weekly, Ending Friday\nweth = Weekly, Ending Thursday\nwew = Weekly, Ending Wednesday\nwetu = Weekly, Ending Tuesday\nwem = Weekly, Ending Monday\nwesu = Weekly, Ending Sunday\nwesa = Weekly, Ending Saturday\nbwew = Biweekly, Ending Wednesday\nbwem = Biweekly, Ending Monday\n(provider: fred)", - "name": "frequency", - "optional": true, - "type": "any" - }, - { - "description": "A key that indicates the aggregation method used for frequency aggregation.\nThis parameter has no affect if the frequency parameter is not set.\navg = Average\nsum = Sum\neop = End of Period\n(provider: fred)", - "name": "aggregation_method", - "optional": true, - "type": "any" - }, - { - "description": "Transformation type\nNone = No transformation\nchg = Change\nch1 = Change from Year Ago\npch = Percent Change\npc1 = Percent Change from Year Ago\npca = Compounded Annual Rate of Change\ncch = Continuously Compounded Rate of Change\ncca = Continuously Compounded Annual Rate of Change\nlog = Natural Log\n(provider: fred)", - "name": "transform", - "optional": true, - "type": "any" - }, - { - "description": "Returns all pages of data from the API call at once. (provider: intrinio)", - "name": "all_pages", - "optional": true, - "type": "boolean" - }, - { - "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", - "name": "sleep", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Forecasted GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/forecast", - "id": "ECONOMY.GDP.FORECAST", - "name": "ECONOMY.GDP.FORECAST", - "parameters": [ - { - "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Type of GDP to get forecast of. Either nominal or real.", - "name": "type", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Nominal GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/nominal", - "id": "ECONOMY.GDP.NOMINAL", - "name": "ECONOMY.GDP.NOMINAL", - "parameters": [ - { - "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", - "name": "units", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Real GDP Data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/gdp/real", - "id": "ECONOMY.GDP.REAL", - "name": "ECONOMY.GDP.REAL", - "parameters": [ - { - "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", - "name": "units", - "optional": true, - "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: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Long-term interest rates refer to government bonds maturing in ten years.\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/long_term_interest_rate", - "id": "ECONOMY.LONG_TERM_INTEREST_RATE", - "name": "ECONOMY.LONG_TERM_INTEREST_RATE", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get interest rate for for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/money_measures", - "id": "ECONOMY.MONEY_MEASURES", - "name": "ECONOMY.MONEY_MEASURES", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Whether to return seasonally adjusted data.", - "name": "adjusted", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: federal_reserve, defaults to federal_reserve.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Market Risk Premium by country.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/risk_premium", - "id": "ECONOMY.RISK_PREMIUM", - "name": "ECONOMY.RISK_PREMIUM", - "parameters": [ - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Short-term interest rates are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/short_term_interest_rate", - "id": "ECONOMY.SHORT_TERM_INTEREST_RATE", - "name": "ECONOMY.SHORT_TERM_INTEREST_RATE", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get interest rate for for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Global unemployment data.", - "helpUrl": "https://docs.openbb.co/excel/reference/economy/unemployment", - "id": "ECONOMY.UNEMPLOYMENT", - "name": "ECONOMY.UNEMPLOYMENT", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: oecd, defaults to oecd.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Country to get GDP for. (provider: oecd)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Sex to get unemployment for. (provider: oecd)", - "name": "sex", - "optional": true, - "type": "string" - }, - { - "description": "Frequency to get unemployment for. (provider: oecd)", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "Age group to get unemployment for. Total indicates 15 years or over (provider: oecd)", - "name": "age", - "optional": true, - "type": "string" - }, - { - "description": "Whether to get seasonally adjusted unemployment. Defaults to False. (provider: oecd)", - "name": "seasonal_adjustment", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/dividend", - "id": "EQUITY.CALENDAR.DIVIDEND", - "name": "EQUITY.CALENDAR.DIVIDEND", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/earnings", - "id": "EQUITY.CALENDAR.EARNINGS", - "name": "EQUITY.CALENDAR.EARNINGS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming initial public offerings (IPOs).", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/ipo", - "id": "EQUITY.CALENDAR.IPO", - "name": "EQUITY.CALENDAR.IPO", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "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": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)", - "name": "status", - "optional": true, - "type": "string" - }, - { - "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)", - "name": "offer_amount_greater_than", - "optional": true, - "type": "number" - }, - { - "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)", - "name": "offer_amount_less_than", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical and upcoming stock split operations.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/calendar/splits", - "id": "EQUITY.CALENDAR.SPLITS", - "name": "EQUITY.CALENDAR.SPLITS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the closest peers for a given company.\n\nPeers consist of companies trading on the same exchange, operating within the same sector\nand with comparable market capitalizations.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/compare/peers", - "id": "EQUITY.COMPARE.PEERS", - "name": "EQUITY.COMPARE.PEERS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/discovery/filings", - "id": "EQUITY.DISCOVERY.FILINGS", - "name": "EQUITY.DISCOVERY.FILINGS", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", - "name": "form_type", - "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": "Flag for whether or not the filing is done. (provider: fmp)", - "name": "isDone", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for specific analysts and get their forecast track record.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/analyst_search", - "id": "EQUITY.ESTIMATES.ANALYST_SEARCH", - "name": "EQUITY.ESTIMATES.ANALYST_SEARCH", - "parameters": [ - { - "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": "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" - }, - { - "description": "Options: benzinga, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "analyst_ids", - "optional": true, - "type": "string" - }, - { - "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "name": "firm_ids", - "optional": true, - "type": "string" - }, - { - "description": "Number of results returned. Limit 1000. (provider: benzinga)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga)", - "name": "page", - "optional": true, - "type": "number" - }, - { - "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": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get consensus price target and recommendation.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/consensus", - "id": "EQUITY.ESTIMATES.CONSENSUS", - "name": "EQUITY.ESTIMATES.CONSENSUS", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical analyst estimates for earnings and revenue.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/historical", - "id": "EQUITY.ESTIMATES.HISTORICAL", - "name": "EQUITY.ESTIMATES.HISTORICAL", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "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": { - "dimensionality": "matrix" - } - }, - { - "description": "Get analyst price targets by company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/estimates/price_target", - "id": "EQUITY.ESTIMATES.PRICE_TARGET", - "name": "EQUITY.ESTIMATES.PRICE_TARGET", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", - "name": "symbol", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: benzinga, fmp, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters. (provider: benzinga)", - "name": "page", - "optional": true, - "type": "number" - }, - { - "description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format. (provider: benzinga)", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD. (provider: benzinga)", - "name": "updated", - "optional": true, - "type": "any" - }, - { - "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)", - "name": "importance", - "optional": true, - "type": "number" - }, - { - "description": "Filter by a specific action_company. (provider: benzinga)", - "name": "action", - "optional": true, - "type": "string" - }, - { - "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 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 comma separated items allowed. (provider: benzinga)", - "name": "fields", - "optional": true, - "type": "any" - }, - { - "description": "Include upgrades and downgrades in the response. (provider: fmp)", - "name": "with_grade", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the balance sheet for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance", - "id": "EQUITY.FUNDAMENTAL.BALANCE", - "name": "EQUITY.FUNDAMENTAL.BALANCE", - "parameters": [ - { - "description": "Symbol to get data for.", - "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, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", - "name": "fiscal_year", - "optional": true, - "type": "number" - }, - { - "description": "Filing date of the financial statement. (provider: polygon)", - "name": "filing_date", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than the given date. (provider: polygon)", - "name": "filing_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than or equal to the given date. (provider: polygon)", - "name": "filing_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than the given date. (provider: polygon)", - "name": "filing_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than or equal to the given date. (provider: polygon)", - "name": "filing_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date of the financial statement. (provider: polygon)", - "name": "period_of_report_date", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than the given date. (provider: polygon)", - "name": "period_of_report_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than the given date. (provider: polygon)", - "name": "period_of_report_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Whether to include the sources of the financial statement. (provider: polygon)", - "name": "include_sources", - "optional": true, - "type": "boolean" - }, - { - "description": "Order of the financial statement. (provider: polygon)", - "name": "order", - "optional": true, - "type": "string" - }, - { - "description": "Sort of the financial statement. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the growth of a company's balance sheet items over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/balance_growth", - "id": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH", - "name": "EQUITY.FUNDAMENTAL.BALANCE_GROWTH", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the cash flow statement for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash", - "id": "EQUITY.FUNDAMENTAL.CASH", - "name": "EQUITY.FUNDAMENTAL.CASH", - "parameters": [ - { - "description": "Symbol to get data for.", - "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, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", - "name": "fiscal_year", - "optional": true, - "type": "number" - }, - { - "description": "Filing date of the financial statement. (provider: polygon)", - "name": "filing_date", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than the given date. (provider: polygon)", - "name": "filing_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than or equal to the given date. (provider: polygon)", - "name": "filing_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than the given date. (provider: polygon)", - "name": "filing_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than or equal to the given date. (provider: polygon)", - "name": "filing_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date of the financial statement. (provider: polygon)", - "name": "period_of_report_date", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than the given date. (provider: polygon)", - "name": "period_of_report_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than the given date. (provider: polygon)", - "name": "period_of_report_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Whether to include the sources of the financial statement. (provider: polygon)", - "name": "include_sources", - "optional": true, - "type": "boolean" - }, - { - "description": "Order of the financial statement. (provider: polygon)", - "name": "order", - "optional": true, - "type": "any" - }, - { - "description": "Sort of the financial statement. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "any" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the growth of a company's cash flow statement items over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/cash_growth", - "id": "EQUITY.FUNDAMENTAL.CASH_GROWTH", - "name": "EQUITY.FUNDAMENTAL.CASH_GROWTH", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical dividend data for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/dividends", - "id": "EQUITY.FUNDAMENTAL.DIVIDENDS", - "name": "EQUITY.FUNDAMENTAL.DIVIDENDS", - "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, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: intrinio)", - "name": "limit", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical employee count data for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/employee_count", - "id": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT", - "name": "EQUITY.FUNDAMENTAL.EMPLOYEE_COUNT", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/filings", - "id": "EQUITY.FUNDAMENTAL.FILINGS", - "name": "EQUITY.FUNDAMENTAL.FILINGS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, intrinio, sec, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Type of the SEC filing form. (provider: sec)", - "name": "form_type", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)", - "name": "thea_enabled", - "optional": true, - "type": "boolean" - }, - { - "description": "Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)", - "name": "cik", - "optional": true, - "type": "any" - }, - { - "description": "Whether or not to use cache. If True, cache will store for one day. (provider: sec)", - "name": "use_cache", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the historical values of a data tag from Intrinio.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_attributes", - "id": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES", - "name": "EQUITY.FUNDAMENTAL.HISTORICAL_ATTRIBUTES", - "parameters": [ - { - "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 comma separated items allowed for provider(s): intrinio.", - "name": "tag", - "type": "string" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The frequency of the data.", - "name": "frequency", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Filter by type, when applicable.", - "name": "tag_type", - "optional": true, - "type": "string" - }, - { - "description": "Sort order.", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical earnings per share data for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_eps", - "id": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", - "name": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. (provider: fmp)", - "name": "limit", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical stock splits for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_splits", - "id": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", - "name": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the income statement for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income", - "id": "EQUITY.FUNDAMENTAL.INCOME", - "name": "EQUITY.FUNDAMENTAL.INCOME", - "parameters": [ - { - "description": "Symbol to get data for.", - "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, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", - "name": "fiscal_year", - "optional": true, - "type": "number" - }, - { - "description": "Filing date of the financial statement. (provider: polygon)", - "name": "filing_date", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than the given date. (provider: polygon)", - "name": "filing_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date less than or equal to the given date. (provider: polygon)", - "name": "filing_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than the given date. (provider: polygon)", - "name": "filing_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Filing date greater than or equal to the given date. (provider: polygon)", - "name": "filing_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date of the financial statement. (provider: polygon)", - "name": "period_of_report_date", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than the given date. (provider: polygon)", - "name": "period_of_report_date_lt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date less than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_lte", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than the given date. (provider: polygon)", - "name": "period_of_report_date_gt", - "optional": true, - "type": "string" - }, - { - "description": "Period of report date greater than or equal to the given date. (provider: polygon)", - "name": "period_of_report_date_gte", - "optional": true, - "type": "string" - }, - { - "description": "Whether to include the sources of the financial statement. (provider: polygon)", - "name": "include_sources", - "optional": true, - "type": "boolean" - }, - { - "description": "Order of the financial statement. (provider: polygon)", - "name": "order", - "optional": true, - "type": "string" - }, - { - "description": "Sort of the financial statement. (provider: polygon)", - "name": "sort", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the growth of a company's income statement items over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income_growth", - "id": "EQUITY.FUNDAMENTAL.INCOME_GROWTH", - "name": "EQUITY.FUNDAMENTAL.INCOME_GROWTH", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Time period of the data to return.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the latest value of a data tag from Intrinio.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/latest_attributes", - "id": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES", - "name": "EQUITY.FUNDAMENTAL.LATEST_ATTRIBUTES", - "parameters": [ - { - "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 comma separated items allowed for provider(s): intrinio.", - "name": "tag", - "type": "string" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get executive management team data for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management", - "id": "EQUITY.FUNDAMENTAL.MANAGEMENT", - "name": "EQUITY.FUNDAMENTAL.MANAGEMENT", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get executive management team compensation for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management_compensation", - "id": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION", - "name": "EQUITY.FUNDAMENTAL.MANAGEMENT_COMPENSATION", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "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": { - "dimensionality": "matrix" - } - }, - { - "description": "Get fundamental metrics for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/metrics", - "id": "EQUITY.FUNDAMENTAL.METRICS", - "name": "EQUITY.FUNDAMENTAL.METRICS", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "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, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include trailing twelve months (TTM) data. (provider: fmp)", - "name": "with_ttm", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get equity valuation multiples for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/multiples", - "id": "EQUITY.FUNDAMENTAL.MULTIPLES", - "name": "EQUITY.FUNDAMENTAL.MULTIPLES", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get company general business and stock data for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/overview", - "id": "EQUITY.FUNDAMENTAL.OVERVIEW", - "name": "EQUITY.FUNDAMENTAL.OVERVIEW", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get an extensive set of financial and accounting ratios for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/ratios", - "id": "EQUITY.FUNDAMENTAL.RATIOS", - "name": "EQUITY.FUNDAMENTAL.RATIOS", - "parameters": [ - { - "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, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include trailing twelve months (TTM) data. (provider: fmp)", - "name": "with_ttm", - "optional": true, - "type": "boolean" - }, - { - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", - "name": "fiscal_year", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get financial statements as reported by the company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/reported_financials", - "id": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS", - "name": "EQUITY.FUNDAMENTAL.REPORTED_FINANCIALS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Time period of the data to return.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "The type of financial statement - i.e, balance, income, cash.", - "name": "statement_type", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)", - "name": "fiscal_year", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the revenue geographic breakdown for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_geography", - "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", - "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Time period of the data to return.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "Structure of the returned data.", - "name": "structure", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the revenue breakdown by business segment for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_segment", - "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", - "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Time period of the data to return.", - "name": "period", - "optional": true, - "type": "string" - }, - { - "description": "Structure of the returned data.", - "name": "structure", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/search_attributes", - "id": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES", - "name": "EQUITY.FUNDAMENTAL.SEARCH_ATTRIBUTES", - "parameters": [ - { - "description": "Query to search for.", - "name": "query", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: intrinio, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get earnings call transcripts for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/transcript", - "id": "EQUITY.FUNDAMENTAL.TRANSCRIPT", - "name": "EQUITY.FUNDAMENTAL.TRANSCRIPT", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Year of the earnings call transcript.", - "name": "year", - "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/market_snapshots", - "id": "EQUITY.MARKET_SNAPSHOTS", - "name": "EQUITY.MARKET_SNAPSHOTS", - "parameters": [ - { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The market to fetch data for. (provider: fmp)", - "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": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data about trading by a company's management team and board of directors.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/insider_trading", - "id": "EQUITY.OWNERSHIP.INSIDER_TRADING", - "name": "EQUITY.OWNERSHIP.INSIDER_TRADING", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "The number of data entries to return.", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Type of the transaction. (provider: fmp)", - "name": "transactionType", - "optional": true, - "type": "any" - }, - { - "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Type of ownership. (provider: intrinio)", - "name": "ownership_type", - "optional": true, - "type": "string" - }, - { - "description": "Field to sort by. (provider: intrinio)", - "name": "sort_by", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data about institutional ownership for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/institutional", - "id": "EQUITY.OWNERSHIP.INSTITUTIONAL", - "name": "EQUITY.OWNERSHIP.INSTITUTIONAL", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Include current quarter data. (provider: fmp)", - "name": "include_current_quarter", - "optional": true, - "type": "boolean" - }, - { - "description": "A specific date to get data for. (provider: fmp)", - "name": "date", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data about major holders for a given company over time.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/major_holders", - "id": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", - "name": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "A specific date to get data for.", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Page number of the data to fetch.", - "name": "page", - "optional": true, - "type": "number" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get data about share float for a given company.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/share_statistics", - "id": "EQUITY.OWNERSHIP.SHARE_STATISTICS", - "name": "EQUITY.OWNERSHIP.SHARE_STATISTICS", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/historical", - "id": "EQUITY.PRICE.HISTORICAL", - "name": "EQUITY.PRICE.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 National Best Bid and Offer for a given stock.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/nbbo", - "id": "EQUITY.PRICE.NBBO", - "name": "EQUITY.PRICE.NBBO", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: polygon, defaults to polygon.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The number of data entries to return. Up to ten million records will be returned. Pagination occurs in groups of 50,000. Remaining limit values will always return 50,000 more records unless it is the last page. High volume tickers will require multiple max requests for a single day's NBBO records. Expect stocks, like SPY, to approach 1GB in size, per day, as a raw CSV. Splitting large requests into chunks is recommended for full-day requests of high-volume symbols. (provider: polygon)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon)", - "name": "timestamp", - "optional": true, - "type": "string" - }, - { - "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, '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. 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. 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" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get price performance data for a given stock. This includes price changes for different time periods.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/performance", - "id": "EQUITY.PRICE.PERFORMANCE", - "name": "EQUITY.PRICE.PERFORMANCE", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/quote", - "id": "EQUITY.PRICE.QUOTE", - "name": "EQUITY.PRICE.QUOTE", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Source of the data. (provider: intrinio)", - "name": "source", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get general information about a company. This includes company name, industry, sector and price data.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/profile", - "id": "EQUITY.PROFILE", - "name": "EQUITY.PROFILE", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Screen for companies meeting various criteria. These criteria include\nmarket cap, price, beta, volume, and dividend yield.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/screener", - "id": "EQUITY.SCREENER", - "name": "EQUITY.SCREENER", - "parameters": [ - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Filter by market cap greater than this value. (provider: fmp)", - "name": "mktcap_min", - "optional": true, - "type": "number" - }, - { - "description": "Filter by market cap less than this value. (provider: fmp)", - "name": "mktcap_max", - "optional": true, - "type": "number" - }, - { - "description": "Filter by price greater than this value. (provider: fmp)", - "name": "price_min", - "optional": true, - "type": "number" - }, - { - "description": "Filter by price less than this value. (provider: fmp)", - "name": "price_max", - "optional": true, - "type": "number" - }, - { - "description": "Filter by a beta greater than this value. (provider: fmp)", - "name": "beta_min", - "optional": true, - "type": "number" - }, - { - "description": "Filter by a beta less than this value. (provider: fmp)", - "name": "beta_max", - "optional": true, - "type": "number" - }, - { - "description": "Filter by volume greater than this value. (provider: fmp)", - "name": "volume_min", - "optional": true, - "type": "number" - }, - { - "description": "Filter by volume less than this value. (provider: fmp)", - "name": "volume_max", - "optional": true, - "type": "number" - }, - { - "description": "Filter by dividend amount greater than this value. (provider: fmp)", - "name": "dividend_min", - "optional": true, - "type": "number" - }, - { - "description": "Filter by dividend amount less than this value. (provider: fmp)", - "name": "dividend_max", - "optional": true, - "type": "number" - }, - { - "description": "If true, returns only ETFs. (provider: fmp)", - "name": "is_etf", - "optional": true, - "type": "boolean" - }, - { - "description": "If false, returns only inactive tickers. (provider: fmp)", - "name": "is_active", - "optional": true, - "type": "boolean" - }, - { - "description": "Filter by sector. (provider: fmp)", - "name": "sector", - "optional": true, - "type": "string" - }, - { - "description": "Filter by industry. (provider: fmp)", - "name": "industry", - "optional": true, - "type": "string" - }, - { - "description": "Filter by country, as a two-letter country code. (provider: fmp)", - "name": "country", - "optional": true, - "type": "string" - }, - { - "description": "Filter by exchange. (provider: fmp)", - "name": "exchange", - "optional": true, - "type": "string" - }, - { - "description": "Limit the number of results to return. (provider: fmp)", - "name": "limit", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for stock symbol, CIK, LEI, or company name.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/search", - "id": "EQUITY.SEARCH", - "name": "EQUITY.SEARCH", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Whether to search by ticker symbol.", - "name": "is_symbol", - "optional": true, - "type": "boolean" - }, - { - "description": "Whether to use the cache or not.", - "name": "use_cache", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: intrinio, sec, defaults to intrinio.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. (provider: intrinio)", - "name": "active", - "optional": true, - "type": "boolean" - }, - { - "description": "The number of data entries to return. (provider: intrinio)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Whether to direct the search to the list of mutual funds and ETFs. (provider: sec)", - "name": "is_fund", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get reported Fail-to-deliver (FTD) data.", - "helpUrl": "https://docs.openbb.co/excel/reference/equity/shorts/fails_to_deliver", - "id": "EQUITY.SHORTS.FAILS_TO_DELIVER", - "name": "EQUITY.SHORTS.FAILS_TO_DELIVER", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Limit the number of reports to parse, from most recent.\nApproximately 24 reports per year, going back to 2009.\n(provider: sec)", - "name": "limit", - "optional": true, - "type": "number" - }, - { - "description": "Skip N number of reports from current. A value of 1 will skip the most recent report.\n(provider: sec)", - "name": "skip_reports", - "optional": true, - "type": "number" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "ETF Country weighting.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/countries", - "id": "ETF.COUNTRIES", - "name": "ETF.COUNTRIES", - "parameters": [ - { - "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the exposure to ETFs for a specific stock.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/equity_exposure", - "id": "ETF.EQUITY_EXPOSURE", - "name": "ETF.EQUITY_EXPOSURE", - "parameters": [ - { - "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "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", - "id": "ETF.HOLDINGS", - "name": "ETF.HOLDINGS", - "parameters": [ - { - "description": "Symbol to get data for. (ETF)", - "name": "symbol", - "type": "string" - }, - { - "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)", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)", - "name": "cik", - "optional": true, - "type": "string" - }, - { - "description": "Whether or not to use cache for the request. (provider: sec)", - "name": "use_cache", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Use this function to get the holdings dates, if available.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings_date", - "id": "ETF.HOLDINGS_DATE", - "name": "ETF.HOLDINGS_DATE", - "parameters": [ - { - "description": "Symbol to get data for. (ETF)", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)", - "name": "cik", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Get the recent price performance of each ticker held in the ETF.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings_performance", - "id": "ETF.HOLDINGS_PERFORMANCE", - "name": "ETF.HOLDINGS_PERFORMANCE", - "parameters": [ - { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "ETF Information Overview.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/info", - "id": "ETF.INFO", - "name": "ETF.INFO", - "parameters": [ - { - "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "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 comma separated items allowed for provider(s): fmp, intrinio.", - "name": "symbol", - "type": "string" - }, - { - "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": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/search", - "id": "ETF.SEARCH", - "name": "ETF.SEARCH", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Options: fmp, intrinio, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "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" - }, - { - "description": "Whether the ETF is actively trading. (provider: fmp)", - "name": "is_active", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "ETF Sector weighting.", - "helpUrl": "https://docs.openbb.co/excel/reference/etf/sectors", - "id": "ETF.SECTORS", - "name": "ETF.SECTORS", - "parameters": [ - { - "description": "Symbol to get data for. (ETF)", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Commercial Paper.\n\nCommercial paper (CP) consists of short-term, promissory notes issued primarily by corporations.\nMaturities range up to 270 days but average about 30 days.\nMany companies use CP to raise cash needed for current transactions,\nand many find it to be a lower-cost alternative to bank loans.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/commercial_paper", - "id": "FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER", - "name": "FIXEDINCOME.CORPORATE.COMMERCIAL_PAPER", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The maturity.", - "name": "maturity", - "optional": true, - "type": "string" - }, - { - "description": "The category.", - "name": "category", - "optional": true, - "type": "string" - }, - { - "description": "The grade.", - "name": "grade", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "High Quality Market Corporate Bond.\n\nThe HQM yield curve represents the high quality corporate bond market, i.e.,\ncorporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.\nThese terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve\nthat is the market-weighted average (MWA) quality of high quality bonds.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/hqm", - "id": "FIXEDINCOME.CORPORATE.HQM", - "name": "FIXEDINCOME.CORPORATE.HQM", - "parameters": [ - { - "description": "A specific date to get data for.", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "The yield curve type.", - "name": "yield_curve", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "ICE BofA US Corporate Bond Indices.\n\nThe ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt\npublicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an\naverage of Moody\u2019s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year\nremaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount\noutstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/ice_bofa", - "id": "FIXEDINCOME.CORPORATE.ICE_BOFA", - "name": "FIXEDINCOME.CORPORATE.ICE_BOFA", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The type of series.", - "name": "index_type", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The type of category. (provider: fred)", - "name": "category", - "optional": true, - "type": "string" - }, - { - "description": "The type of area. (provider: fred)", - "name": "area", - "optional": true, - "type": "string" - }, - { - "description": "The type of grade. (provider: fred)", - "name": "grade", - "optional": true, - "type": "string" - }, - { - "description": "Whether to include options in the results. (provider: fred)", - "name": "options", - "optional": true, - "type": "boolean" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Moody Corporate Bond Index.\n\nMoody's Aaa and Baa are investment bonds that acts as an index of\nthe performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.\nThese corporate bonds often are used in macroeconomics as an alternative to the federal ten-year\nTreasury Bill as an indicator of the interest rate.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/moody", - "id": "FIXEDINCOME.CORPORATE.MOODY", - "name": "FIXEDINCOME.CORPORATE.MOODY", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "The type of series.", - "name": "index_type", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The type of spread. (provider: fred)", - "name": "spread", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Spot Rates.\n\nThe spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.\nThis is a zero coupon bond.\nBecause each spot rate pertains to a single cashflow, it is the relevant interest rate\nconcept for discounting a pension liability at the same maturity.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/corporate/spot_rates", - "id": "FIXEDINCOME.CORPORATE.SPOT_RATES", - "name": "FIXEDINCOME.CORPORATE.SPOT_RATES", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", - "name": "maturity", - "optional": true, - "type": "any" - }, - { - "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", - "name": "category", - "optional": true, - "type": "string" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/eu_yield_curve", - "id": "FIXEDINCOME.GOVERNMENT.EU_YIELD_CURVE", - "name": "FIXEDINCOME.GOVERNMENT.EU_YIELD_CURVE", - "parameters": [ - { - "description": "A specific date to get data for.", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Options: ecb, defaults to ecb.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", - "name": "rating", - "optional": true, - "type": "string" - }, - { - "description": "The yield curve type. (provider: ecb)", - "name": "yield_curve_type", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Government Treasury Rates.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/treasury_rates", - "id": "FIXEDINCOME.GOVERNMENT.TREASURY_RATES", - "name": "FIXEDINCOME.GOVERNMENT.TREASURY_RATES", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, - "type": "string" - }, - { - "description": "Options: federal_reserve, fmp, defaults to federal_reserve.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "US Yield Curve. Get United States yield curve.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/government/us_yield_curve", - "id": "FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE", - "name": "FIXEDINCOME.GOVERNMENT.US_YIELD_CURVE", - "parameters": [ - { - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", - "name": "date", - "optional": true, - "type": "string" - }, - { - "description": "Get inflation adjusted rates.", - "name": "inflation_adjusted", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/ameribor", - "id": "FIXEDINCOME.RATE.AMERIBOR", - "name": "FIXEDINCOME.RATE.AMERIBOR", - "parameters": [ - { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Symbol to get data for.", + "name": "symbol", "optional": true, "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "Filter by form type. Check the data provider for available types.", + "name": "form_type", "optional": true, "type": "string" }, { - "description": "Period of AMERIBOR rate. (provider: fred)", - "name": "parameter", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" } ], "result": { @@ -3930,33 +452,36 @@ } }, { - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/dpcredit", - "id": "FIXEDINCOME.RATE.DPCREDIT", - "name": "FIXEDINCOME.RATE.DPCREDIT", + "description": "Get historical earnings per share data for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_eps", + "id": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", + "name": "EQUITY.FUNDAMENTAL.HISTORICAL_EPS", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" - }, + "type": "number" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Get historical stock splits for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/historical_splits", + "id": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", + "name": "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS", + "parameters": [ { - "description": "FRED series ID of DWPCR data. (provider: fred)", - "name": "parameter", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" } ], @@ -3965,33 +490,42 @@ } }, { - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/ecb", - "id": "FIXEDINCOME.RATE.ECB", - "name": "FIXEDINCOME.RATE.ECB", + "description": "Get the income statement for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/income", + "id": "EQUITY.FUNDAMENTAL.INCOME", + "name": "EQUITY.FUNDAMENTAL.INCOME", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "The type of interest rate.", - "name": "interest_rate_type", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" - }, + "type": "number" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Get executive management team data for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/management", + "id": "EQUITY.FUNDAMENTAL.MANAGEMENT", + "name": "EQUITY.FUNDAMENTAL.MANAGEMENT", + "parameters": [ { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" } ], @@ -4000,34 +534,33 @@ } }, { - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/effr", - "id": "FIXEDINCOME.RATE.EFFR", - "name": "FIXEDINCOME.RATE.EFFR", + "description": "Get fundamental metrics for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/metrics", + "id": "EQUITY.FUNDAMENTAL.METRICS", + "name": "EQUITY.FUNDAMENTAL.METRICS", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Options: federal_reserve, fred, defaults to federal_reserve.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" }, { - "description": "Period of FED rate. (provider: fred)", - "name": "parameter", + "description": "Include trailing twelve months (TTM) data.", + "name": "with_ttm", "optional": true, - "type": "string" + "type": "boolean" } ], "result": { @@ -4035,22 +568,15 @@ } }, { - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/effr_forecast", - "id": "FIXEDINCOME.RATE.EFFR_FORECAST", - "name": "FIXEDINCOME.RATE.EFFR_FORECAST", + "description": "Get company general business and stock data for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/overview", + "id": "EQUITY.FUNDAMENTAL.OVERVIEW", + "name": "EQUITY.FUNDAMENTAL.OVERVIEW", "parameters": [ { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" - }, - { - "description": "Flag to show long run projections (provider: fred)", - "name": "long_run", - "optional": true, - "type": "boolean" } ], "result": { @@ -4058,34 +584,33 @@ } }, { - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/estr", - "id": "FIXEDINCOME.RATE.ESTR", - "name": "FIXEDINCOME.RATE.ESTR", + "description": "Get an extensive set of financial and accounting ratios for a given company over time.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/ratios", + "id": "EQUITY.FUNDAMENTAL.RATIOS", + "name": "EQUITY.FUNDAMENTAL.RATIOS", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" }, { - "description": "Period of ESTR rate. (provider: fred)", - "name": "parameter", + "description": "Include trailing twelve months (TTM) data.", + "name": "with_ttm", "optional": true, - "type": "string" + "type": "boolean" } ], "result": { @@ -4093,26 +618,25 @@ } }, { - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/iorb", - "id": "FIXEDINCOME.RATE.IORB", - "name": "FIXEDINCOME.RATE.IORB", + "description": "Get the revenue geographic breakdown for a given company over time.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_geography", + "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", + "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "Structure of the returned data.", + "name": "structure", "optional": true, "type": "string" } @@ -4122,32 +646,25 @@ } }, { - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/rate/sonia", - "id": "FIXEDINCOME.RATE.SONIA", - "name": "FIXEDINCOME.RATE.SONIA", + "description": "Get the revenue breakdown by business segment for a given company over time.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/revenue_per_segment", + "id": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", + "name": "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "Time period of the data to return.", + "name": "period", "optional": true, "type": "string" }, { - "description": "Period of SONIA rate. (provider: fred)", - "name": "parameter", + "description": "Structure of the returned data.", + "name": "structure", "optional": true, "type": "string" } @@ -4157,32 +674,46 @@ } }, { - "description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/sofr", - "id": "FIXEDINCOME.SOFR", - "name": "FIXEDINCOME.SOFR", + "description": "Get earnings call transcripts for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/fundamental/transcript", + "id": "EQUITY.FUNDAMENTAL.TRANSCRIPT", + "name": "EQUITY.FUNDAMENTAL.TRANSCRIPT", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, + "description": "Year of the earnings call transcript.", + "name": "year", + "type": "number" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Get data about trading by a company's management team and board of directors.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/insider_trading", + "id": "EQUITY.OWNERSHIP.INSIDER_TRADING", + "name": "EQUITY.OWNERSHIP.INSIDER_TRADING", + "parameters": [ + { + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "The number of data entries to return.", + "name": "limit", "optional": true, - "type": "string" + "type": "number" }, { - "description": "Period of SOFR rate. (provider: fred)", - "name": "period", + "description": "Type of the transaction. Options: award, conversion, return, expire_short, in_kind, gift, expire_long, discretionary, other, small, exempt, otm, purchase, sale, tender, will, itm, trust.", + "name": "transactionType", "optional": true, "type": "string" } @@ -4192,32 +723,25 @@ } }, { - "description": "Treasury Constant Maturity.\n\nGet data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/tcm", - "id": "FIXEDINCOME.SPREADS.TCM", - "name": "FIXEDINCOME.SPREADS.TCM", + "description": "Get data about institutional ownership for a given company over time.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/institutional", + "id": "EQUITY.OWNERSHIP.INSTITUTIONAL", + "name": "EQUITY.OWNERSHIP.INSTITUTIONAL", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, - "type": "string" - }, - { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "The maturity", - "name": "maturity", + "description": "Include current quarter data.", + "name": "include_current_quarter", "optional": true, - "type": "string" + "type": "boolean" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "A specific date to get data for.", + "name": "date", "optional": true, "type": "string" } @@ -4227,33 +751,42 @@ } }, { - "description": "Select Treasury Constant Maturity.\n\nGet data for Selected Treasury Constant Maturity Minus Federal Funds Rate\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of auctioned U.S.\nTreasuries. The value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/tcm_effr", - "id": "FIXEDINCOME.SPREADS.TCM_EFFR", - "name": "FIXEDINCOME.SPREADS.TCM_EFFR", + "description": "Get data about major holders for a given company over time.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/major_holders", + "id": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", + "name": "EQUITY.OWNERSHIP.MAJOR_HOLDERS", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "A specific date to get data for.", + "name": "date", "optional": true, "type": "string" }, { - "description": "The maturity", - "name": "maturity", + "description": "Page number of the data to fetch.", + "name": "page", "optional": true, - "type": "string" - }, + "type": "number" + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Get data about share float for a given company.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/ownership/share_statistics", + "id": "EQUITY.OWNERSHIP.SHARE_STATISTICS", + "name": "EQUITY.OWNERSHIP.SHARE_STATISTICS", + "parameters": [ { - "description": "Options: fred, defaults to fred.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for.", + "name": "symbol", "type": "string" } ], @@ -4262,32 +795,31 @@ } }, { - "description": "Select Treasury Bill.\n\nGet Selected Treasury Bill Minus Federal Funds Rate.\nConstant maturity is the theoretical value of a U.S. Treasury that is based on recent values of\nauctioned U.S. Treasuries.\nThe value is obtained by the U.S. Treasury on a daily basis through interpolation of the Treasury\nyield curve which, in turn, is based on closing bid-yields of actively-traded Treasury securities.", - "helpUrl": "https://docs.openbb.co/excel/reference/fixedincome/spreads/treasury_effr", - "id": "FIXEDINCOME.SPREADS.TREASURY_EFFR", - "name": "FIXEDINCOME.SPREADS.TREASURY_EFFR", + "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/historical", + "id": "EQUITY.PRICE.HISTORICAL", + "name": "EQUITY.PRICE.HISTORICAL", "parameters": [ { - "description": "Start date of the data, in YYYY-MM-DD format.", - "name": "start_date", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "type": "string" }, { - "description": "End date of the data, in YYYY-MM-DD format.", - "name": "end_date", + "description": "Time interval of the data to return. Options: 1m, 5m, 15m, 30m, 1h, 4h or 1d.", + "name": "interval", "optional": true, "type": "string" }, { - "description": "The maturity", - "name": "maturity", + "description": "Start date of the data, in YYYY-MM-DD format.", + "name": "start_date", "optional": true, "type": "string" }, { - "description": "Options: fred, defaults to fred.", - "name": "provider", + "description": "End date of the data, in YYYY-MM-DD format.", + "name": "end_date", "optional": true, "type": "string" } @@ -4297,15 +829,14 @@ } }, { - "description": "All indices available from a given provider.", - "helpUrl": "https://docs.openbb.co/excel/reference/index/available", - "id": "INDEX.AVAILABLE", - "name": "INDEX.AVAILABLE", + "description": "Get price performance data for a given stock. This includes price changes for different time periods.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/performance", + "id": "EQUITY.PRICE.PERFORMANCE", + "name": "EQUITY.PRICE.PERFORMANCE", "parameters": [ { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, + "description": "Symbol to get data for. Multiple comma separated items allowed.", + "name": "symbol", "type": "string" } ], @@ -4314,21 +845,15 @@ } }, { - "description": "Index Constituents.", - "helpUrl": "https://docs.openbb.co/excel/reference/index/constituents", - "id": "INDEX.CONSTITUENTS", - "name": "INDEX.CONSTITUENTS", + "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/price/quote", + "id": "EQUITY.PRICE.QUOTE", + "name": "EQUITY.PRICE.QUOTE", "parameters": [ { - "description": "Symbol to get data for.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" - }, - { - "description": "Options: fmp, defaults to fmp.", - "name": "provider", - "optional": true, - "type": "string" } ], "result": { @@ -4336,50 +861,52 @@ } }, { - "description": "Historical Market Indices.", - "helpUrl": "https://docs.openbb.co/excel/reference/index/market", - "id": "INDEX.MARKET", - "name": "INDEX.MARKET", + "description": "Get general information about a company. This includes company name, industry, sector and price data.", + "helpUrl": "https://docs.openbb.co/excel/reference/equity/profile", + "id": "EQUITY.PROFILE", + "name": "EQUITY.PROFILE", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "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" - }, + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "Get the holdings for an individual ETF.", + "helpUrl": "https://docs.openbb.co/excel/reference/etf/holdings", + "id": "ETF.HOLDINGS", + "name": "ETF.HOLDINGS", + "parameters": [ { - "description": "Time interval of the data to return.", - "name": "interval", - "optional": true, + "description": "Symbol to get data for. (ETF)", + "name": "symbol", "type": "string" }, { - "description": "Options: fmp, intrinio, polygon, defaults to fmp.", - "name": "provider", + "description": "A specific date to get data for.", + "name": "date", "optional": true, "type": "string" - }, - { - "description": "The number of data entries to return. (provider: intrinio, polygon)", - "name": "limit", - "optional": true, - "type": "number" - }, + } + ], + "result": { + "dimensionality": "matrix" + } + }, + { + "description": "ETF Information Overview.", + "helpUrl": "https://docs.openbb.co/excel/reference/etf/info", + "id": "ETF.INFO", + "name": "ETF.INFO", + "parameters": [ { - "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, + "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed.", + "name": "symbol", "type": "string" } ], @@ -4388,13 +915,13 @@ } }, { - "description": "Historical Index Levels.", - "helpUrl": "https://docs.openbb.co/excel/reference/index/price/historical", - "id": "INDEX.PRICE.HISTORICAL", - "name": "INDEX.PRICE.HISTORICAL", + "description": "Get Historical Market Indices.", + "helpUrl": "https://docs.openbb.co/excel/reference/index/market", + "id": "INDEX.MARKET", + "name": "INDEX.MARKET", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "type": "string" }, @@ -4415,24 +942,6 @@ "name": "interval", "optional": true, "type": "string" - }, - { - "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 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": { @@ -4446,7 +955,7 @@ "name": "NEWS.COMPANY", "parameters": [ { - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon.", + "description": "Symbol to get data for. Multiple comma separated items allowed.", "name": "symbol", "optional": true, "type": "string" @@ -4470,88 +979,70 @@ "type": "number" }, { - "description": "Options: benzinga, fmp, intrinio, polygon, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "A specific date to get data for. (provider: benzinga)", + "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { - "description": "Number of seconds since the news was updated. (provider: benzinga)", + "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { - "description": "Number of seconds since the news was published. (provider: benzinga)", + "description": "Number of seconds since the news was published.", "name": "published_since", "optional": true, "type": "number" }, { - "description": "Key to sort the news by. (provider: benzinga)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "Order to sort the news by. (provider: benzinga);\nSort order of the articles. (provider: polygon)", + "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { - "description": "The company's ISIN. (provider: benzinga)", + "description": "The company's ISIN.", "name": "isin", "optional": true, "type": "string" }, { - "description": "The company's CUSIP. (provider: benzinga)", + "description": "The company's CUSIP.", "name": "cusip", "optional": true, "type": "string" }, { - "description": "Channels of the news to retrieve. (provider: benzinga)", + "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { - "description": "Topics of the news to retrieve. (provider: benzinga)", + "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { - "description": "Authors of the news to retrieve. (provider: benzinga)", + "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { - "description": "Content types of the news to retrieve. (provider: benzinga)", + "description": "Content types of the news to retrieve.", "name": "content_types", "optional": true, "type": "string" - }, - { - "description": "Page number of the results. Use in combination with limit. (provider: fmp)", - "name": "page", - "optional": true, - "type": "number" } ], "result": { @@ -4583,79 +1074,67 @@ "type": "string" }, { - "description": "Options: benzinga, fmp, intrinio, defaults to benzinga.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "A specific date to get data for. (provider: benzinga)", + "description": "A specific date to get data for.", "name": "date", "optional": true, "type": "string" }, { - "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", + "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). Options: headline, abstract, full.", "name": "display", "optional": true, "type": "string" }, { - "description": "Number of seconds since the news was updated. (provider: benzinga)", + "description": "Number of seconds since the news was updated.", "name": "updated_since", "optional": true, "type": "number" }, { - "description": "Number of seconds since the news was published. (provider: benzinga)", + "description": "Number of seconds since the news was published.", "name": "published_since", "optional": true, "type": "number" }, { - "description": "Key to sort the news by. (provider: benzinga)", - "name": "sort", - "optional": true, - "type": "string" - }, - { - "description": "Order to sort the news by. (provider: benzinga)", + "description": "Order to sort the news by. Options: asc, desc.", "name": "order", "optional": true, "type": "string" }, { - "description": "The ISIN of the news to retrieve. (provider: benzinga)", + "description": "The ISIN of the news to retrieve.", "name": "isin", "optional": true, "type": "string" }, { - "description": "The CUSIP of the news to retrieve. (provider: benzinga)", + "description": "The CUSIP of the news to retrieve.", "name": "cusip", "optional": true, "type": "string" }, { - "description": "Channels of the news to retrieve. (provider: benzinga)", + "description": "Channels of the news to retrieve.", "name": "channels", "optional": true, "type": "string" }, { - "description": "Topics of the news to retrieve. (provider: benzinga)", + "description": "Topics of the news to retrieve.", "name": "topics", "optional": true, "type": "string" }, { - "description": "Authors of the news to retrieve. (provider: benzinga)", + "description": "Authors of the news to retrieve.", "name": "authors", "optional": true, "type": "string" }, { - "description": "Content types of the news to retrieve. (provider: benzinga)", + "description": "Content types of the news to retrieve.", "name": "content_types", "optional": true, "type": "string" @@ -4664,166 +1143,6 @@ "result": { "dimensionality": "matrix" } - }, - { - "description": "Map a ticker symbol to a CIK number.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/cik_map", - "id": "REGULATORS.SEC.CIK_MAP", - "name": "REGULATORS.SEC.CIK_MAP", - "parameters": [ - { - "description": "Symbol to get data for.", - "name": "symbol", - "type": "string" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/institutions_search", - "id": "REGULATORS.SEC.INSTITUTIONS_SEARCH", - "name": "REGULATORS.SEC.INSTITUTIONS_SEARCH", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "name": "use_cache", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/rss_litigation", - "id": "REGULATORS.SEC.RSS_LITIGATION", - "name": "REGULATORS.SEC.RSS_LITIGATION", - "parameters": [ - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "A tool for navigating the directory of SEC XML schema files by year.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/schema_files", - "id": "REGULATORS.SEC.SCHEMA_FILES", - "name": "REGULATORS.SEC.SCHEMA_FILES", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "name": "use_cache", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - }, - { - "description": "Enter an optional URL path to fetch the next level. (provider: sec)", - "name": "url", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/sic_search", - "id": "REGULATORS.SEC.SIC_SEARCH", - "name": "REGULATORS.SEC.SIC_SEARCH", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "optional": true, - "type": "string" - }, - { - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "name": "use_cache", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } - }, - { - "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", - "helpUrl": "https://docs.openbb.co/excel/reference/regulators/sec/symbol_map", - "id": "REGULATORS.SEC.SYMBOL_MAP", - "name": "REGULATORS.SEC.SYMBOL_MAP", - "parameters": [ - { - "description": "Search query.", - "name": "query", - "type": "string" - }, - { - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "name": "use_cache", - "optional": true, - "type": "boolean" - }, - { - "description": "Options: sec, defaults to sec.", - "name": "provider", - "optional": true, - "type": "string" - } - ], - "result": { - "dimensionality": "matrix" - } } ] } \ No newline at end of file diff --git a/website/content/excel/openapi.json b/website/content/excel/openapi.json index 7185ffd852e8..b5ad0664e11f 100644 --- a/website/content/excel/openapi.json +++ b/website/content/excel/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "OpenBB Platform API", - "description": "This is the OpenBB Platform API.", + "description": "Investment research for everyone, anywhere.", "termsOfService": "http://example.com/terms/", "contact": { "name": "OpenBB Team", @@ -13,7 +13,7 @@ "name": "MIT", "url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/LICENSE" }, - "version": "4.1.6" + "version": "4.2.1" }, "paths": { "/api/v1/crypto/price/historical": { @@ -50,10 +50,12 @@ "schema": { "type": "string", "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" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -377,10 +379,12 @@ "schema": { "type": "string", "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" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -588,7 +592,7 @@ } }, { - "name": "symbol", + "name": "query", "in": "query", "required": false, "schema": { @@ -600,141 +604,257 @@ "type": "null" } ], - "title": "polygon", - "description": "Symbol of the pair to search. (provider: polygon)" + "description": "Query to search for currency pairs.", + "title": "Query" }, - "description": "Symbol of the pair to search. (provider: polygon)" + "description": "Query to search for currency pairs." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CurrencyPairs" + } + } + } }, - { - "name": "date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OpenBBErrorResponse" } - ], - "title": "polygon", - "description": "A specific date to get data for. (provider: polygon)" + } + } + }, + "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": "CurrencyPairs", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "fmp" }, - "description": "A specific date to get data for. (provider: polygon)" + "provider": "fmp" }, { - "name": "search", + "scope": "api", + "description": "Search for 'EUR' currency pair using 'intrinio' as provider.", + "parameters": { + "provider": "intrinio", + "query": "EUR" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "description": "Search for terms using 'polygon' as provider.", + "parameters": { + "provider": "polygon", + "query": "EUR" + }, + "provider": "polygon" + } + ] + } + }, + "/api/v1/currency/reference_rates": { + "get": { + "tags": [ + "currency" + ], + "summary": "Reference Rates", + "description": "Get current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", + "operationId": "currency_reference_rates", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } + "enum": [ + "ecb" ], - "title": "polygon", - "description": "Search for terms within the ticker and/or company name. (provider: polygon)", - "default": "" - }, - "description": "Search for terms within the ticker and/or company name. (provider: polygon)" + "const": "ecb", + "type": "string", + "default": "ecb", + "title": "Provider" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CurrencyReferenceRates" + } + } + } }, + "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": "CurrencyReferenceRates", + "examples": [ { - "name": "active", + "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, + "required": true, "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } + "enum": [ + "fmp", + "polygon" ], - "title": "polygon", - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)", - "default": true - }, - "description": "Specify if the tickers returned should be actively traded on the queried date. (provider: polygon)" + "type": "string", + "title": "Provider" + } }, { - "name": "order", + "name": "base", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "enum": [ - "asc", - "desc" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Order data by ascending or descending. (provider: polygon)", - "default": "asc" + "type": "string", + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon.", + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, + "default": "usd", + "title": "Base" }, - "description": "Order data by ascending or descending. (provider: polygon)" + "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon." }, { - "name": "sort", + "name": "quote_type", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "enum": [ - "ticker", - "name", - "market", - "locale", - "currency_symbol", - "currency_name", - "base_currency_symbol", - "base_currency_name", - "last_updated_utc", - "delisted_utc" - ], - "type": "string" - }, - { - "type": "null" - } + "enum": [ + "direct", + "indirect" ], - "title": "polygon", - "description": "Sort field used for ordering. (provider: polygon)", - "default": "" + "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": "Sort field used for ordering. (provider: polygon)" + "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": "limit", + "name": "counter_currencies", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer", - "exclusiveMinimum": 0 + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } }, { "type": "null" } ], - "title": "polygon", - "description": "The number of data entries to return. (provider: polygon)", - "default": 1000 + "description": "An optional list of counter currency symbols to filter for. None returns all.", + "title": "Counter Currencies" }, - "description": "The number of data entries to return. (provider: polygon)" + "description": "An optional list of counter currency symbols to filter for. None returns all." } ], "responses": { @@ -743,262 +863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_CurrencyPairs" - } - } - } - }, - "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": "CurrencyPairs", - "examples": [ - { - "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" - } - ] - } - }, - "/api/v1/currency/reference_rates": { - "get": { - "tags": [ - "currency" - ], - "summary": "Reference Rates", - "description": "Current, official, currency reference rates.\n\nForeign exchange reference rates are the exchange rates set by a major financial institution or regulatory body,\nserving as a benchmark for the value of currencies around the world.\nThese rates are used as a standard to facilitate international trade and financial transactions,\nensuring consistency and reliability in currency conversion.\nThey are typically updated on a daily basis and reflect the market conditions at a specific time.\nCentral banks and financial institutions often use these rates to guide their own exchange rates,\nimpacting global trade, loans, and investments.", - "operationId": "currency_reference_rates", - "security": [ - { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ - { - "name": "provider", - "in": "query", - "required": false, - "schema": { - "enum": [ - "ecb" - ], - "const": "ecb", - "type": "string", - "default": "ecb", - "title": "Provider" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_CurrencyReferenceRates" - } - } - } - }, - "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": "CurrencyReferenceRates", - "examples": [ - { - "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" + "$ref": "#/components/schemas/OBBject_CurrencySnapshots" } } } @@ -1324,10 +1189,10 @@ "schema": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -1345,10 +1210,10 @@ "schema": { "anyOf": [ { - "type": "number" + "type": "integer" }, { - "type": "integer" + "type": "number" }, { "type": "null" @@ -1438,6 +1303,7 @@ { "scope": "api", "parameters": { + "symbol": "TSLA", "provider": "intrinio" }, "provider": "intrinio" @@ -1460,7 +1326,7 @@ "economy" ], "summary": "Forecast", - "description": "Forecasted GDP Data.", + "description": "Get Forecasted GDP Data.", "operationId": "economy_gdp_forecast", "security": [ { @@ -1693,7 +1559,7 @@ "economy" ], "summary": "Nominal", - "description": "Nominal GDP Data.", + "description": "Get Nominal GDP Data.", "operationId": "economy_gdp_nominal", "security": [ { @@ -1900,7 +1766,7 @@ "economy" ], "summary": "Real", - "description": "Real GDP Data.", + "description": "Get Real GDP Data.", "operationId": "economy_gdp_real", "security": [ { @@ -2193,9 +2059,208 @@ ], "title": "tradingeconomics", "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)", - "multiple_items_allowed": [ - "tradingeconomics" - ] + "choices": [ + "afghanistan", + "albania", + "algeria", + "andorra", + "angola", + "antigua_and_barbuda", + "argentina", + "armenia", + "aruba", + "australia", + "austria", + "azerbaijan", + "bahamas", + "bahrain", + "bangladesh", + "barbados", + "belarus", + "belgium", + "belize", + "benin", + "bermuda", + "bhutan", + "bolivia", + "bosnia_and_herzegovina", + "botswana", + "brazil", + "brunei", + "bulgaria", + "burkina_faso", + "burundi", + "cambodia", + "cameroon", + "canada", + "cape_verde", + "cayman_islands", + "central_african_republic", + "chad", + "chile", + "china", + "colombia", + "comoros", + "congo", + "costa_rica", + "croatia", + "cuba", + "cyprus", + "czech_republic", + "denmark", + "djibouti", + "dominica", + "dominican_republic", + "east_timor", + "ecuador", + "egypt", + "el_salvador", + "equatorial_guinea", + "eritrea", + "estonia", + "ethiopia", + "euro_area", + "faroe_islands", + "fiji", + "finland", + "france", + "gabon", + "gambia", + "georgia", + "germany", + "ghana", + "greece", + "grenada", + "guatemala", + "guinea", + "guinea_bissau", + "guyana", + "haiti", + "honduras", + "hong_kong", + "hungary", + "iceland", + "india", + "indonesia", + "iran", + "iraq", + "ireland", + "isle_of_man", + "israel", + "italy", + "ivory_coast", + "jamaica", + "japan", + "jordan", + "kazakhstan", + "kenya", + "kiribati", + "kosovo", + "kuwait", + "kyrgyzstan", + "laos", + "latvia", + "lebanon", + "lesotho", + "liberia", + "libya", + "liechtenstein", + "lithuania", + "luxembourg", + "macao", + "madagascar", + "malawi", + "malaysia", + "maldives", + "mali", + "malta", + "mauritania", + "mauritius", + "mexico", + "moldova", + "monaco", + "mongolia", + "montenegro", + "morocco", + "mozambique", + "myanmar", + "namibia", + "nepal", + "netherlands", + "new_caledonia", + "new_zealand", + "nicaragua", + "niger", + "nigeria", + "north_korea", + "north_macedonia", + "norway", + "oman", + "pakistan", + "palestine", + "panama", + "papua_new_guinea", + "paraguay", + "peru", + "philippines", + "poland", + "portugal", + "puerto_rico", + "qatar", + "republic_of_the_congo", + "romania", + "russia", + "rwanda", + "samoa", + "sao_tome_and_principe", + "saudi_arabia", + "senegal", + "serbia", + "seychelles", + "sierra_leone", + "singapore", + "slovakia", + "slovenia", + "solomon_islands", + "somalia", + "south_africa", + "south_korea", + "south_sudan", + "spain", + "sri_lanka", + "sudan", + "suriname", + "swaziland", + "sweden", + "switzerland", + "syria", + "taiwan", + "tajikistan", + "tanzania", + "thailand", + "togo", + "tonga", + "trinidad_and_tobago", + "tunisia", + "turkey", + "turkmenistan", + "uganda", + "ukraine", + "united_arab_emirates", + "united_kingdom", + "united_states", + "uruguay", + "uzbekistan", + "vanuatu", + "venezuela", + "vietnam", + "yemen", + "zambia", + "zimbabwe" + ], + "tradingeconomics": { + "multiple_items_allowed": true + } }, "description": "Country of the event. Multiple comma separated items allowed. (provider: tradingeconomics)" }, @@ -2207,9 +2272,9 @@ "anyOf": [ { "enum": [ - "Low", - "Medium", - "High" + "low", + "medium", + "high" ], "type": "string" }, @@ -2218,7 +2283,12 @@ } ], "title": "tradingeconomics", - "description": "Importance of the event. (provider: tradingeconomics)" + "description": "Importance of the event. (provider: tradingeconomics)", + "choices": [ + "low", + "medium", + "high" + ] }, "description": "Importance of the event. (provider: tradingeconomics)" }, @@ -2230,7 +2300,7 @@ "anyOf": [ { "enum": [ - "interest rate", + "interest_rate", "inflation", "bonds", "consumer", @@ -2251,9 +2321,48 @@ } ], "title": "tradingeconomics", - "description": "Grouping of events (provider: tradingeconomics)" + "description": "Grouping of events. (provider: tradingeconomics)", + "choices": [ + "interest_rate", + "inflation", + "bonds", + "consumer", + "gdp", + "government", + "housing", + "labour", + "markets", + "money", + "prices", + "trade", + "business" + ] }, - "description": "Grouping of events (provider: tradingeconomics)" + "description": "Grouping of events. (provider: tradingeconomics)" + }, + { + "name": "calendar_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "tradingeconomics", + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)", + "tradingeconomics": { + "multiple_items_allowed": true + } + }, + "description": "Get events by TradingEconomics Calendar ID. Multiple comma separated items allowed. (provider: tradingeconomics)" } ], "responses": { @@ -2329,7 +2438,7 @@ "economy" ], "summary": "Cpi", - "description": "Consumer Price Index (CPI). Returns either the rescaled index value, or a rate of change (inflation).", + "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", "operationId": "economy_cpi", "security": [ { @@ -2409,9 +2518,9 @@ "united_kingdom", "united_states" ], - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "title": "Country" }, "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred." @@ -2575,7 +2684,7 @@ "economy" ], "summary": "Risk Premium", - "description": "Market Risk Premium by country.", + "description": "Get Market Risk Premium by country.", "operationId": "economy_risk_premium", "security": [ { @@ -2672,14 +2781,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "ecb" + "ecb", + "fred" ], - "const": "ecb", "type": "string", - "default": "ecb", "title": "Provider" } }, @@ -2725,25 +2833,121 @@ "in": "query", "required": false, "schema": { - "enum": [ - "brazil", - "canada", - "china", - "eu_ex_euro_area", - "eu_institutions", - "india", - "japan", - "russia", - "switzerland", - "united_kingdom", - "united_states", - "total", - null + "anyOf": [ + { + "enum": [ + "brazil", + "canada", + "china", + "eu_ex_euro_area", + "eu_institutions", + "india", + "japan", + "russia", + "switzerland", + "united_kingdom", + "united_states", + "total", + null + ] + }, + { + "enum": [ + "argentina", + "australia", + "austria", + "belgium", + "brazil", + "canada", + "chile", + "china", + "colombia", + "costa_rica", + "czechia", + "denmark", + "estonia", + "finland", + "france", + "germany", + "greece", + "hungary", + "iceland", + "india", + "indonesia", + "ireland", + "israel", + "italy", + "japan", + "korea", + "latvia", + "lithuania", + "luxembourg", + "mexico", + "netherlands", + "new_zealand", + "norway", + "poland", + "portugal", + "russia", + "saudi_arabia", + "slovak_republic", + "slovenia", + "south_africa", + "spain", + "sweden", + "switzerland", + "turkey", + "united_kingdom", + "united_states", + "g7", + "g20" + ], + "type": "string" + } ], - "title": "ecb", - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)" + "title": "ecb,fred", + "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)", + "choices": "argentina,australia,austria,belgium,brazil,canada,chile,china,colombia,costa_rica,czechia,denmark,estonia,finland,france,germany,greece,hungary,iceland,india,indonesia,ireland,israel,italy,japan,korea,latvia,lithuania,luxembourg,mexico,netherlands,new_zealand,norway,poland,portugal,russia,saudi_arabia,slovak_republic,slovenia,south_africa,spain,sweden,switzerland,turkey,united_kingdom,united_states,g7,g20" + }, + "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb);\n The country to get data. Enter as a 3-letter ISO country code, default is USA. (provider: fred)" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "fred", + "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)" + }, + "description": "Start date of the data, in YYYY-MM-DD format. (provider: fred)" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "fred", + "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)" }, - "description": "The country/region of the data. This parameter will override the 'report_type' parameter. (provider: ecb)" + "description": "End date of the data, in YYYY-MM-DD format. (provider: fred)" } ], "responses": { @@ -2793,6 +2997,21 @@ }, "model": "BalanceOfPayments", "examples": [ + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "provider": "fred", + "country": "brazil" + }, + "provider": "fred" + }, { "scope": "api", "parameters": { @@ -2826,7 +3045,7 @@ "economy" ], "summary": "Fred Search", - "description": "Search for FRED series or economic releases by ID or string.\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", + "description": "Search for FRED series or economic releases by ID or string.\n\nThis does not return the observation values, only the metadata.\nUse this function to find series IDs for `fred_series()`.", "operationId": "economy_fred_search", "security": [ { @@ -2892,10 +3111,10 @@ "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" }, { "type": "null" @@ -2949,11 +3168,18 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "frequency", - "units", - "seasonal_adjustment" + "anyOf": [ + { + "enum": [ + "frequency", + "units", + "seasonal_adjustment" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "Filter by an attribute. (provider: fred)" @@ -3124,9 +3350,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.", - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." @@ -3193,22 +3419,29 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "a", - "q", - "m", - "w", - "d", - "wef", - "weth", - "wew", - "wetu", - "wem", - "wesu", - "wesa", - "bwew", - "bwem" + "anyOf": [ + { + "enum": [ + "a", + "q", + "m", + "w", + "d", + "wef", + "weth", + "wew", + "wetu", + "wem", + "wesu", + "wesa", + "bwew", + "bwem" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n Frequency aggregation to convert high frequency data to lower frequency.\n None = No change\n a = Annual\n q = Quarterly\n m = Monthly\n w = Weekly\n d = Daily\n wef = Weekly, Ending Friday\n weth = Weekly, Ending Thursday\n wew = Weekly, Ending Wednesday\n wetu = Weekly, Ending Tuesday\n wem = Weekly, Ending Monday\n wesu = Weekly, Ending Sunday\n wesa = Weekly, Ending Saturday\n bwew = Biweekly, Ending Wednesday\n bwem = Biweekly, Ending Monday\n (provider: fred)" @@ -3220,11 +3453,18 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "avg", - "sum", - "eop" + "anyOf": [ + { + "enum": [ + "avg", + "sum", + "eop" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n A key that indicates the aggregation method used for frequency aggregation.\n This parameter has no affect if the frequency parameter is not set.\n avg = Average\n sum = Sum\n eop = End of Period\n (provider: fred)", @@ -3237,16 +3477,23 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "chg", - "ch1", - "pch", - "pc1", - "pca", - "cch", - "cca", - "log" + "anyOf": [ + { + "enum": [ + "chg", + "ch1", + "pch", + "pc1", + "pca", + "cch", + "cca", + "log" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fred", "description": "\n Transformation type\n None = No transformation\n chg = Change\n ch1 = Change from Year Ago\n pch = Percent Change\n pc1 = Percent Change from Year Ago\n pca = Compounded Annual Rate of Change\n cch = Continuously Compounded Rate of Change\n cca = Continuously Compounded Annual Rate of Change\n log = Natural Log\n (provider: fred)" @@ -3375,7 +3622,7 @@ "economy" ], "summary": "Money Measures", - "description": "Money Measures (M1/M2 and components). The Federal Reserve publishes as part of the H.6 Release.", + "description": "Get Money Measures (M1/M2 and components).\n\nThe Federal Reserve publishes as part of the H.6 Release.", "operationId": "economy_money_measures", "security": [ { @@ -3526,7 +3773,7 @@ "economy" ], "summary": "Unemployment", - "description": "Global unemployment data.", + "description": "Get global unemployment data.", "operationId": "economy_unemployment", "security": [ { @@ -3796,7 +4043,7 @@ "economy" ], "summary": "Composite Leading Indicator", - "description": "The composite leading indicator (CLI) is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", + "description": "Use the composite leading indicator (CLI).\n\nIt is designed to provide early signals of turning points\nin business cycles showing fluctuation of the economic activity around its long term potential level.\n\nCLIs show short-term economic movements in qualitative rather than quantitative terms.", "operationId": "economy_composite_leading_indicator", "security": [ { @@ -3962,7 +4209,7 @@ "economy" ], "summary": "Short Term Interest Rate", - "description": "Short-term interest rates are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", + "description": "Get Short-term interest rates.\n\nThey are the rates at which short-term borrowings are effected between\nfinancial institutions or the rate at which short-term government paper is issued or traded in the market.\n\nShort-term interest rates are generally averages of daily rates, measured as a percentage.\nShort-term interest rates are based on three-month money market rates where available.\nTypical standardised names are \"money market rate\" and \"treasury bill rate\".", "operationId": "economy_short_term_interest_rate", "security": [ { @@ -4172,7 +4419,7 @@ "economy" ], "summary": "Long Term Interest Rate", - "description": "Long-term interest rates refer to government bonds maturing in ten years.\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", + "description": "Get Long-term interest rates that refer to government bonds maturing in ten years.\n\nRates are mainly determined by the price charged by the lender, the risk from the borrower and the\nfall in the capital value. Long-term interest rates are generally averages of daily rates,\nmeasured as a percentage. These interest rates are implied by the prices at which the government bonds are\ntraded on financial markets, not the interest rates at which the loans were issued.\nIn all cases, they refer to bonds whose capital repayment is guaranteed by governments.\nLong-term interest rates are one of the determinants of business investment.\nLow long-term interest rates encourage investment in new equipment and high interest rates discourage it.\nInvestment is, in turn, a major source of economic growth.", "operationId": "economy_long_term_interest_rate", "security": [ { @@ -4382,7 +4629,7 @@ "economy" ], "summary": "Fred Regional", - "description": "Query the Geo Fred API for regional economic data by series group.\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", + "description": "Query the Geo Fred API for regional economic data by series group.\n\nThe series group ID is found by using `fred_search` and the `series_id` parameter.", "operationId": "economy_fred_regional", "security": [ { @@ -4701,14 +4948,14 @@ ] } }, - "/api/v1/equity/calendar/ipo": { + "/api/v1/economy/country_profile": { "get": { "tags": [ - "equity" + "economy" ], - "summary": "Ipo", - "description": "Get historical and upcoming initial public offerings (IPOs).", - "operationId": "equity_calendar_ipo", + "summary": "Country Profile", + "description": "Get a profile of country statistics and economic indicators.", + "operationId": "economy_country_profile", "security": [ { "OAuth2PasswordBearer": [] @@ -4721,147 +4968,51 @@ "required": false, "schema": { "enum": [ - "intrinio" + "econdb" ], - "const": "intrinio", + "const": "econdb", "type": "string", - "default": "intrinio", + "default": "econdb", "title": "Provider" } }, { - "name": "symbol", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Symbol to get data for.", - "title": "Symbol" - }, - "description": "Symbol to get data for." - }, - { - "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": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "The number of data entries to return.", - "default": 100, - "title": "Limit" - }, - "description": "The number of data entries to return." - }, - { - "name": "status", + "name": "country", "in": "query", - "required": false, + "required": true, "schema": { - "anyOf": [ - { - "enum": [ - "upcoming", - "priced", - "withdrawn" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)" + "type": "string", + "description": "The country to get data. Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Country" }, - "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)" + "description": "The country to get data. Multiple comma separated items allowed for provider(s): econdb." }, { - "name": "offer_amount_greater_than", + "name": "latest", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)" + "type": "boolean", + "title": "econdb", + "description": "If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb)", + "default": true }, - "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)" + "description": "If True, return only the latest data. If False, return all available data for each indicator. (provider: econdb)" }, { - "name": "offer_amount_less_than", + "name": "use_cache", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)" + "type": "boolean", + "title": "econdb", + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)", + "default": true }, - "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)" + "description": "If True, the request will be cached for one day.Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)" } ], "responses": { @@ -4870,7 +5021,569 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_CalendarIpo" + "$ref": "#/components/schemas/OBBject_CountryProfile" + } + } + } + }, + "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": "CountryProfile", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb", + "country": "united_kingdom" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Enter the country as the full name, or iso code. If `latest` is False, the complete history for each series is returned.", + "parameters": { + "country": "united_states,jp", + "latest": 0.0, + "provider": "econdb" + }, + "provider": "econdb" + } + ] + } + }, + "/api/v1/economy/available_indicators": { + "get": { + "tags": [ + "economy" + ], + "summary": "Available Indicators", + "description": "Get the available economic indicators for a provider.", + "operationId": "economy_available_indicators", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "econdb" + ], + "const": "econdb", + "type": "string", + "default": "econdb", + "title": "Provider" + } + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. (provider: econdb)", + "default": true + }, + "description": "Whether to use cache or not, by default is True The cache of indicator symbols will persist for one week. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_AvailableIndicators" + } + } + } + }, + "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": "AvailableIndicators", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb" + }, + "provider": "econdb" + } + ] + } + }, + "/api/v1/economy/indicators": { + "get": { + "tags": [ + "economy" + ], + "summary": "Indicators", + "description": "Get economic indicators by country and indicator.", + "operationId": "economy_indicators", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "econdb" + ], + "const": "econdb", + "type": "string", + "default": "econdb", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. The base symbol for the indicator (e.g. GDP, CPI, etc.). Multiple comma separated items allowed for provider(s): econdb." + }, + { + "name": "country", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb.", + "econdb": { + "multiple_items_allowed": true + }, + "title": "Country" + }, + "description": "The country to get data. The country represented by the indicator, if available. Multiple comma separated items allowed for provider(s): econdb." + }, + { + "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": "transform", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "toya", + "tpop", + "tusd", + "tpgp" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "econdb", + "description": "The transformation to apply to the data, default is None.\n\n tpop: Change from previous period\n toya: Change from one year ago\n tusd: Values as US dollars\n tpgp: Values as a percent of GDP\n\n Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results.\n This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities.\n `tusd` should only be used where values are currencies. (provider: econdb)" + }, + "description": "The transformation to apply to the data, default is None.\n\n tpop: Change from previous period\n toya: Change from one year ago\n tusd: Values as US dollars\n tpgp: Values as a percent of GDP\n\n Only 'tpop' and 'toya' are applicable to all indicators. Applying transformations across multiple indicators/countries may produce unexpected results.\n This is because not all indicators are compatible with all transformations, and the original units and scale differ between entities.\n `tusd` should only be used where values are currencies. (provider: econdb)" + }, + { + "name": "frequency", + "in": "query", + "required": false, + "schema": { + "enum": [ + "annual", + "quarter", + "month" + ], + "type": "string", + "title": "econdb", + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb)", + "default": "quarter" + }, + "description": "The frequency of the data, default is 'quarter'. Only valid when 'symbol' is 'main'. (provider: econdb)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "econdb", + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)", + "default": true + }, + "description": "If True, the request will be cached for one day. Using cache is recommended to avoid needlessly requesting the same data. (provider: econdb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_EconomicIndicators" + } + } + } + }, + "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": "EconomicIndicators", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "econdb", + "symbol": "PCOCO" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Enter the country as the full name, or iso code. Use `available_indicators()` to get a list of supported indicators from EconDB.", + "parameters": { + "symbol": "CPI", + "country": "united_states,jp", + "provider": "econdb" + }, + "provider": "econdb" + }, + { + "scope": "api", + "description": "Use the `main` symbol to get the group of main indicators for a country.", + "parameters": { + "provider": "econdb", + "symbol": "main", + "country": "eu" + }, + "provider": "econdb" + } + ] + } + }, + "/api/v1/equity/calendar/ipo": { + "get": { + "tags": [ + "equity" + ], + "summary": "Ipo", + "description": "Get historical and upcoming initial public offerings (IPOs).", + "operationId": "equity_calendar_ipo", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "intrinio" + ], + "const": "intrinio", + "type": "string", + "default": "intrinio", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for.", + "title": "Symbol" + }, + "description": "Symbol to get data for." + }, + { + "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": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The number of data entries to return.", + "default": 100, + "title": "Limit" + }, + "description": "The number of data entries to return." + }, + { + "name": "status", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "upcoming", + "priced", + "withdrawn" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)" + }, + "description": "Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio)" + }, + { + "name": "offer_amount_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)" + }, + "description": "Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio)" + }, + { + "name": "offer_amount_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)" + }, + "description": "Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CalendarIpo" } } } @@ -5419,14 +6132,14 @@ ] } }, - "/api/v1/equity/estimates/price_target": { + "/api/v1/equity/compare/company_facts": { "get": { "tags": [ "equity" ], - "summary": "Price Target", - "description": "Get analyst price targets by company.", - "operationId": "equity_estimates_price_target", + "summary": "Company Facts", + "description": "Copmare reported company facts and fundamental data points.", + "operationId": "equity_compare_company_facts", "security": [ { "OAuth2PasswordBearer": [] @@ -5436,13 +6149,14 @@ { "name": "provider", "in": "query", - "required": true, + "required": false, "schema": { "enum": [ - "benzinga", - "fmp" + "sec" ], + "const": "sec", "type": "string", + "default": "sec", "title": "Provider" } }, @@ -5459,17 +6173,223 @@ "type": "null" } ], - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", - "multiple_items_allowed": [ - "benzinga", - "fmp" - ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): sec.", + "sec": { + "multiple_items_allowed": true + }, "title": "Symbol" }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): sec." }, { - "name": "limit", + "name": "fact", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.", + "default": "", + "title": "Fact" + }, + "description": "The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider." + }, + { + "name": "year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)" + }, + "description": "The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec)" + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + "description": "The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + { + "name": "instantaneous", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "sec", + "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)", + "default": false + }, + "description": "Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data.\nThe function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "sec", + "description": "Whether to use cache for the request. Defaults to True. (provider: sec)", + "default": true + }, + "description": "Whether to use cache for the request. Defaults to True. (provider: sec)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_CompareCompanyFacts" + } + } + } + }, + "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": "CompareCompanyFacts", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "provider": "sec", + "fact": "PaymentsForRepurchaseOfCommonStock", + "year": 2023 + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "provider": "sec", + "symbol": "NVDA,AAPL,AMZN,MSFT,GOOG,SMCI", + "fact": "RevenueFromContractWithCustomerExcludingAssessedTax", + "year": 2024 + }, + "provider": "sec" + } + ] + } + }, + "/api/v1/equity/estimates/price_target": { + "get": { + "tags": [ + "equity" + ], + "summary": "Price Target", + "description": "Get analyst price targets by company.", + "operationId": "equity_estimates_price_target", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": true, + "schema": { + "enum": [ + "benzinga", + "fmp" + ], + "type": "string", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp.", + "benzinga": [ + "multiple_items_allowed" + ], + "fmp": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp." + }, + { + "name": "limit", "in": "query", "required": false, "schema": { @@ -5648,8 +6568,8 @@ ], "title": "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" + "benzinga": [ + "multiple_items_allowed" ] }, "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga)" @@ -5675,8 +6595,8 @@ ], "title": "benzinga", "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" + "benzinga": [ + "multiple_items_allowed" ] }, "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)" @@ -5702,8 +6622,8 @@ ], "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 comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" + "benzinga": [ + "multiple_items_allowed" ] }, "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)" @@ -5826,9 +6746,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -5943,30 +6863,57 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "fmp" + "fmp", + "intrinio" ], - "const": "fmp", "type": "string", - "default": "fmp", "title": "Provider" } }, { "name": "symbol", "in": "query", - "required": true, + "required": false, "schema": { - "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + }, + { + "name": "industry_group_number", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The Zacks industry group number. (provider: intrinio)" + }, + "description": "The Zacks industry group number. (provider: intrinio)" } ], "responses": { @@ -6069,9 +7016,9 @@ } ], "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga.", - "multiple_items_allowed": [ - "benzinga" - ], + "benzinga": { + "multiple_items_allowed": true + }, "title": "Analyst Name" }, "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga." @@ -6090,9 +7037,9 @@ } ], "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga.", - "multiple_items_allowed": [ - "benzinga" - ], + "benzinga": { + "multiple_items_allowed": true + }, "title": "Firm Name" }, "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga." @@ -6112,9 +7059,9 @@ ], "title": "benzinga", "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, @@ -6133,9 +7080,9 @@ ], "title": "benzinga", "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", - "multiple_items_allowed": [ - "benzinga" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, @@ -6192,9 +7139,9 @@ ], "title": "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" - ] + "benzinga": { + "multiple_items_allowed": true + } }, "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)" } @@ -6264,14 +7211,14 @@ ] } }, - "/api/v1/equity/discovery/filings": { + "/api/v1/equity/estimates/forward_sales": { "get": { "tags": [ "equity" ], - "summary": "Filings", - "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more. SEC\nfilings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", - "operationId": "equity_discovery_filings", + "summary": "Forward Sales", + "description": "Get forward sales estimates.", + "operationId": "equity_estimates_forward_sales", "security": [ { "OAuth2PasswordBearer": [] @@ -6284,99 +7231,119 @@ "required": false, "schema": { "enum": [ - "fmp" + "intrinio" ], - "const": "fmp", + "const": "intrinio", "type": "string", - "default": "fmp", + "default": "intrinio", "title": "Provider" } }, { - "name": "start_date", + "name": "symbol", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "description": "Start date of the data, in YYYY-MM-DD format.", - "title": "Start Date" + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" }, - "description": "Start date of the data, in YYYY-MM-DD format." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." }, { - "name": "end_date", + "name": "fiscal_year", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "integer" }, { "type": "null" } ], - "description": "End date of the data, in YYYY-MM-DD format.", - "title": "End Date" + "title": "intrinio", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, - "description": "End date of the data, in YYYY-MM-DD format." + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { - "name": "form_type", + "name": "fiscal_period", "in": "query", "required": false, "schema": { "anyOf": [ { + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], "type": "string" }, { "type": "null" } ], - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", - "title": "Form Type" + "title": "intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" }, - "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types." + "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" }, { - "name": "limit", + "name": "calendar_year", "in": "query", "required": false, "schema": { - "type": "integer", - "description": "The number of data entries to return.", - "default": 100, - "title": "Limit" + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, - "description": "The number of data entries to return." + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { - "name": "isDone", + "name": "calendar_period", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "enum": [ + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" }, { "type": "null" } ], - "title": "fmp", - "description": "Flag for whether or not the filing is done. (provider: fmp)" + "title": "intrinio", + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" }, - "description": "Flag for whether or not the filing is done. (provider: fmp)" + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" } ], "responses": { @@ -6385,7 +7352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_DiscoveryFilings" + "$ref": "#/components/schemas/OBBject_ForwardSalesEstimates" } } } @@ -6424,37 +7391,36 @@ } } }, - "model": "DiscoveryFilings", + "model": "ForwardSalesEstimates", "examples": [ { "scope": "api", "parameters": { - "provider": "fmp" + "symbol": "AAPL", + "provider": "intrinio" }, - "provider": "fmp" + "provider": "intrinio" }, { "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" + "fiscal_year": 2025, + "fiscal_period": "fy", + "provider": "intrinio" }, - "provider": "fmp" + "provider": "intrinio" } ] } }, - "/api/v1/equity/fundamental/multiples": { + "/api/v1/equity/estimates/forward_ebitda": { "get": { "tags": [ "equity" ], - "summary": "Multiples", - "description": "Get equity valuation multiples for a given company.", - "operationId": "equity_fundamental_multiples", + "summary": "Forward Ebitda", + "description": "Get forward EBITDA estimates.", + "operationId": "equity_estimates_forward_ebitda", "security": [ { "OAuth2PasswordBearer": [] @@ -6464,30 +7430,117 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "fmp" + "fmp", + "intrinio" ], - "const": "fmp", "type": "string", - "default": "fmp", "title": "Provider" } }, { "name": "symbol", "in": "query", - "required": true, + "required": false, "schema": { - "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." + }, + { + "name": "fiscal_period", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "annual", + "quarter" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "fmp,intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: fmp);\n Filter for only full-year or quarterly estimates. (provider: intrinio)", + "default": "annual" + }, + "description": "The future fiscal period to retrieve estimates for. (provider: fmp);\n Filter for only full-year or quarterly estimates. (provider: intrinio)" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "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. (provider: fmp)" + }, + { + "name": "include_historical", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "fmp", + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)", + "default": false + }, + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)" + }, + { + "name": "estimate_type", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "ebitda", + "ebit", + "enterprise_value", + "cash_flow_per_share", + "pretax_income" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Limit the EBITDA estimates to this type. (provider: intrinio)" + }, + "description": "Limit the EBITDA estimates to this type. (provider: intrinio)" } ], "responses": { @@ -6496,7 +7549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_EquityValuationMultiples" + "$ref": "#/components/schemas/OBBject_ForwardEbitdaEstimates" } } } @@ -6535,12 +7588,29 @@ } } }, - "model": "EquityValuationMultiples", + "model": "ForwardEbitdaEstimates", "examples": [ + { + "scope": "api", + "parameters": { + "provider": "intrinio" + }, + "provider": "intrinio" + }, { "scope": "api", "parameters": { "symbol": "AAPL", + "fiscal_period": "annual", + "provider": "intrinio" + }, + "provider": "intrinio" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL,MSFT", + "fiscal_period": "quarter", "provider": "fmp" }, "provider": "fmp" @@ -6548,14 +7618,14 @@ ] } }, - "/api/v1/equity/fundamental/balance": { + "/api/v1/equity/estimates/forward_eps": { "get": { "tags": [ "equity" ], - "summary": "Balance", - "description": "Get the balance sheet for a given company.", - "operationId": "equity_fundamental_balance", + "summary": "Forward Eps", + "description": "Get forward EPS estimates.", + "operationId": "equity_estimates_forward_eps", "security": [ { "OAuth2PasswordBearer": [] @@ -6569,8 +7639,7 @@ "schema": { "enum": [ "fmp", - "intrinio", - "polygon" + "intrinio" ], "type": "string", "title": "Provider" @@ -6579,298 +7648,138 @@ { "name": "symbol", "in": "query", - "required": true, - "schema": { - "type": "string", - "description": "Symbol to get data for.", - "title": "Symbol" - }, - "description": "Symbol to get data for." - }, - { - "name": "period", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Time period of the data to return.", - "default": "annual", - "title": "Period" - }, - "description": "Time period of the data to return." - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "type": "null" - } - ], - "description": "The number of data entries to return.", - "default": 5, - "title": "Limit" - }, - "description": "The number of data entries to return." - }, - { - "name": "fiscal_year", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" - }, - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" - }, - { - "name": "filing_date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Filing date of the financial statement. (provider: polygon)" - }, - "description": "Filing date of the financial statement. (provider: polygon)" - }, - { - "name": "filing_date_lt", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Filing date less than the given date. (provider: polygon)" - }, - "description": "Filing date less than the given date. (provider: polygon)" - }, - { - "name": "filing_date_lte", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Filing date less than or equal to the given date. (provider: polygon)" - }, - "description": "Filing date less than or equal to the given date. (provider: polygon)" - }, - { - "name": "filing_date_gt", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Filing date greater than the given date. (provider: polygon)" - }, - "description": "Filing date greater than the given date. (provider: polygon)" - }, - { - "name": "filing_date_gte", - "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "polygon", - "description": "Filing date greater than or equal to the given date. (provider: polygon)" + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" }, - "description": "Filing date greater than or equal to the given date. (provider: polygon)" + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." }, { - "name": "period_of_report_date", + "name": "fiscal_period", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "enum": [ + "annual", + "quarter" + ], + "type": "string" }, { - "type": "null" - } - ], - "title": "polygon", - "description": "Period of report date of the financial statement. (provider: polygon)" - }, - "description": "Period of report date of the financial statement. (provider: polygon)" - }, - { - "name": "period_of_report_date_lt", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" + "enum": [ + "fy", + "q1", + "q2", + "q3", + "q4" + ], + "type": "string" }, { "type": "null" } ], - "title": "polygon", - "description": "Period of report date less than the given date. (provider: polygon)" + "title": "fmp,intrinio", + "description": "The future fiscal period to retrieve estimates for. (provider: fmp, intrinio)", + "default": "annual" }, - "description": "Period of report date less than the given date. (provider: polygon)" + "description": "The future fiscal period to retrieve estimates for. (provider: fmp, intrinio)" }, { - "name": "period_of_report_date_lte", + "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "integer" }, { "type": "null" } ], - "title": "polygon", - "description": "Period of report date less than or equal to the given date. (provider: polygon)" + "title": "fmp", + "description": "The number of data entries to return. (provider: fmp)" }, - "description": "Period of report date less than or equal to the given date. (provider: polygon)" + "description": "The number of data entries to return. (provider: fmp)" }, { - "name": "period_of_report_date_gt", + "name": "include_historical", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "polygon", - "description": "Period of report date greater than the given date. (provider: polygon)" + "type": "boolean", + "title": "fmp", + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)", + "default": false }, - "description": "Period of report date greater than the given date. (provider: polygon)" + "description": "If True, the data will include all past data and the limit will be ignored. (provider: fmp)" }, { - "name": "period_of_report_date_gte", + "name": "fiscal_year", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "integer" }, { "type": "null" } ], - "title": "polygon", - "description": "Period of report date greater than or equal to the given date. (provider: polygon)" - }, - "description": "Period of report date greater than or equal to the given date. (provider: polygon)" - }, - { - "name": "include_sources", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "title": "polygon", - "description": "Whether to include the sources of the financial statement. (provider: polygon)", - "default": true + "title": "intrinio", + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, - "description": "Whether to include the sources of the financial statement. (provider: polygon)" + "description": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { - "name": "order", + "name": "calendar_year", "in": "query", "required": false, "schema": { "anyOf": [ { - "enum": [ - "asc", - "desc" - ], - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "polygon", - "description": "Order of the financial statement. (provider: polygon)" + "title": "intrinio", + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, - "description": "Order of the financial statement. (provider: polygon)" + "description": "The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { - "name": "sort", + "name": "calendar_period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ - "filing_date", - "period_of_report_date" + "q1", + "q2", + "q3", + "q4" ], "type": "string" }, @@ -6878,10 +7787,10 @@ "type": "null" } ], - "title": "polygon", - "description": "Sort of the financial statement. (provider: polygon)" + "title": "intrinio", + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" }, - "description": "Sort of the financial statement. (provider: polygon)" + "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" } ], "responses": { @@ -6890,7 +7799,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_BalanceSheet" + "$ref": "#/components/schemas/OBBject_ForwardEpsEstimates" } } } @@ -6929,22 +7838,21 @@ } } }, - "model": "BalanceSheet", + "model": "ForwardEpsEstimates", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", - "provider": "fmp" + "provider": "intrinio" }, - "provider": "fmp" + "provider": "intrinio" }, { "scope": "api", "parameters": { - "symbol": "AAPL", - "period": "annual", - "limit": 5, + "fiscal_year": 2025, + "fiscal_period": "fy", "provider": "intrinio" }, "provider": "intrinio" @@ -6952,14 +7860,14 @@ ] } }, - "/api/v1/equity/fundamental/balance_growth": { + "/api/v1/equity/estimates/forward_pe": { "get": { "tags": [ "equity" ], - "summary": "Balance Growth", - "description": "Get the growth of a company's balance sheet items over time.", - "operationId": "equity_fundamental_balance_growth", + "summary": "Forward Pe", + "description": "Get forward PE estimates.", + "operationId": "equity_estimates_forward_pe", "security": [ { "OAuth2PasswordBearer": [] @@ -6972,36 +7880,34 @@ "required": false, "schema": { "enum": [ - "fmp" + "intrinio" ], - "const": "fmp", + "const": "intrinio", "type": "string", - "default": "fmp", + "default": "intrinio", "title": "Provider" } }, { "name": "symbol", "in": "query", - "required": true, - "schema": { - "type": "string", - "description": "Symbol to get data for.", - "title": "Symbol" - }, - "description": "Symbol to get data for." - }, - { - "name": "limit", - "in": "query", "required": false, "schema": { - "type": "integer", - "description": "The number of data entries to return.", - "default": 10, - "title": "Limit" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", + "intrinio": { + "multiple_items_allowed": true + }, + "title": "Symbol" }, - "description": "The number of data entries to return." + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." } ], "responses": { @@ -7010,7 +7916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_BalanceSheetGrowth" + "$ref": "#/components/schemas/OBBject_ForwardPeEstimates" } } } @@ -7049,36 +7955,34 @@ } } }, - "model": "BalanceSheetGrowth", + "model": "ForwardPeEstimates", "examples": [ { "scope": "api", "parameters": { - "symbol": "AAPL", - "provider": "fmp" + "provider": "intrinio" }, - "provider": "fmp" + "provider": "intrinio" }, { "scope": "api", "parameters": { - "symbol": "AAPL", - "limit": 10, - "provider": "fmp" + "symbol": "AAPL,MSFT,GOOG", + "provider": "intrinio" }, - "provider": "fmp" + "provider": "intrinio" } ] } }, - "/api/v1/equity/fundamental/cash": { + "/api/v1/equity/discovery/filings": { "get": { "tags": [ "equity" ], - "summary": "Cash", - "description": "Get the cash flow statement for a given company.", - "operationId": "equity_fundamental_cash", + "summary": "Filings", + "description": "Get the URLs to SEC filings reported to EDGAR database, such as 10-K, 10-Q, 8-K, and more.\n\nSEC filings include Form 10-K, Form 10-Q, Form 8-K, the proxy statement, Forms 3, 4, and 5, Schedule 13, Form 114,\nForeign Investment Disclosures and others. The annual 10-K report is required to be\nfiled annually and includes the company's financial statements, management discussion and analysis,\nand audited financial statements.", + "operationId": "equity_discovery_filings", "security": [ { "OAuth2PasswordBearer": [] @@ -7088,103 +7992,387 @@ { "name": "provider", "in": "query", - "required": true, + "required": false, "schema": { "enum": [ - "fmp", - "intrinio", - "polygon" + "fmp" ], + "const": "fmp", "type": "string", + "default": "fmp", "title": "Provider" } }, { - "name": "symbol", - "in": "query", - "required": true, - "schema": { - "type": "string", - "description": "Symbol to get data for.", - "title": "Symbol" - }, - "description": "Symbol to get data for." - }, - { - "name": "period", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Time period of the data to return.", - "default": "annual", - "title": "Period" - }, - "description": "Time period of the data to return." - }, - { - "name": "limit", + "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer", - "minimum": 0 + "type": "string", + "format": "date" }, { "type": "null" } ], - "description": "The number of data entries to return.", - "default": 5, - "title": "Limit" + "description": "Start date of the data, in YYYY-MM-DD format.", + "title": "Start Date" }, - "description": "The number of data entries to return." + "description": "Start date of the data, in YYYY-MM-DD format." }, { - "name": "fiscal_year", + "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "intrinio", - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + "description": "End date of the data, in YYYY-MM-DD format.", + "title": "End Date" }, - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + "description": "End date of the data, in YYYY-MM-DD format." }, { - "name": "filing_date", + "name": "form_type", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "polygon", - "description": "Filing date of the financial statement. (provider: polygon)" + "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.", + "title": "Form Type" }, - "description": "Filing date of the financial statement. (provider: polygon)" + "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types." }, { - "name": "filing_date_lt", + "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [ + "type": "integer", + "description": "The number of data entries to return.", + "default": 100, + "title": "Limit" + }, + "description": "The number of data entries to return." + }, + { + "name": "isDone", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "fmp", + "description": "Flag for whether or not the filing is done. (provider: fmp)" + }, + "description": "Flag for whether or not the filing is done. (provider: fmp)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_DiscoveryFilings" + } + } + } + }, + "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": "DiscoveryFilings", + "examples": [ + { + "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" + } + ] + } + }, + "/api/v1/equity/fundamental/multiples": { + "get": { + "tags": [ + "equity" + ], + "summary": "Multiples", + "description": "Get equity valuation multiples for a given company.", + "operationId": "equity_fundamental_multiples", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp" + ], + "const": "fmp", + "type": "string", + "default": "fmp", + "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.", + "fmp": { + "multiple_items_allowed": true + }, + "title": "Symbol" + }, + "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_EquityValuationMultiples" + } + } + } + }, + "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": "EquityValuationMultiples", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/equity/fundamental/balance": { + "get": { + "tags": [ + "equity" + ], + "summary": "Balance", + "description": "Get the balance sheet for a given company.", + "operationId": "equity_fundamental_balance", + "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.", + "title": "Symbol" + }, + "description": "Symbol to get data for." + }, + { + "name": "period", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Time period of the data to return.", + "default": "annual", + "title": "Period" + }, + "description": "Time period of the data to return." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], + "description": "The number of data entries to return.", + "default": 5, + "title": "Limit" + }, + "description": "The number of data entries to return." + }, + { + "name": "fiscal_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + }, + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + }, + { + "name": "filing_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Filing date of the financial statement. (provider: polygon)" + }, + "description": "Filing date of the financial statement. (provider: polygon)" + }, + { + "name": "filing_date_lt", + "in": "query", + "required": false, + "schema": { + "anyOf": [ { "type": "string", "format": "date" @@ -7358,7 +8546,7 @@ "type": "boolean", "title": "polygon", "description": "Whether to include the sources of the financial statement. (provider: polygon)", - "default": false + "default": true }, "description": "Whether to include the sources of the financial statement. (provider: polygon)" }, @@ -7367,10 +8555,17 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "asc", - "desc" + "anyOf": [ + { + "enum": [ + "asc", + "desc" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "polygon", "description": "Order of the financial statement. (provider: polygon)" @@ -7382,10 +8577,17 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "filing_date", - "period_of_report_date" + "anyOf": [ + { + "enum": [ + "filing_date", + "period_of_report_date" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "polygon", "description": "Sort of the financial statement. (provider: polygon)" @@ -7399,7 +8601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_CashFlowStatement" + "$ref": "#/components/schemas/OBBject_BalanceSheet" } } } @@ -7438,7 +8640,7 @@ } } }, - "model": "CashFlowStatement", + "model": "BalanceSheet", "examples": [ { "scope": "api", @@ -7461,14 +8663,14 @@ ] } }, - "/api/v1/equity/fundamental/reported_financials": { + "/api/v1/equity/fundamental/balance_growth": { "get": { "tags": [ "equity" ], - "summary": "Reported Financials", - "description": "Get financial statements as reported by the company.", - "operationId": "equity_fundamental_reported_financials", + "summary": "Balance Growth", + "description": "Get the growth of a company's balance sheet items over time.", + "operationId": "equity_fundamental_balance_growth", "security": [ { "OAuth2PasswordBearer": [] @@ -7481,11 +8683,11 @@ "required": false, "schema": { "enum": [ - "intrinio" + "fmp" ], - "const": "intrinio", + "const": "fmp", "type": "string", - "default": "intrinio", + "default": "fmp", "title": "Provider" } }, @@ -7500,66 +8702,17 @@ }, "description": "Symbol to get data for." }, - { - "name": "period", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Time period of the data to return.", - "default": "annual", - "title": "Period" - }, - "description": "Time period of the data to return." - }, - { - "name": "statement_type", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The type of financial statement - i.e, balance, income, cash.", - "default": "balance", - "title": "Statement Type" - }, - "description": "The type of financial statement - i.e, balance, income, cash." - }, { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", - "default": 100, + "type": "integer", + "description": "The number of data entries to return.", + "default": 10, "title": "Limit" }, - "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks." - }, - { - "name": "fiscal_year", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "intrinio", - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" - }, - "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + "description": "The number of data entries to return." } ], "responses": { @@ -7568,7 +8721,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_ReportedFinancials" + "$ref": "#/components/schemas/OBBject_BalanceSheetGrowth" } } } @@ -7607,59 +8760,36 @@ } } }, - "model": "ReportedFinancials", + "model": "BalanceSheetGrowth", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", - "provider": "intrinio" + "provider": "fmp" }, - "provider": "intrinio" + "provider": "fmp" }, { "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": "fmp" }, - "provider": "intrinio" + "provider": "fmp" } ] } }, - "/api/v1/equity/fundamental/cash_growth": { + "/api/v1/equity/fundamental/cash": { "get": { "tags": [ "equity" ], - "summary": "Cash Growth", - "description": "Get the growth of a company's cash flow statement items over time.", - "operationId": "equity_fundamental_cash_growth", + "summary": "Cash", + "description": "Get the cash flow statement for a given company.", + "operationId": "equity_fundamental_cash", "security": [ { "OAuth2PasswordBearer": [] @@ -7669,14 +8799,14 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ - "fmp" + "fmp", + "intrinio", + "polygon" ], - "const": "fmp", "type": "string", - "default": "fmp", "title": "Provider" } }, @@ -7691,126 +8821,172 @@ }, "description": "Symbol to get data for." }, + { + "name": "period", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Time period of the data to return.", + "default": "annual", + "title": "Period" + }, + "description": "Time period of the data to return." + }, { "name": "limit", "in": "query", "required": false, "schema": { - "type": "integer", + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "The number of data entries to return.", - "default": 10, + "default": 5, "title": "Limit" }, "description": "The number of data entries to return." - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_CashFlowStatementGrowth" - } - } - } - }, - "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" + { + "name": "fiscal_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" } - } - } + ], + "title": "intrinio", + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + }, + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" + { + "name": "filing_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" } - } - } - } - }, - "model": "CashFlowStatementGrowth", - "examples": [ + ], + "title": "polygon", + "description": "Filing date of the financial statement. (provider: polygon)" + }, + "description": "Filing date of the financial statement. (provider: polygon)" + }, { - "scope": "api", - "parameters": { - "symbol": "AAPL", - "provider": "fmp" + "name": "filing_date_lt", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Filing date less than the given date. (provider: polygon)" }, - "provider": "fmp" + "description": "Filing date less than the given date. (provider: polygon)" }, { - "scope": "api", - "parameters": { - "symbol": "AAPL", - "limit": 10, - "provider": "fmp" + "name": "filing_date_lte", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Filing date less than or equal to the given date. (provider: polygon)" }, - "provider": "fmp" - } - ] - } - }, - "/api/v1/equity/fundamental/dividends": { - "get": { - "tags": [ - "equity" - ], - "summary": "Dividends", - "description": "Get historical dividend data for a given company.", - "operationId": "equity_fundamental_dividends", - "security": [ + "description": "Filing date less than or equal to the given date. (provider: polygon)" + }, { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ + "name": "filing_date_gt", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Filing date greater than the given date. (provider: polygon)" + }, + "description": "Filing date greater than the given date. (provider: polygon)" + }, { - "name": "provider", + "name": "filing_date_gte", "in": "query", - "required": true, + "required": false, "schema": { - "enum": [ - "fmp", - "intrinio" + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } ], - "type": "string", - "title": "Provider" - } + "title": "polygon", + "description": "Filing date greater than or equal to the given date. (provider: polygon)" + }, + "description": "Filing date greater than or equal to the given date. (provider: polygon)" }, { - "name": "symbol", + "name": "period_of_report_date", "in": "query", - "required": true, + "required": false, "schema": { - "type": "string", - "description": "Symbol to get data for.", - "title": "Symbol" + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Period of report date of the financial statement. (provider: polygon)" }, - "description": "Symbol to get data for." + "description": "Period of report date of the financial statement. (provider: polygon)" }, { - "name": "start_date", + "name": "period_of_report_date_lt", "in": "query", "required": false, "schema": { @@ -7823,13 +8999,13 @@ "type": "null" } ], - "description": "Start date of the data, in YYYY-MM-DD format.", - "title": "Start Date" + "title": "polygon", + "description": "Period of report date less than the given date. (provider: polygon)" }, - "description": "Start date of the data, in YYYY-MM-DD format." + "description": "Period of report date less than the given date. (provider: polygon)" }, { - "name": "end_date", + "name": "period_of_report_date_lte", "in": "query", "required": false, "schema": { @@ -7842,29 +9018,104 @@ "type": "null" } ], - "description": "End date of the data, in YYYY-MM-DD format.", - "title": "End Date" + "title": "polygon", + "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, - "description": "End date of the data, in YYYY-MM-DD format." + "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, { - "name": "limit", + "name": "period_of_report_date_gt", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "intrinio", - "description": "The number of data entries to return. (provider: intrinio)", - "default": 100 + "title": "polygon", + "description": "Period of report date greater than the given date. (provider: polygon)" }, - "description": "The number of data entries to return. (provider: intrinio)" + "description": "Period of report date greater than the given date. (provider: polygon)" + }, + { + "name": "period_of_report_date_gte", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Period of report date greater than or equal to the given date. (provider: polygon)" + }, + "description": "Period of report date greater than or equal to the given date. (provider: polygon)" + }, + { + "name": "include_sources", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "polygon", + "description": "Whether to include the sources of the financial statement. (provider: polygon)", + "default": false + }, + "description": "Whether to include the sources of the financial statement. (provider: polygon)" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "asc", + "desc" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Order of the financial statement. (provider: polygon)" + }, + "description": "Order of the financial statement. (provider: polygon)" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "filing_date", + "period_of_report_date" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "polygon", + "description": "Sort of the financial statement. (provider: polygon)" + }, + "description": "Sort of the financial statement. (provider: polygon)" } ], "responses": { @@ -7873,7 +9124,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_HistoricalDividends" + "$ref": "#/components/schemas/OBBject_CashFlowStatement" } } } @@ -7912,12 +9163,22 @@ } } }, - "model": "HistoricalDividends", + "model": "CashFlowStatement", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "period": "annual", + "limit": 5, "provider": "intrinio" }, "provider": "intrinio" @@ -7925,14 +9186,14 @@ ] } }, - "/api/v1/equity/fundamental/historical_eps": { + "/api/v1/equity/fundamental/reported_financials": { "get": { "tags": [ "equity" ], - "summary": "Historical Eps", - "description": "Get historical earnings per share data for a given company.", - "operationId": "equity_fundamental_historical_eps", + "summary": "Reported Financials", + "description": "Get financial statements as reported by the company.", + "operationId": "equity_fundamental_reported_financials", "security": [ { "OAuth2PasswordBearer": [] @@ -7945,11 +9206,11 @@ "required": false, "schema": { "enum": [ - "fmp" + "intrinio" ], - "const": "fmp", + "const": "intrinio", "type": "string", - "default": "fmp", + "default": "intrinio", "title": "Provider" } }, @@ -7964,6 +9225,30 @@ }, "description": "Symbol to get data for." }, + { + "name": "period", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Time period of the data to return.", + "default": "annual", + "title": "Period" + }, + "description": "Time period of the data to return." + }, + { + "name": "statement_type", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The type of financial statement - i.e, balance, income, cash.", + "default": "balance", + "title": "Statement Type" + }, + "description": "The type of financial statement - i.e, balance, income, cash." + }, { "name": "limit", "in": "query", @@ -7977,10 +9262,29 @@ "type": "null" } ], - "title": "fmp", - "description": "The number of data entries to return. (provider: fmp)" + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks.", + "default": 100, + "title": "Limit" }, - "description": "The number of data entries to return. (provider: fmp)" + "description": "The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks." + }, + { + "name": "fiscal_year", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" + }, + "description": "The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio)" } ], "responses": { @@ -7989,7 +9293,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_HistoricalEps" + "$ref": "#/components/schemas/OBBject_ReportedFinancials" } } } @@ -8028,27 +9332,59 @@ } } }, - "model": "HistoricalEps", + "model": "ReportedFinancials", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", - "provider": "fmp" + "provider": "intrinio" }, - "provider": "fmp" + "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" } ] } }, - "/api/v1/equity/fundamental/employee_count": { + "/api/v1/equity/fundamental/cash_growth": { "get": { "tags": [ "equity" ], - "summary": "Employee Count", - "description": "Get historical employee count data for a given company.", - "operationId": "equity_fundamental_employee_count", + "summary": "Cash Growth", + "description": "Get the growth of a company's cash flow statement items over time.", + "operationId": "equity_fundamental_cash_growth", "security": [ { "OAuth2PasswordBearer": [] @@ -8079,6 +9415,18 @@ "title": "Symbol" }, "description": "Symbol to get data for." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "description": "The number of data entries to return.", + "default": 10, + "title": "Limit" + }, + "description": "The number of data entries to return." } ], "responses": { @@ -8087,7 +9435,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_HistoricalEmployees" + "$ref": "#/components/schemas/OBBject_CashFlowStatementGrowth" } } } @@ -8126,7 +9474,7 @@ } } }, - "model": "HistoricalEmployees", + "model": "CashFlowStatementGrowth", "examples": [ { "scope": "api", @@ -8135,18 +9483,27 @@ "provider": "fmp" }, "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "limit": 10, + "provider": "fmp" + }, + "provider": "fmp" } ] } }, - "/api/v1/equity/fundamental/search_attributes": { + "/api/v1/equity/fundamental/dividends": { "get": { "tags": [ "equity" ], - "summary": "Search Attributes", - "description": "Search Intrinio data tags to search in latest or historical attributes.", - "operationId": "equity_fundamental_search_attributes", + "summary": "Dividends", + "description": "Get historical dividend data for a given company.", + "operationId": "equity_fundamental_dividends", "security": [ { "OAuth2PasswordBearer": [] @@ -8156,27 +9513,64 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ + "fmp", "intrinio" ], - "const": "intrinio", "type": "string", - "default": "intrinio", "title": "Provider" } }, { - "name": "query", + "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", - "description": "Query to search for.", - "title": "Query" + "description": "Symbol to get data for.", + "title": "Symbol" }, - "description": "Query to search for." + "description": "Symbol to get data for." + }, + { + "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": "limit", @@ -8191,11 +9585,11 @@ "type": "null" } ], - "description": "The number of data entries to return.", - "default": 1000, - "title": "Limit" + "title": "intrinio", + "description": "The number of data entries to return. (provider: intrinio)", + "default": 100 }, - "description": "The number of data entries to return." + "description": "The number of data entries to return. (provider: intrinio)" } ], "responses": { @@ -8204,7 +9598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_SearchAttributes" + "$ref": "#/components/schemas/OBBject_HistoricalDividends" } } } @@ -8243,12 +9637,12 @@ } } }, - "model": "SearchAttributes", + "model": "HistoricalDividends", "examples": [ { "scope": "api", "parameters": { - "query": "ebitda", + "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" @@ -8256,14 +9650,14 @@ ] } }, - "/api/v1/equity/fundamental/latest_attributes": { + "/api/v1/equity/fundamental/historical_eps": { "get": { "tags": [ "equity" ], - "summary": "Latest Attributes", - "description": "Get the latest value of a data tag from Intrinio.", - "operationId": "equity_fundamental_latest_attributes", + "summary": "Historical Eps", + "description": "Get historical earnings per share data for a given company.", + "operationId": "equity_fundamental_historical_eps", "security": [ { "OAuth2PasswordBearer": [] @@ -8276,11 +9670,11 @@ "required": false, "schema": { "enum": [ - "intrinio" + "fmp" ], - "const": "intrinio", + "const": "fmp", "type": "string", - "default": "intrinio", + "default": "fmp", "title": "Provider" } }, @@ -8290,10 +9684,341 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ + "description": "Symbol to get data for.", + "title": "Symbol" + }, + "description": "Symbol to get data for." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "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. (provider: fmp)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_HistoricalEps" + } + } + } + }, + "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": "HistoricalEps", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/equity/fundamental/employee_count": { + "get": { + "tags": [ + "equity" + ], + "summary": "Employee Count", + "description": "Get historical employee count data for a given company.", + "operationId": "equity_fundamental_employee_count", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp" + ], + "const": "fmp", + "type": "string", + "default": "fmp", + "title": "Provider" + } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for.", + "title": "Symbol" + }, + "description": "Symbol to get data for." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_HistoricalEmployees" + } + } + } + }, + "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": "HistoricalEmployees", + "examples": [ + { + "scope": "api", + "parameters": { + "symbol": "AAPL", + "provider": "fmp" + }, + "provider": "fmp" + } + ] + } + }, + "/api/v1/equity/fundamental/search_attributes": { + "get": { + "tags": [ + "equity" + ], + "summary": "Search Attributes", + "description": "Search Intrinio data tags to search in latest or historical attributes.", + "operationId": "equity_fundamental_search_attributes", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ "intrinio" ], + "const": "intrinio", + "type": "string", + "default": "intrinio", + "title": "Provider" + } + }, + { + "name": "query", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Query to search for.", + "title": "Query" + }, + "description": "Query to search for." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The number of data entries to return.", + "default": 1000, + "title": "Limit" + }, + "description": "The number of data entries to return." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_SearchAttributes" + } + } + } + }, + "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": "SearchAttributes", + "examples": [ + { + "scope": "api", + "parameters": { + "query": "ebitda", + "provider": "intrinio" + }, + "provider": "intrinio" + } + ] + } + }, + "/api/v1/equity/fundamental/latest_attributes": { + "get": { + "tags": [ + "equity" + ], + "summary": "Latest Attributes", + "description": "Get the latest value of a data tag from Intrinio.", + "operationId": "equity_fundamental_latest_attributes", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "intrinio" + ], + "const": "intrinio", + "type": "string", + "default": "intrinio", + "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): intrinio.", + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." @@ -8305,9 +10030,9 @@ "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." @@ -8407,9 +10132,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio." @@ -8421,9 +10146,9 @@ "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", - "multiple_items_allowed": [ - "intrinio" - ], + "intrinio": { + "multiple_items_allowed": true + }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." @@ -9192,10 +10917,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -9463,9 +11190,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -9680,9 +11407,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -10150,380 +11877,16 @@ "schema": { "anyOf": [ { - "enum": [ - "1", - "1-A", - "1-A POS", - "1-A-W", - "1-E", - "1-E AD", - "1-K", - "1-SA", - "1-U", - "1-Z", - "1-Z-W", - "10-12B", - "10-12G", - "10-D", - "10-K", - "10-KT", - "10-Q", - "10-QT", - "11-K", - "11-KT", - "13F-HR", - "13F-NT", - "13FCONP", - "144", - "15-12B", - "15-12G", - "15-15D", - "15F-12B", - "15F-12G", - "15F-15D", - "18-12B", - "18-K", - "19B-4E", - "2-A", - "2-AF", - "2-E", - "20-F", - "20FR12B", - "20FR12G", - "24F-2NT", - "25", - "25-NSE", - "253G1", - "253G2", - "253G3", - "253G4", - "3", - "305B2", - "34-12H", - "4", - "40-17F1", - "40-17F2", - "40-17G", - "40-17GCS", - "40-202A", - "40-203A", - "40-206A", - "40-24B2", - "40-33", - "40-6B", - "40-8B25", - "40-8F-2", - "40-APP", - "40-F", - "40-OIP", - "40FR12B", - "40FR12G", - "424A", - "424B1", - "424B2", - "424B3", - "424B4", - "424B5", - "424B7", - "424B8", - "424H", - "425", - "485APOS", - "485BPOS", - "485BXT", - "486APOS", - "486BPOS", - "486BXT", - "487", - "497", - "497AD", - "497H2", - "497J", - "497K", - "497VPI", - "497VPU", - "5", - "6-K", - "6B NTC", - "6B ORDR", - "8-A12B", - "8-A12G", - "8-K", - "8-K12B", - "8-K12G3", - "8-K15D5", - "8-M", - "8F-2 NTC", - "8F-2 ORDR", - "9-M", - "ABS-15G", - "ABS-EE", - "ADN-MTL", - "ADV-E", - "ADV-H-C", - "ADV-H-T", - "ADV-NR", - "ANNLRPT", - "APP NTC", - "APP ORDR", - "APP WD", - "APP WDG", - "ARS", - "ATS-N", - "ATS-N-C", - "ATS-N/UA", - "AW", - "AW WD", - "C", - "C-AR", - "C-AR-W", - "C-TR", - "C-TR-W", - "C-U", - "C-U-W", - "C-W", - "CB", - "CERT", - "CERTARCA", - "CERTBATS", - "CERTCBO", - "CERTNAS", - "CERTNYS", - "CERTPAC", - "CFPORTAL", - "CFPORTAL-W", - "CORRESP", - "CT ORDER", - "D", - "DEF 14A", - "DEF 14C", - "DEFA14A", - "DEFA14C", - "DEFC14A", - "DEFC14C", - "DEFM14A", - "DEFM14C", - "DEFN14A", - "DEFR14A", - "DEFR14C", - "DEL AM", - "DFAN14A", - "DFRN14A", - "DOS", - "DOSLTR", - "DRS", - "DRSLTR", - "DSTRBRPT", - "EFFECT", - "F-1", - "F-10", - "F-10EF", - "F-10POS", - "F-1MEF", - "F-3", - "F-3ASR", - "F-3D", - "F-3DPOS", - "F-3MEF", - "F-4", - "F-4 POS", - "F-4MEF", - "F-6", - "F-6 POS", - "F-6EF", - "F-7", - "F-7 POS", - "F-8", - "F-8 POS", - "F-80", - "F-80POS", - "F-9", - "F-9 POS", - "F-N", - "F-X", - "FOCUSN", - "FWP", - "G-405", - "G-405N", - "G-FIN", - "G-FINW", - "IRANNOTICE", - "MA", - "MA-A", - "MA-I", - "MA-W", - "MSD", - "MSDCO", - "MSDW", - "N-1", - "N-14", - "N-14 8C", - "N-14MEF", - "N-18F1", - "N-1A", - "N-2", - "N-2 POSASR", - "N-23C-2", - "N-23C3A", - "N-23C3B", - "N-23C3C", - "N-2ASR", - "N-2MEF", - "N-30B-2", - "N-30D", - "N-4", - "N-5", - "N-54A", - "N-54C", - "N-6", - "N-6F", - "N-8A", - "N-8B-2", - "N-8F", - "N-8F NTC", - "N-8F ORDR", - "N-CEN", - "N-CR", - "N-CSR", - "N-CSRS", - "N-MFP", - "N-MFP1", - "N-MFP2", - "N-PX", - "N-Q", - "N-VP", - "N-VPFS", - "NO ACT", - "NPORT-EX", - "NPORT-NP", - "NPORT-P", - "NRSRO-CE", - "NRSRO-UPD", - "NSAR-A", - "NSAR-AT", - "NSAR-B", - "NSAR-BT", - "NSAR-U", - "NT 10-D", - "NT 10-K", - "NT 10-Q", - "NT 11-K", - "NT 20-F", - "NT N-CEN", - "NT N-MFP", - "NT N-MFP1", - "NT N-MFP2", - "NT NPORT-EX", - "NT NPORT-P", - "NT-NCEN", - "NT-NCSR", - "NT-NSAR", - "NTFNCEN", - "NTFNCSR", - "NTFNSAR", - "NTN 10D", - "NTN 10K", - "NTN 10Q", - "NTN 20F", - "OIP NTC", - "OIP ORDR", - "POS 8C", - "POS AM", - "POS AMI", - "POS EX", - "POS462B", - "POS462C", - "POSASR", - "PRE 14A", - "PRE 14C", - "PREC14A", - "PREC14C", - "PREM14A", - "PREM14C", - "PREN14A", - "PRER14A", - "PRER14C", - "PRRN14A", - "PX14A6G", - "PX14A6N", - "QRTLYRPT", - "QUALIF", - "REG-NR", - "REVOKED", - "RW", - "RW WD", - "S-1", - "S-11", - "S-11MEF", - "S-1MEF", - "S-20", - "S-3", - "S-3ASR", - "S-3D", - "S-3DPOS", - "S-3MEF", - "S-4", - "S-4 POS", - "S-4EF", - "S-4MEF", - "S-6", - "S-8", - "S-8 POS", - "S-B", - "S-BMEF", - "SBSE", - "SBSE-A", - "SBSE-BD", - "SBSE-C", - "SBSE-W", - "SC 13D", - "SC 13E1", - "SC 13E3", - "SC 13G", - "SC 14D9", - "SC 14F1", - "SC 14N", - "SC TO-C", - "SC TO-I", - "SC TO-T", - "SC13E4F", - "SC14D1F", - "SC14D9C", - "SC14D9F", - "SD", - "SDR", - "SE", - "SEC ACTION", - "SEC STAFF ACTION", - "SEC STAFF LETTER", - "SF-1", - "SF-3", - "SL", - "SP 15D2", - "STOP ORDER", - "SUPPL", - "T-3", - "TA-1", - "TA-2", - "TA-W", - "TACO", - "TH", - "TTW", - "UNDER", - "UPLOAD", - "WDL-REQ", - "X-17A-5" - ], "type": "string" }, { "type": "null" } ], - "title": "sec", - "description": "Type of the SEC filing form. (provider: sec)" + "description": "Filter by form type. Check the data provider for available types.", + "title": "Form Type" }, - "description": "Type of the SEC filing form. (provider: sec)" + "description": "Filter by form type. Check the data provider for available types." }, { "name": "limit", @@ -11236,26 +12599,33 @@ "in": "query", "required": false, "schema": { - "enum": [ - null, - "award", - "conversion", - "return", - "expire_short", - "in_kind", - "gift", - "expire_long", - "discretionary", - "other", - "small", - "exempt", - "otm", - "purchase", - "sale", - "tender", - "will", - "itm", - "trust" + "anyOf": [ + { + "enum": [ + "award", + "conversion", + "return", + "expire_short", + "in_kind", + "gift", + "expire_long", + "discretionary", + "other", + "small", + "exempt", + "otm", + "purchase", + "sale", + "tender", + "will", + "itm", + "trust" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "fmp", "description": "Type of the transaction. (provider: fmp)" @@ -11516,7 +12886,7 @@ "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.", + "description": "Get the form 13F.\n\nThe 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": [ { @@ -11699,10 +13069,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -12041,10 +13413,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -12339,9 +13713,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." @@ -12481,6 +13855,25 @@ "default": 0 }, "description": "\n Skip N number of reports from current. A value of 1 will skip the most recent report.\n (provider: sec)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec)", + "default": true + }, + "description": "Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec)" } ], "responses": { @@ -12725,7 +14118,7 @@ "equity" ], "summary": "Screener", - "description": "Screen for companies meeting various criteria. These criteria include\nmarket cap, price, beta, volume, and dividend yield.", + "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", "operationId": "equity_screener", "security": [ { @@ -12973,21 +14366,21 @@ "anyOf": [ { "enum": [ - "Consumer Cyclical", - "Energy", - "Technology", - "Industrials", - "Financial Services", - "Basic Materials", - "Communication Services", - "Consumer Defensive", - "Healthcare", - "Real Estate", - "Utilities", - "Industrial Goods", - "Financial", - "Services", - "Conglomerates" + "consumer_cyclical", + "energy", + "technology", + "industrials", + "financial_services", + "basic_materials", + "communication_services", + "consumer_defensive", + "healthcare", + "real_estate", + "utilities", + "industrial_goods", + "financial", + "services", + "conglomerates" ], "type": "string" }, @@ -13223,10 +14616,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -13694,10 +15089,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", - "multiple_items_allowed": [ - "fmp", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon." @@ -13982,10 +15379,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -14191,9 +15590,9 @@ "schema": { "type": "string", "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." @@ -14291,10 +15690,12 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio.", - "multiple_items_allowed": [ - "fmp", - "intrinio" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio." @@ -14454,10 +15855,10 @@ "type": "null" } ], - "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)" + "title": "fmp,intrinio,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. (provider: intrinio);\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. (provider: intrinio);\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", @@ -14684,14 +16085,14 @@ ] } }, - "/api/v1/etf/holdings_performance": { + "/api/v1/etf/equity_exposure": { "get": { "tags": [ "etf" ], - "summary": "Holdings Performance", - "description": "Get the recent price performance of each ticker held in the ETF.", - "operationId": "etf_holdings_performance", + "summary": "Equity Exposure", + "description": "Get the exposure to ETFs for a specific stock.", + "operationId": "etf_equity_exposure", "security": [ { "OAuth2PasswordBearer": [] @@ -14718,13 +16119,13 @@ "required": true, "schema": { "type": "string", - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" - ], + "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", + "fmp": { + "multiple_items_allowed": true + }, "title": "Symbol" }, - "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." + "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { @@ -14733,7 +16134,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_EtfHoldingsPerformance" + "$ref": "#/components/schemas/OBBject_EtfEquityExposure" } } } @@ -14772,12 +16173,21 @@ } } }, - "model": "EtfHoldingsPerformance", + "model": "EtfEquityExposure", "examples": [ { "scope": "api", "parameters": { - "symbol": "XLK", + "symbol": "MSFT", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "description": "This function accepts multiple tickers.", + "parameters": { + "symbol": "MSFT,AAPL", "provider": "fmp" }, "provider": "fmp" @@ -14785,14 +16195,14 @@ ] } }, - "/api/v1/etf/equity_exposure": { + "/api/v1/fixedincome/rate/ameribor": { "get": { "tags": [ - "etf" + "fixedincome" ], - "summary": "Equity Exposure", - "description": "Get the exposure to ETFs for a specific stock.", - "operationId": "etf_equity_exposure", + "summary": "Ameribor", + "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", + "operationId": "fixedincome_rate_ameribor", "security": [ { "OAuth2PasswordBearer": [] @@ -14805,27 +16215,76 @@ "required": false, "schema": { "enum": [ - "fmp" + "fred" ], - "const": "fmp", + "const": "fred", "type": "string", - "default": "fmp", + "default": "fred", "title": "Provider" } }, { - "name": "symbol", + "name": "start_date", "in": "query", - "required": true, + "required": false, "schema": { - "type": "string", - "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp.", - "multiple_items_allowed": [ - "fmp" + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } ], - "title": "Symbol" + "description": "Start date of the data, in YYYY-MM-DD format.", + "title": "Start Date" }, - "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): 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." + }, + { + "name": "parameter", + "in": "query", + "required": false, + "schema": { + "enum": [ + "overnight", + "term_30", + "term_90", + "1_week_term_structure", + "1_month_term_structure", + "3_month_term_structure", + "6_month_term_structure", + "1_year_term_structure", + "2_year_term_structure", + "30_day_ma", + "90_day_ma" + ], + "type": "string", + "title": "fred", + "description": "Period of AMERIBOR rate. (provider: fred)", + "default": "overnight" + }, + "description": "Period of AMERIBOR rate. (provider: fred)" } ], "responses": { @@ -14834,7 +16293,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_EtfEquityExposure" + "$ref": "#/components/schemas/OBBject_AMERIBOR" } } } @@ -14873,36 +16332,34 @@ } } }, - "model": "EtfEquityExposure", + "model": "AMERIBOR", "examples": [ { "scope": "api", "parameters": { - "symbol": "MSFT", - "provider": "fmp" + "provider": "fred" }, - "provider": "fmp" + "provider": "fred" }, { "scope": "api", - "description": "This function accepts multiple tickers.", "parameters": { - "symbol": "MSFT,AAPL", - "provider": "fmp" + "parameter": "30_day_ma", + "provider": "fred" }, - "provider": "fmp" + "provider": "fred" } ] } }, - "/api/v1/fixedincome/rate/ameribor": { + "/api/v1/fixedincome/rate/sonia": { "get": { "tags": [ "fixedincome" ], - "summary": "Ameribor", - "description": "Ameribor.\n\nAmeribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of\nshort-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the\nAmerican Financial Exchange (AFX).", - "operationId": "fixedincome_rate_ameribor", + "summary": "Sonia", + "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", + "operationId": "fixedincome_rate_sonia", "security": [ { "OAuth2PasswordBearer": [] @@ -14967,24 +16424,20 @@ "required": false, "schema": { "enum": [ - "overnight", - "term_30", - "term_90", - "1_week_term_structure", - "1_month_term_structure", - "3_month_term_structure", - "6_month_term_structure", - "1_year_term_structure", - "2_year_term_structure", - "30_day_ma", - "90_day_ma" + "rate", + "index", + "10th_percentile", + "25th_percentile", + "75th_percentile", + "90th_percentile", + "total_nominal_value" ], "type": "string", "title": "fred", - "description": "Period of AMERIBOR rate. (provider: fred)", - "default": "overnight" + "description": "Period of SONIA rate. (provider: fred)", + "default": "rate" }, - "description": "Period of AMERIBOR rate. (provider: fred)" + "description": "Period of SONIA rate. (provider: fred)" } ], "responses": { @@ -14993,7 +16446,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_AMERIBOR" + "$ref": "#/components/schemas/OBBject_SONIA" } } } @@ -15032,7 +16485,7 @@ } } }, - "model": "AMERIBOR", + "model": "SONIA", "examples": [ { "scope": "api", @@ -15044,7 +16497,7 @@ { "scope": "api", "parameters": { - "parameter": "30_day_ma", + "parameter": "total_nominal_value", "provider": "fred" }, "provider": "fred" @@ -15052,14 +16505,14 @@ ] } }, - "/api/v1/fixedincome/rate/sonia": { + "/api/v1/fixedincome/rate/iorb": { "get": { "tags": [ "fixedincome" ], - "summary": "Sonia", - "description": "Sterling Overnight Index Average.\n\nSONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual\ntransactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other\nfinancial institutions and other institutional investors.", - "operationId": "fixedincome_rate_sonia", + "summary": "Iorb", + "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "operationId": "fixedincome_rate_iorb", "security": [ { "OAuth2PasswordBearer": [] @@ -15117,27 +16570,6 @@ "title": "End Date" }, "description": "End date of the data, in YYYY-MM-DD format." - }, - { - "name": "parameter", - "in": "query", - "required": false, - "schema": { - "enum": [ - "rate", - "index", - "10th_percentile", - "25th_percentile", - "75th_percentile", - "90th_percentile", - "total_nominal_value" - ], - "type": "string", - "title": "fred", - "description": "Period of SONIA rate. (provider: fred)", - "default": "rate" - }, - "description": "Period of SONIA rate. (provider: fred)" } ], "responses": { @@ -15146,7 +16578,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_SONIA" + "$ref": "#/components/schemas/OBBject_IORB" } } } @@ -15185,7 +16617,7 @@ } } }, - "model": "SONIA", + "model": "IORB", "examples": [ { "scope": "api", @@ -15193,26 +16625,18 @@ "provider": "fred" }, "provider": "fred" - }, - { - "scope": "api", - "parameters": { - "parameter": "total_nominal_value", - "provider": "fred" - }, - "provider": "fred" } ] } }, - "/api/v1/fixedincome/rate/iorb": { + "/api/v1/fixedincome/rate/effr": { "get": { "tags": [ "fixedincome" ], - "summary": "Iorb", - "description": "Interest on Reserve Balances.\n\nGet Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "operationId": "fixedincome_rate_iorb", + "summary": "Effr", + "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", + "operationId": "fixedincome_rate_effr", "security": [ { "OAuth2PasswordBearer": [] @@ -15222,14 +16646,13 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ + "federal_reserve", "fred" ], - "const": "fred", "type": "string", - "default": "fred", "title": "Provider" } }, @@ -15270,6 +16693,27 @@ "title": "End Date" }, "description": "End date of the data, in YYYY-MM-DD format." + }, + { + "name": "parameter", + "in": "query", + "required": false, + "schema": { + "enum": [ + "monthly", + "daily", + "weekly", + "daily_excl_weekend", + "annual", + "biweekly", + "volume" + ], + "type": "string", + "title": "fred", + "description": "Period of FED rate. (provider: fred)", + "default": "weekly" + }, + "description": "Period of FED rate. (provider: fred)" } ], "responses": { @@ -15278,7 +16722,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_IORB" + "$ref": "#/components/schemas/OBBject_FEDFUNDS" } } } @@ -15317,7 +16761,7 @@ } } }, - "model": "IORB", + "model": "FEDFUNDS", "examples": [ { "scope": "api", @@ -15325,18 +16769,26 @@ "provider": "fred" }, "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "parameter": "daily", + "provider": "fred" + }, + "provider": "fred" } ] } }, - "/api/v1/fixedincome/rate/effr": { + "/api/v1/fixedincome/rate/effr_forecast": { "get": { "tags": [ "fixedincome" ], - "summary": "Effr", - "description": "Fed Funds Rate.\n\nGet Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its\ndomestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the\nUnited States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.", - "operationId": "fixedincome_rate_effr", + "summary": "Effr Forecast", + "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", + "operationId": "fixedincome_rate_effr_forecast", "security": [ { "OAuth2PasswordBearer": [] @@ -15346,74 +16798,28 @@ { "name": "provider", "in": "query", - "required": true, + "required": false, "schema": { "enum": [ - "federal_reserve", "fred" ], + "const": "fred", "type": "string", + "default": "fred", "title": "Provider" } }, { - "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": "parameter", + "name": "long_run", "in": "query", "required": false, "schema": { - "enum": [ - "monthly", - "daily", - "weekly", - "daily_excl_weekend", - "annual", - "biweekly", - "volume" - ], - "type": "string", + "type": "boolean", "title": "fred", - "description": "Period of FED rate. (provider: fred)", - "default": "weekly" + "description": "Flag to show long run projections (provider: fred)", + "default": false }, - "description": "Period of FED rate. (provider: fred)" + "description": "Flag to show long run projections (provider: fred)" } ], "responses": { @@ -15422,7 +16828,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_FEDFUNDS" + "$ref": "#/components/schemas/OBBject_PROJECTIONS" } } } @@ -15461,7 +16867,7 @@ } } }, - "model": "FEDFUNDS", + "model": "PROJECTIONS", "examples": [ { "scope": "api", @@ -15473,7 +16879,7 @@ { "scope": "api", "parameters": { - "parameter": "daily", + "long_run": 1.0, "provider": "fred" }, "provider": "fred" @@ -15481,14 +16887,14 @@ ] } }, - "/api/v1/fixedincome/rate/effr_forecast": { + "/api/v1/fixedincome/rate/estr": { "get": { "tags": [ "fixedincome" ], - "summary": "Effr Forecast", - "description": "Fed Funds Rate Projections.\n\nThe projections for the federal funds rate are the value of the midpoint of the\nprojected appropriate target range for the federal funds rate or the projected\nappropriate target level for the federal funds rate at the end of the specified\ncalendar year or over the longer run.", - "operationId": "fixedincome_rate_effr_forecast", + "summary": "Estr", + "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", + "operationId": "fixedincome_rate_estr", "security": [ { "OAuth2PasswordBearer": [] @@ -15510,16 +16916,63 @@ } }, { - "name": "long_run", + "name": "start_date", "in": "query", "required": false, "schema": { - "type": "boolean", + "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": "parameter", + "in": "query", + "required": false, + "schema": { + "enum": [ + "volume_weighted_trimmed_mean_rate", + "number_of_transactions", + "number_of_active_banks", + "total_volume", + "share_of_volume_of_the_5_largest_active_banks", + "rate_at_75th_percentile_of_volume", + "rate_at_25th_percentile_of_volume" + ], + "type": "string", "title": "fred", - "description": "Flag to show long run projections (provider: fred)", - "default": false + "description": "Period of ESTR rate. (provider: fred)", + "default": "volume_weighted_trimmed_mean_rate" }, - "description": "Flag to show long run projections (provider: fred)" + "description": "Period of ESTR rate. (provider: fred)" } ], "responses": { @@ -15528,7 +16981,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_PROJECTIONS" + "$ref": "#/components/schemas/OBBject_ESTR" } } } @@ -15567,7 +17020,7 @@ } } }, - "model": "PROJECTIONS", + "model": "ESTR", "examples": [ { "scope": "api", @@ -15579,7 +17032,7 @@ { "scope": "api", "parameters": { - "long_run": 1.0, + "parameter": "number_of_active_banks", "provider": "fred" }, "provider": "fred" @@ -15587,14 +17040,14 @@ ] } }, - "/api/v1/fixedincome/rate/estr": { + "/api/v1/fixedincome/rate/ecb": { "get": { "tags": [ "fixedincome" ], - "summary": "Estr", - "description": "Euro Short-Term Rate.\n\nThe euro short-term rate (\u20acSTR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in\nthe euro area. The \u20acSTR is published on each TARGET2 business day based on transactions conducted and settled on\nthe previous TARGET2 business day (the reporting date \u201cT\u201d) with a maturity date of T+1 which are deemed to have been\nexecuted at arm\u2019s length and thus reflect market rates in an unbiased way.", - "operationId": "fixedincome_rate_estr", + "summary": "Ecb", + "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", + "operationId": "fixedincome_rate_ecb", "security": [ { "OAuth2PasswordBearer": [] @@ -15654,25 +17107,21 @@ "description": "End date of the data, in YYYY-MM-DD format." }, { - "name": "parameter", + "name": "interest_rate_type", "in": "query", "required": false, "schema": { "enum": [ - "volume_weighted_trimmed_mean_rate", - "number_of_transactions", - "number_of_active_banks", - "total_volume", - "share_of_volume_of_the_5_largest_active_banks", - "rate_at_75th_percentile_of_volume", - "rate_at_25th_percentile_of_volume" + "deposit", + "lending", + "refinancing" ], "type": "string", - "title": "fred", - "description": "Period of ESTR rate. (provider: fred)", - "default": "volume_weighted_trimmed_mean_rate" + "description": "The type of interest rate.", + "default": "lending", + "title": "Interest Rate Type" }, - "description": "Period of ESTR rate. (provider: fred)" + "description": "The type of interest rate." } ], "responses": { @@ -15681,7 +17130,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_ESTR" + "$ref": "#/components/schemas/OBBject_EuropeanCentralBankInterestRates" } } } @@ -15720,7 +17169,7 @@ } } }, - "model": "ESTR", + "model": "EuropeanCentralBankInterestRates", "examples": [ { "scope": "api", @@ -15732,7 +17181,7 @@ { "scope": "api", "parameters": { - "parameter": "number_of_active_banks", + "interest_rate_type": "refinancing", "provider": "fred" }, "provider": "fred" @@ -15740,14 +17189,14 @@ ] } }, - "/api/v1/fixedincome/rate/ecb": { + "/api/v1/fixedincome/rate/dpcredit": { "get": { "tags": [ "fixedincome" ], - "summary": "Ecb", - "description": "European Central Bank Interest Rates.\n\nThe Governing Council of the ECB sets the key interest rates for the euro area:\n\n- The interest rate on the main refinancing operations (MRO), which provide\nthe bulk of liquidity to the banking system.\n- The rate on the deposit facility, which banks may use to make overnight deposits with the Eurosystem.\n- The rate on the marginal lending facility, which offers overnight credit to banks from the Eurosystem.", - "operationId": "fixedincome_rate_ecb", + "summary": "Dpcredit", + "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", + "operationId": "fixedincome_rate_dpcredit", "security": [ { "OAuth2PasswordBearer": [] @@ -15807,21 +17256,23 @@ "description": "End date of the data, in YYYY-MM-DD format." }, { - "name": "interest_rate_type", + "name": "parameter", "in": "query", "required": false, "schema": { "enum": [ - "deposit", - "lending", - "refinancing" + "daily_excl_weekend", + "monthly", + "weekly", + "daily", + "annual" ], "type": "string", - "description": "The type of interest rate.", - "default": "lending", - "title": "Interest Rate Type" + "title": "fred", + "description": "FRED series ID of DWPCR data. (provider: fred)", + "default": "daily_excl_weekend" }, - "description": "The type of interest rate." + "description": "FRED series ID of DWPCR data. (provider: fred)" } ], "responses": { @@ -15830,158 +17281,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_EuropeanCentralBankInterestRates" - } - } - } - }, - "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": "EuropeanCentralBankInterestRates", - "examples": [ - { - "scope": "api", - "parameters": { - "provider": "fred" - }, - "provider": "fred" - }, - { - "scope": "api", - "parameters": { - "interest_rate_type": "refinancing", - "provider": "fred" - }, - "provider": "fred" - } - ] - } - }, - "/api/v1/fixedincome/rate/dpcredit": { - "get": { - "tags": [ - "fixedincome" - ], - "summary": "Dpcredit", - "description": "Discount Window Primary Credit Rate.\n\nA bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money.\nThe rates central banks charge are set to stabilize the economy.\nIn the United States, the Federal Reserve System's Board of Governors set the bank rate,\nalso known as the discount rate.", - "operationId": "fixedincome_rate_dpcredit", - "security": [ - { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ - { - "name": "provider", - "in": "query", - "required": false, - "schema": { - "enum": [ - "fred" - ], - "const": "fred", - "type": "string", - "default": "fred", - "title": "Provider" - } - }, - { - "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": "parameter", - "in": "query", - "required": false, - "schema": { - "enum": [ - "daily_excl_weekend", - "monthly", - "weekly", - "daily", - "annual" - ], - "type": "string", - "title": "fred", - "description": "FRED series ID of DWPCR data. (provider: fred)", - "default": "daily_excl_weekend" - }, - "description": "FRED series ID of DWPCR data. (provider: fred)" - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_DiscountWindowPrimaryCreditRate" + "$ref": "#/components/schemas/OBBject_DiscountWindowPrimaryCreditRate" } } } @@ -16509,14 +17809,14 @@ ] } }, - "/api/v1/fixedincome/government/us_yield_curve": { + "/api/v1/fixedincome/government/yield_curve": { "get": { "tags": [ "fixedincome" ], - "summary": "Us Yield Curve", - "description": "US Yield Curve. Get United States yield curve.", - "operationId": "fixedincome_government_us_yield_curve", + "summary": "Yield Curve", + "description": "Get yield curve data by country and date.", + "operationId": "fixedincome_government_yield_curve", "security": [ { "OAuth2PasswordBearer": [] @@ -16526,14 +17826,16 @@ { "name": "provider", "in": "query", - "required": false, + "required": true, "schema": { "enum": [ + "ecb", + "econdb", + "federal_reserve", + "fmp", "fred" ], - "const": "fred", "type": "string", - "default": "fred", "title": "Provider" } }, @@ -16544,36 +17846,140 @@ "schema": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "description": "A specific date to get data for. Defaults to the most recent FRED entry.", + "description": "A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred.", + "ecb": { + "multiple_items_allowed": true + }, + "econdb": [ + "multiple_items_allowed" + ], + "federal_reserve": { + "multiple_items_allowed": true + }, + "fmp": { + "multiple_items_allowed": true + }, + "fred": { + "multiple_items_allowed": true + }, "title": "Date" }, - "description": "A specific date to get data for. Defaults to the most recent FRED entry." + "description": "A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred." }, { - "name": "inflation_adjusted", + "name": "rating", + "in": "query", + "required": false, + "schema": { + "enum": [ + "aaa", + "all_ratings" + ], + "type": "string", + "title": "ecb", + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", + "default": "aaa" + }, + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)" + }, + { + "name": "yield_curve_type", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "enum": [ + "spot_rate", + "instantaneous_forward", + "par_yield" + ], + "type": "string" }, { - "type": "null" + "enum": [ + "nominal", + "real", + "breakeven", + "corporate_spot", + "corporate_par" + ], + "type": "string" } ], - "description": "Get inflation adjusted rates.", - "default": false, - "title": "Inflation Adjusted" + "title": "ecb,fred", + "description": "The yield curve type. (provider: ecb);\n Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred)", + "default": "spot_rate" }, - "description": "Get inflation adjusted rates." + "description": "The yield curve type. (provider: ecb);\n Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred)" + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "title": "ecb,econdb", + "description": "If true, cache the request for four hours. (provider: ecb, econdb)", + "default": true + }, + "description": "If true, cache the request for four hours. (provider: ecb, econdb)" + }, + { + "name": "country", + "in": "query", + "required": false, + "schema": { + "enum": [ + "australia", + "canada", + "china", + "hong_kong", + "india", + "japan", + "mexico", + "new_zealand", + "russia", + "saudi_arabia", + "singapore", + "south_africa", + "south_korea", + "taiwan", + "thailand", + "united_kingdom", + "united_states" + ], + "type": "string", + "title": "econdb", + "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. (provider: econdb)", + "choices": [ + "australia", + "canada", + "china", + "hong_kong", + "india", + "japan", + "mexico", + "new_zealand", + "russia", + "saudi_arabia", + "singapore", + "south_africa", + "south_korea", + "taiwan", + "thailand", + "united_kingdom", + "united_states" + ], + "default": "united_states" + }, + "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. (provider: econdb)" } ], "responses": { @@ -16582,7 +17988,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_USYieldCurve" + "$ref": "#/components/schemas/OBBject_YieldCurve" } } } @@ -16621,34 +18027,61 @@ } } }, - "model": "USYieldCurve", + "model": "YieldCurve", "examples": [ { "scope": "api", "parameters": { - "provider": "fred" + "provider": "federal_reserve" }, - "provider": "fred" + "provider": "federal_reserve" }, { "scope": "api", "parameters": { - "inflation_adjusted": 1.0, - "provider": "fred" + "date": "2023-05-01,2024-05-01", + "provider": "fmp" + }, + "provider": "fmp" + }, + { + "scope": "api", + "parameters": { + "date": "2023-05-01", + "country": "united_kingdom", + "provider": "econdb" + }, + "provider": "econdb" + }, + { + "scope": "api", + "parameters": { + "provider": "ecb", + "yield_curve_type": "par_yield" + }, + "provider": "ecb" + }, + { + "scope": "api", + "parameters": { + "provider": "fred", + "yield_curve_type": "real", + "date": "2023-05-01,2024-05-01" }, "provider": "fred" } ] } }, - "/api/v1/fixedincome/government/eu_yield_curve": { + "/api/v1/fixedincome/government/us_yield_curve": { "get": { "tags": [ "fixedincome" ], - "summary": "Eu Yield Curve", - "description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.", - "operationId": "fixedincome_government_eu_yield_curve", + "summary": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.", + "description": "US Yield Curve. Get United States yield curve.", + "operationId": "fixedincome_government_us_yield_curve", + "deprecated": true, "security": [ { "OAuth2PasswordBearer": [] @@ -16661,11 +18094,11 @@ "required": false, "schema": { "enum": [ - "ecb" + "fred" ], - "const": "ecb", + "const": "fred", "type": "string", - "default": "ecb", + "default": "fred", "title": "Provider" } }, @@ -16683,43 +18116,29 @@ "type": "null" } ], - "description": "A specific date to get data for.", + "description": "A specific date to get data for. Defaults to the most recent FRED entry.", "title": "Date" }, - "description": "A specific date to get data for." - }, - { - "name": "rating", - "in": "query", - "required": false, - "schema": { - "enum": [ - "aaa", - "all_ratings" - ], - "type": "string", - "title": "ecb", - "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", - "default": "aaa" - }, - "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)" + "description": "A specific date to get data for. Defaults to the most recent FRED entry." }, { - "name": "yield_curve_type", + "name": "inflation_adjusted", "in": "query", "required": false, "schema": { - "enum": [ - "spot_rate", - "instantaneous_forward", - "par_yield" + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } ], - "type": "string", - "title": "ecb", - "description": "The yield curve type. (provider: ecb)", - "default": "spot_rate" + "description": "Get inflation adjusted rates.", + "default": false, + "title": "Inflation Adjusted" }, - "description": "The yield curve type. (provider: ecb)" + "description": "Get inflation adjusted rates." } ], "responses": { @@ -16728,7 +18147,154 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_EUYieldCurve" + "$ref": "#/components/schemas/OBBject_USYieldCurve" + } + } + } + }, + "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": "USYieldCurve", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "fred" + }, + "provider": "fred" + }, + { + "scope": "api", + "parameters": { + "inflation_adjusted": 1.0, + "provider": "fred" + }, + "provider": "fred" + } + ] + } + }, + "/api/v1/fixedincome/government/eu_yield_curve": { + "get": { + "tags": [ + "fixedincome" + ], + "summary": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.", + "description": "Euro Area Yield Curve.\n\nGets euro area yield curve data from ECB.\n\nThe graphic depiction of the relationship between the yield on bonds of the same credit quality but different\nmaturities is known as the yield curve. In the past, most market participants have constructed yield curves from\nthe observations of prices and yields in the Treasury market. Two reasons account for this tendency. First,\nTreasury securities are viewed as free of default risk, and differences in creditworthiness do not affect yield\nestimates. Second, as the most active bond market, the Treasury market offers the fewest problems of illiquidity\nor infrequent trading. The key function of the Treasury yield curve is to serve as a benchmark for pricing bonds\nand setting yields in other sectors of the debt market.\n\nIt is clear that the market\u2019s expectations of future rate changes are one important determinant of the\nyield-curve shape. For example, a steeply upward-sloping curve may indicate market expectations of near-term Fed\ntightening or of rising inflation. However, it may be too restrictive to assume that the yield differences across\nbonds with different maturities only reflect the market\u2019s rate expectations. The well-known pure expectations\nhypothesis has such an extreme implication. The pure expectations hypothesis asserts that all government bonds\nhave the same near-term expected return (as the nominally riskless short-term bond) because the return-seeking\nactivity of risk-neutral traders removes all expected return differentials across bonds.", + "operationId": "fixedincome_government_eu_yield_curve", + "deprecated": true, + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "ecb" + ], + "const": "ecb", + "type": "string", + "default": "ecb", + "title": "Provider" + } + }, + { + "name": "date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "description": "A specific date to get data for.", + "title": "Date" + }, + "description": "A specific date to get data for." + }, + { + "name": "rating", + "in": "query", + "required": false, + "schema": { + "enum": [ + "aaa", + "all_ratings" + ], + "type": "string", + "title": "ecb", + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)", + "default": "aaa" + }, + "description": "The rating type, either 'aaa' or 'all_ratings'. (provider: ecb)" + }, + { + "name": "yield_curve_type", + "in": "query", + "required": false, + "schema": { + "enum": [ + "spot_rate", + "instantaneous_forward", + "par_yield" + ], + "type": "string", + "title": "ecb", + "description": "The yield curve type. (provider: ecb)", + "default": "spot_rate" + }, + "description": "The yield curve type. (provider: ecb)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_EUYieldCurve" } } } @@ -17517,9 +19083,9 @@ } ], "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "default": 10.0, "title": "Maturity" }, @@ -17536,9 +19102,9 @@ "par_yield", "spot_rate" ], - "multiple_items_allowed": [ - "fred" - ], + "fred": { + "multiple_items_allowed": true + }, "default": "spot_rate", "title": "Category" }, @@ -17981,11 +19547,15 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", - "multiple_items_allowed": [ - "fmp", - "intrinio", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." @@ -18156,7 +19726,7 @@ "index" ], "summary": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3.", - "description": "Historical Market Indices.", + "description": "Get Historical Market Indices.", "operationId": "index_market", "deprecated": true, "security": [ @@ -18186,11 +19756,15 @@ "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon.", - "multiple_items_allowed": [ - "fmp", - "intrinio", - "polygon" - ], + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, polygon." @@ -18352,7 +19926,7 @@ "index" ], "summary": "Constituents", - "description": "Index Constituents.", + "description": "Get Index Constituents.", "operationId": "index_constituents", "security": [ { @@ -18820,6 +20394,179 @@ "description": "Content types of the news to retrieve. (provider: benzinga)" }, "description": "Content types of the news to retrieve. (provider: benzinga)" + }, + { + "name": "source", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "yahoo", + "moody", + "moody_us_news", + "moody_us_press_releases" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The source of the news article. (provider: intrinio)" + }, + "description": "The source of the news article. (provider: intrinio)" + }, + { + "name": "sentiment", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "positive", + "neutral", + "negative" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return news only from this source. (provider: intrinio)" + }, + "description": "Return news only from this source. (provider: intrinio)" + }, + { + "name": "language", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "topic", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "is_spam", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "business_relevance_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + { + "name": "business_relevance_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" } ], "responses": { @@ -18958,12 +20705,18 @@ } ], "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" - ], + "benzinga": { + "multiple_items_allowed": true + }, + "fmp": { + "multiple_items_allowed": true + }, + "intrinio": { + "multiple_items_allowed": true + }, + "polygon": { + "multiple_items_allowed": true + }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, fmp, intrinio, polygon." @@ -19264,6 +21017,179 @@ "default": 0 }, "description": "Page number of the results. Use in combination with limit. (provider: fmp)" + }, + { + "name": "source", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "yahoo", + "moody", + "moody_us_news", + "moody_us_press_releases" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "The source of the news article. (provider: intrinio)" + }, + "description": "The source of the news article. (provider: intrinio)" + }, + { + "name": "sentiment", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "enum": [ + "positive", + "neutral", + "negative" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Return news only from this source. (provider: intrinio)" + }, + "description": "Return news only from this source. (provider: intrinio)" + }, + { + "name": "language", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by language. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "topic", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter by topic. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count greater than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "word_count_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "News stories will have a word count less than this value. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "is_spam", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + "description": "Filter whether it is marked as spam or not. Unsupported for yahoo source. (provider: intrinio)" + }, + { + "name": "business_relevance_greater_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score more than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + { + "name": "business_relevance_less_than", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "intrinio", + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" + }, + "description": "News stories will have a business relevance score less than this value. Unsupported for yahoo source. Value is a decimal between 0 and 1. (provider: intrinio)" } ], "responses": { @@ -19371,14 +21297,14 @@ ] } }, - "/api/v1/regulators/sec/cik_map": { + "/api/v1/pro/watchlist": { "get": { "tags": [ - "regulators" + "pro" ], - "summary": "Cik Map", - "description": "Map a ticker symbol to a CIK number.", - "operationId": "regulators_sec_cik_map", + "summary": "Watchlist", + "description": "Watchlist endpoint for pro users.", + "operationId": "pro_watchlist", "security": [ { "OAuth2PasswordBearer": [] @@ -19391,142 +21317,50 @@ "required": false, "schema": { "enum": [ - "sec" + "pro" ], - "const": "sec", + "const": "pro", "type": "string", - "default": "sec", + "default": "pro", "title": "Provider" } }, { - "name": "symbol", - "in": "query", - "required": true, - "schema": { - "type": "string", - "description": "Symbol to get data for.", - "title": "Symbol" - }, - "description": "Symbol to get data for." - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OBBject_CikMap" - } - } - } - }, - "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": "CikMap", - "examples": [ - { - "scope": "api", - "parameters": { - "symbol": "MSFT", - "provider": "sec" - }, - "provider": "sec" - } - ] - } - }, - "/api/v1/regulators/sec/institutions_search": { - "get": { - "tags": [ - "regulators" - ], - "summary": "Institutions Search", - "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", - "operationId": "regulators_sec_institutions_search", - "security": [ - { - "OAuth2PasswordBearer": [] - } - ], - "parameters": [ - { - "name": "provider", + "name": "data_provider", "in": "query", "required": false, "schema": { "enum": [ - "sec" + "fmp" ], - "const": "sec", - "type": "string", - "default": "sec", - "title": "Provider" - } - }, - { - "name": "query", - "in": "query", - "required": false, - "schema": { + "const": "fmp", "type": "string", - "description": "Search query.", - "default": "", - "title": "Query" + "title": "pro", + "description": "Provider name. (provider: pro)", + "default": "fmp" }, - "description": "Search query." + "description": "Provider name. (provider: pro)" }, { - "name": "use_cache", + "name": "symbol", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, - "title": "Use Cache" + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" } ], "responses": { @@ -19535,7 +21369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_InstitutionsSearch" + "$ref": "#/components/schemas/OBBject_Watchlist" } } } @@ -19574,34 +21408,18 @@ } } }, - "model": "InstitutionsSearch", - "examples": [ - { - "scope": "api", - "parameters": { - "provider": "sec" - }, - "provider": "sec" - }, - { - "scope": "api", - "parameters": { - "query": "blackstone real estate", - "provider": "sec" - }, - "provider": "sec" - } - ] + "model": "Watchlist", + "examples": [] } }, - "/api/v1/regulators/sec/schema_files": { + "/api/v1/pro/key_metrics": { "get": { "tags": [ - "regulators" + "pro" ], - "summary": "Schema Files", - "description": "A tool for navigating the directory of SEC XML schema files by year.", - "operationId": "regulators_sec_schema_files", + "summary": "Key Metrics", + "description": "Key metrics endpoint for pro users.", + "operationId": "pro_key_metrics", "security": [ { "OAuth2PasswordBearer": [] @@ -19614,47 +21432,131 @@ "required": false, "schema": { "enum": [ - "sec" + "pro" ], - "const": "sec", + "const": "pro", "type": "string", - "default": "sec", + "default": "pro", "title": "Provider" } }, { - "name": "query", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Search query.", - "default": "", - "title": "Query" - }, - "description": "Search query." - }, - { - "name": "use_cache", + "name": "symbol", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, - "title": "Use Cache" + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" }, { - "name": "url", + "name": "category", + "in": "query", + "required": false, + "schema": { + "enum": [ + "equity", + "etf" + ], + "type": "string", + "title": "pro", + "description": "Category of the asset. (provider: pro)", + "default": "equity" + }, + "description": "Category of the asset. (provider: pro)" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_ProKeyMetrics" + } + } + } + }, + "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": "ProKeyMetrics", + "examples": [] + } + }, + "/api/v1/pro/grouped_comparisons": { + "get": { + "tags": [ + "pro" + ], + "summary": "Grouped Comparisons", + "description": "Grouped comparison endpoint for pro users.", + "operationId": "pro_grouped_comparisons", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "pro" + ], + "const": "pro", + "type": "string", + "default": "pro", + "title": "Provider" + } + }, + { + "name": "symbol", "in": "query", "required": false, "schema": { @@ -19666,10 +21568,13 @@ "type": "null" } ], - "title": "sec", - "description": "Enter an optional URL path to fetch the next level. (provider: sec)" + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": { + "multiple_items_allowed": true + } }, - "description": "Enter an optional URL path to fetch the next level. (provider: sec)" + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" } ], "responses": { @@ -19678,7 +21583,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_SchemaFiles" + "$ref": "#/components/schemas/OBBject_GroupedComparisons" } } } @@ -19717,49 +21622,18 @@ } } }, - "model": "SchemaFiles", - "examples": [ - { - "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']" - ] - } - ] + "model": "GroupedComparisons", + "examples": [] } }, - "/api/v1/regulators/sec/symbol_map": { + "/api/v1/pro/grouped_financials": { "get": { "tags": [ - "regulators" + "pro" ], - "summary": "Symbol Map", - "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", - "operationId": "regulators_sec_symbol_map", + "summary": "Grouped Financials", + "description": "Grouped financials endpoint for pro users.", + "operationId": "pro_grouped_financials", "security": [ { "OAuth2PasswordBearer": [] @@ -19772,43 +21646,86 @@ "required": false, "schema": { "enum": [ - "sec" + "pro" ], - "const": "sec", + "const": "pro", "type": "string", - "default": "sec", + "default": "pro", "title": "Provider" } }, { - "name": "query", + "name": "symbol", "in": "query", - "required": true, + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "pro", + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", + "pro": [ + "multiple_items_allowed" + ] + }, + "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" + }, + { + "name": "data_provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "fmp", + "intrinio" + ], + "type": "string", + "title": "pro", + "description": "Provider name. (provider: pro)", + "default": "fmp" + }, + "description": "Provider name. (provider: pro)" + }, + { + "name": "period", + "in": "query", + "required": false, "schema": { + "enum": [ + "annual", + "quarter" + ], "type": "string", - "description": "Search query.", - "title": "Query" + "title": "pro", + "description": "None", + "default": "annual" }, - "description": "Search query." + "description": "None" }, { - "name": "use_cache", + "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "type": "integer", + "minimum": 0 }, { "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", - "default": true, - "title": "Use Cache" + "title": "pro", + "description": "None", + "default": 5 }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "None" } ], "responses": { @@ -19817,7 +21734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_SymbolMap" + "$ref": "#/components/schemas/OBBject_GroupedFinancials" } } } @@ -19856,27 +21773,90 @@ } } }, - "model": "SymbolMap", - "examples": [ + "model": "GroupedFinancials", + "examples": [] + } + }, + "/api/v1/pro/nixtla_timegen": { + "post": { + "tags": [ + "pro" + ], + "summary": "Nixtla Timegen", + "description": "Nixtla Timegen endpoint.", + "operationId": "pro_nixtla_timegen", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NixtlaTimegenQueryParams" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_list_NixtlaTimegenData__" + } + } + } + }, + "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" + } + } + } + } + }, + "security": [ { - "scope": "api", - "parameters": { - "query": "0000789019", - "provider": "sec" - }, - "provider": "sec" + "OAuth2PasswordBearer": [] } - ] + ], + "model": "", + "examples": [] } }, - "/api/v1/regulators/sec/rss_litigation": { + "/api/v1/regulators/sec/cik_map": { "get": { "tags": [ "regulators" ], - "summary": "Rss Litigation", - "description": "The RSS feed provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", - "operationId": "regulators_sec_rss_litigation", + "summary": "Cik Map", + "description": "Map a ticker symbol to a CIK number.", + "operationId": "regulators_sec_cik_map", "security": [ { "OAuth2PasswordBearer": [] @@ -19896,6 +21876,36 @@ "default": "sec", "title": "Provider" } + }, + { + "name": "symbol", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Symbol to get data for.", + "title": "Symbol" + }, + "description": "Symbol to get data for." + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "sec", + "description": "Whether or not to use cache for the request, default is True. (provider: sec)", + "default": true + }, + "description": "Whether or not to use cache for the request, default is True. (provider: sec)" } ], "responses": { @@ -19904,7 +21914,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_RssLitigation" + "$ref": "#/components/schemas/OBBject_CikMap" } } } @@ -19943,11 +21953,12 @@ } } }, - "model": "RssLitigation", + "model": "CikMap", "examples": [ { "scope": "api", "parameters": { + "symbol": "MSFT", "provider": "sec" }, "provider": "sec" @@ -19955,14 +21966,14 @@ ] } }, - "/api/v1/regulators/sec/sic_search": { + "/api/v1/regulators/sec/institutions_search": { "get": { "tags": [ "regulators" ], - "summary": "Sic Search", - "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", - "operationId": "regulators_sec_sic_search", + "summary": "Institutions Search", + "description": "Search SEC-regulated institutions by name and return a list of results with CIK numbers.", + "operationId": "regulators_sec_institutions_search", "security": [ { "OAuth2PasswordBearer": [] @@ -20008,11 +22019,11 @@ "type": "null" } ], - "description": "Whether or not to use cache. If True, cache will store for seven days.", + "description": "Whether or not to use cache.", "default": true, "title": "Use Cache" }, - "description": "Whether or not to use cache. If True, cache will store for seven days." + "description": "Whether or not to use cache." } ], "responses": { @@ -20021,7 +22032,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OBBject_SicSearch" + "$ref": "#/components/schemas/OBBject_InstitutionsSearch" } } } @@ -20060,7 +22071,7 @@ } } }, - "model": "SicSearch", + "model": "InstitutionsSearch", "examples": [ { "scope": "api", @@ -20072,7 +22083,7 @@ { "scope": "api", "parameters": { - "query": "real estate investment trusts", + "query": "blackstone real estate", "provider": "sec" }, "provider": "sec" @@ -20080,54 +22091,67 @@ ] } }, - "/search/symbols": { + "/api/v1/regulators/sec/schema_files": { "get": { "tags": [ - "search" + "regulators" + ], + "summary": "Schema Files", + "description": "Use tool for navigating the directory of SEC XML schema files by year.", + "operationId": "regulators_sec_schema_files", + "security": [ + { + "OAuth2PasswordBearer": [] + } ], - "summary": "Symbols", - "description": "Get supported tickers from the OpenBB SDK API.", - "operationId": "query_symbols", "parameters": [ { - "name": "q", + "name": "provider", "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } + "enum": [ + "sec" ], - "description": "Get information on a symbol, or a comma separated list of symbols.", + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + }, + { + "name": "query", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Search query.", "default": "", - "title": "Q" + "title": "Query" }, - "description": "Get information on a symbol, or a comma separated list of symbols." + "description": "Search query." }, { - "name": "type", + "name": "use_cache", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list.", - "title": "Type" + "description": "Whether or not to use cache.", + "default": true, + "title": "Use Cache" }, - "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list." + "description": "Whether or not to use cache." }, { - "name": "ignore_type", + "name": "url", "in": "query", "required": false, "schema": { @@ -20139,10 +22163,10 @@ "type": "null" } ], - "description": "Comma separated list of types to ignore. (stock, etf, index, indices)", - "title": "Ignore Type" + "title": "sec", + "description": "Enter an optional URL path to fetch the next level. (provider: sec)" }, - "description": "Comma separated list of types to ignore. (stock, etf, index, indices)" + "description": "Enter an optional URL path to fetch the next level. (provider: sec)" } ], "responses": { @@ -20151,89 +22175,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FMPTickerResponse" + "$ref": "#/components/schemas/OBBject_SchemaFiles" } } } }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - } - } - } - } - }, - "/search/currencies": { - "get": { - "tags": [ - "search" - ], - "summary": "Currencies", - "description": "Get supported tickers from the OpenBB SDK API.", - "operationId": "unique_currencies", - "responses": { - "200": { - "description": "Successful Response", + "404": { + "description": "Not found" + }, + "400": { + "description": "No Results Found", "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Response Unique Currencies" + "$ref": "#/components/schemas/OpenBBErrorResponse" } } } - } - } - } - }, - "/search/fred": { - "get": { - "tags": [ - "search" - ], - "summary": "Fred Indices", - "description": "Get fred indices from the OpenBB SDK API.", - "operationId": "query_fred_indices", - "parameters": [ - { - "name": "q", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Search fred indices.", - "title": "Q" - }, - "description": "Search fred indices." - } - ], - "responses": { - "200": { - "description": "Successful Response", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FredIndex" - }, - "title": "Response Query Fred Indices" + "$ref": "#/components/schemas/OpenBBErrorResponse" } } } @@ -20248,36 +22213,100 @@ } } } - } - } - }, - "/udf/symbols": { - "get": { - "tags": [ - "udf" - ], - "summary": "Udf Symbols", - "description": "TradeView UDF Symbols.", - "operationId": "query_udf_symbols", - "parameters": [ + }, + "model": "SchemaFiles", + "examples": [ { - "name": "symbol", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Get UDF symbol.", - "title": "Symbol" + "scope": "api", + "parameters": { + "provider": "sec" }, - "description": "Get UDF symbol." - } + "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']" + ] + } + ] + } + }, + "/api/v1/regulators/sec/symbol_map": { + "get": { + "tags": [ + "regulators" + ], + "summary": "Symbol Map", + "description": "Map a CIK number to a ticker symbol, leading 0s can be omitted or included.", + "operationId": "regulators_sec_symbol_map", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "sec" + ], + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + }, + { + "name": "query", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Search query.", + "title": "Query" + }, + "description": "Search query." + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Whether or not to use cache. If True, cache will store for seven days.", + "default": true, + "title": "Use Cache" + }, + "description": "Whether or not to use cache. If True, cache will store for seven days." + } ], "responses": { "200": { @@ -20285,7 +22314,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UDFSymbol" + "$ref": "#/components/schemas/OBBject_SymbolMap" + } + } + } + }, + "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" } } } @@ -20300,28 +22352,258 @@ } } } - } + }, + "model": "SymbolMap", + "examples": [ + { + "scope": "api", + "parameters": { + "query": "0000789019", + "provider": "sec" + }, + "provider": "sec" + } + ] } }, - "/udf/search": { + "/api/v1/regulators/sec/rss_litigation": { "get": { "tags": [ - "udf" + "regulators" + ], + "summary": "Rss Litigation", + "description": "Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.", + "operationId": "regulators_sec_rss_litigation", + "security": [ + { + "OAuth2PasswordBearer": [] + } + ], + "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "sec" + ], + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_RssLitigation" + } + } + } + }, + "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": "RssLitigation", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + } + ] + } + }, + "/api/v1/regulators/sec/sic_search": { + "get": { + "tags": [ + "regulators" + ], + "summary": "Sic Search", + "description": "Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.", + "operationId": "regulators_sec_sic_search", + "security": [ + { + "OAuth2PasswordBearer": [] + } ], - "summary": "Udf Search", - "description": "TradingView UDF Search Query", - "operationId": "query_udf_search", "parameters": [ + { + "name": "provider", + "in": "query", + "required": false, + "schema": { + "enum": [ + "sec" + ], + "const": "sec", + "type": "string", + "default": "sec", + "title": "Provider" + } + }, { "name": "query", "in": "query", - "required": true, + "required": false, "schema": { "type": "string", - "description": "Search UDF symbols.", + "description": "Search query.", + "default": "", "title": "Query" }, - "description": "Search UDF symbols." + "description": "Search query." + }, + { + "name": "use_cache", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Whether or not to use cache.", + "default": true, + "title": "Use Cache" + }, + "description": "Whether or not to use cache." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OBBject_SicSearch" + } + } + } + }, + "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": "SicSearch", + "examples": [ + { + "scope": "api", + "parameters": { + "provider": "sec" + }, + "provider": "sec" + }, + { + "scope": "api", + "parameters": { + "query": "real estate investment trusts", + "provider": "sec" + }, + "provider": "sec" + } + ] + } + }, + "/search/symbols": { + "get": { + "tags": [ + "search" + ], + "summary": "Symbols", + "description": "Get supported tickers from the OpenBB SDK API.", + "operationId": "query_symbols", + "parameters": [ + { + "name": "q", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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." }, { "name": "type", @@ -20336,14 +22618,13 @@ "type": "null" } ], - "description": "Symbol type.", - "default": "stock", + "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list.", "title": "Type" }, - "description": "Symbol type." + "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list." }, { - "name": "exchange", + "name": "ignore_type", "in": "query", "required": false, "schema": { @@ -20355,29 +22636,114 @@ "type": "null" } ], - "description": "Symbol exchange.", - "title": "Exchange" + "description": "Comma separated list of types to ignore. (stock, etf, index, indices)", + "title": "Ignore Type" }, - "description": "Symbol exchange." + "description": "Comma separated list of types to ignore. (stock, etf, index, indices)" }, { "name": "limit", "in": "query", "required": false, + "schema": { + "type": "integer", + "description": "Limit the number of results returned.", + "default": 25, + "title": "Limit" + }, + "description": "Limit the number of results returned." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FMPTickerResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "post": { + "tags": [ + "search" + ], + "summary": "Post Symbols", + "description": "Get supported tickers from the OpenBB SDK API.", + "operationId": "post_symbols", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PostSearchParams" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FMPTickerResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/search/fred": { + "get": { + "tags": [ + "search" + ], + "summary": "Fred Indices", + "description": "Get fred indices from the OpenBB SDK API.", + "operationId": "query_fred_indices", + "parameters": [ + { + "name": "q", + "in": "query", + "required": false, "schema": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "description": "Limit the number of results.", - "default": 15, - "title": "Limit" + "description": "Search fred indices.", + "title": "Q" }, - "description": "Limit the number of results." + "description": "Search fred indices." } ], "responses": { @@ -20388,9 +22754,9 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/UDFSearchResult" + "$ref": "#/components/schemas/FredIndex" }, - "title": "Response Query Udf Search" + "title": "Response Query Fred Indices" } } } @@ -20407,26 +22773,221 @@ } } } - } - }, - "components": { - "schemas": { - "BenzingaAnalystSearch": { - "properties": { - "last_updated": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + }, + "/udf/symbols": { + "get": { + "tags": [ + "udf" + ], + "summary": "Udf Symbols", + "description": "TradeView UDF Symbols.", + "operationId": "query_udf_symbols", + "parameters": [ + { + "name": "symbol", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Get UDF symbol.", + "title": "Symbol" + }, + "description": "Get UDF symbol." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UDFSymbol" + } } - ], - "title": "Last Updated", - "description": "Date of the last update." + } }, - "firm_name": { + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/udf/search": { + "get": { + "tags": [ + "udf" + ], + "summary": "Udf Search", + "description": "TradingView UDF Search Query", + "operationId": "query_udf_search", + "parameters": [ + { + "name": "query", + "in": "query", + "required": true, + "schema": { + "type": "string", + "description": "Search UDF symbols.", + "title": "Query" + }, + "description": "Search UDF symbols." + }, + { + "name": "type", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol type.", + "default": "stock", + "title": "Type" + }, + "description": "Symbol type." + }, + { + "name": "exchange", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Symbol exchange.", + "title": "Exchange" + }, + "description": "Symbol exchange." + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Limit the number of results.", + "default": 15, + "title": "Limit" + }, + "description": "Limit the number of results." + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UDFSearchResult" + }, + "title": "Response Query Udf Search" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "AvailableComparisonData": { + "properties": { + "financial_ratios": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/PossibleYears" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Financial Ratios", + "description": "Available financial ratios." + }, + "valuation_multiples": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/PossibleYears" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Valuation Multiples", + "description": "Available valuation multiples." + } + }, + "additionalProperties": true, + "type": "object", + "title": "AvailableComparisonData", + "description": "Available Comparison Data." + }, + "BenzingaAnalystSearchData": { + "properties": { + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "Date of the last update." + }, + "firm_name": { "anyOf": [ { "type": "string" @@ -20545,19 +23106,5029 @@ "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "total_ratings": { + "total_ratings": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Total Ratings", + "description": "Number of recommendations made by this analyst." + }, + "overall_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Overall Gain Count", + "description": "The number of ratings that have gained value since the date of recommendation" + }, + "overall_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Overall Loss Count", + "description": "The number of ratings that have lost value since the date of recommendation" + }, + "overall_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Overall Average Return", + "description": "The average percent (normalized) price difference per rating since the date of recommendation", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "overall_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Overall Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1M Gain Count", + "description": "The number of ratings that have gained value over the last month" + }, + "1m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1M Loss Count", + "description": "The number of ratings that have lost value over the last month" + }, + "1m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1M Average Return", + "description": "The average percent (normalized) price difference per rating over the last month", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1m_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1M Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1m_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1M Smart Score", + "description": "A weighted average smart score over the last month." + }, + "1m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3M Gain Count", + "description": "The number of ratings that have gained value over the last 3 months" + }, + "3m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3M Loss Count", + "description": "The number of ratings that have lost value over the last 3 months" + }, + "3m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Average Return", + "description": "The average percent (normalized) price difference per rating over the last 3 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3m_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3m_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Smart Score", + "description": "A weighted average smart score over the last 3 months." + }, + "3m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "6m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "6M Gain Count", + "description": "The number of ratings that have gained value over the last 6 months" + }, + "6m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "6M Loss Count", + "description": "The number of ratings that have lost value over the last 6 months" + }, + "6m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "6M Average Return", + "description": "The average percent (normalized) price difference per rating over the last 6 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "6m_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "6M Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "9m_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "9M Gain Count", + "description": "The number of ratings that have gained value over the last 9 months" + }, + "9m_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "9M Loss Count", + "description": "The number of ratings that have lost value over the last 9 months" + }, + "9m_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "9M Average Return", + "description": "The average percent (normalized) price difference per rating over the last 9 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "9m_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "9M Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "9m_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "9M Smart Score", + "description": "A weighted average smart score over the last 9 months." + }, + "9m_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "9M Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1Y Gain Count", + "description": "The number of ratings that have gained value over the last 1 year" + }, + "1y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "1Y Loss Count", + "description": "The number of ratings that have lost value over the last 1 year" + }, + "1y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Average Return", + "description": "The average percent (normalized) price difference per rating over the last 1 year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1y_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "1y_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Smart Score", + "description": "A weighted average smart score over the last 1 year." + }, + "1y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "1Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "2y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "2Y Gain Count", + "description": "The number of ratings that have gained value over the last 2 years" + }, + "2y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "2Y Loss Count", + "description": "The number of ratings that have lost value over the last 2 years" + }, + "2y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Average Return", + "description": "The average percent (normalized) price difference per rating over the last 2 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "2y_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "2y_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Smart Score", + "description": "A weighted average smart score over the last 3 years." + }, + "2y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "2Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3y_gain_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3Y Gain Count", + "description": "The number of ratings that have gained value over the last 3 years" + }, + "3y_loss_count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "3Y Loss Count", + "description": "The number of ratings that have lost value over the last 3 years" + }, + "3y_average_return": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Average Return", + "description": "The average percent (normalized) price difference per rating over the last 3 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3y_stdev": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Stdev", + "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "3y_smart_score": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Smart Score", + "description": "A weighted average smart score over the last 3 years." + }, + "3y_success_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "3Y Success Rate", + "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "name_full" + ], + "title": "BenzingaAnalystSearchData", + "description": "Benzinga Analyst Search Data." + }, + "BenzingaCompanyNewsData": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data. Here it is the published date of the article." + }, + "title": { + "type": "string", + "title": "Title", + "description": "Title of the article." + }, + "text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Text", + "description": "Text/body of the article." + }, + "images": { + "anyOf": [ + { + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Images", + "description": "URL to the images of the news." + }, + "url": { + "type": "string", + "title": "Url", + "description": "URL to the article." + }, + "symbols": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbols", + "description": "Symbols associated with the article." + }, + "id": { + "type": "string", + "title": "Id", + "description": "Article ID." + }, + "author": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Author", + "description": "Author of the article." + }, + "teaser": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Teaser", + "description": "Teaser of the news." + }, + "channels": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Channels", + "description": "Channels associated with the news." + }, + "stocks": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Stocks", + "description": "Stocks associated with the news." + }, + "tags": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Tags", + "description": "Tags associated with the news." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated", + "description": "Updated date of the news." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "url", + "id" + ], + "title": "BenzingaCompanyNewsData", + "description": "Benzinga Company News Data." + }, + "BenzingaPriceTargetData": { + "properties": { + "published_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "string", + "format": "date-time" + } + ], + "title": "Published Date", + "description": "Published date of the price target." + }, + "published_time": { + "anyOf": [ + { + "type": "string", + "format": "time" + }, + { + "type": "null" + } + ], + "title": "Published Time", + "description": "Time of the original rating, UTC." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "exchange": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Exchange", + "description": "Exchange where the company is traded." + }, + "company_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Company Name", + "description": "Name of company that is the subject of rating." + }, + "analyst_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Analyst Name", + "description": "Analyst name." + }, + "analyst_firm": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Analyst Firm", + "description": "Name of the analyst firm that published the price target." + }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency", + "description": "Currency the data is denominated in." + }, + "price_target": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Target", + "description": "The current price target." + }, + "adj_price_target": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adj Price Target", + "description": "Adjusted price target for splits and stock dividends." + }, + "price_target_previous": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price Target Previous", + "description": "Previous price target." + }, + "previous_adj_price_target": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Previous Adj Price Target", + "description": "Previous adjusted price target." + }, + "price_when_posted": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Price When Posted", + "description": "Price when posted." + }, + "rating_current": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Rating Current", + "description": "The analyst's rating for the company." + }, + "rating_previous": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Rating Previous", + "description": "Previous analyst rating for the company." + }, + "action_company": { + "anyOf": [ + { + "type": "string", + "enum": [ + "Downgrades", + "Maintains", + "Reinstates", + "Reiterates", + "Upgrades", + "Assumes", + "Initiates Coverage On", + "Terminates Coverage On", + "Removes", + "Suspends", + "Firm Dissolved" + ] + }, + { + "type": "null" + } + ], + "title": "Action Company", + "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined." + }, + "action_pt": { + "anyOf": [ + { + "type": "string", + "enum": [ + "Announces", + "Maintains", + "Lowers", + "Raises", + "Removes", + "Adjusts" + ] + }, + { + "type": "null" + } + ], + "title": "Action Pt", + "description": "Description of the change in price target from firm's last price target." + }, + "importance": { + "anyOf": [ + { + "type": "integer", + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5 + ] + }, + { + "type": "null" + } + ], + "title": "Importance", + "description": "Subjective Basis of How Important Event is to Market. 5 = High" + }, + "notes": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Notes", + "description": "Notes of the price target." + }, + "analyst_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Analyst Id", + "description": "Id of the analyst." + }, + "url_news": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url News", + "description": "URL for analyst ratings news articles for this ticker on Benzinga.com." + }, + "url_analyst": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Url Analyst", + "description": "URL for analyst ratings page for this ticker on Benzinga.com." + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id", + "description": "Unique ID of this entry." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated", + "description": "Last updated timestamp, UTC." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "published_date", + "symbol" + ], + "title": "BenzingaPriceTargetData", + "description": "Benzinga Price Target Data." + }, + "BenzingaWorldNewsData": { + "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 article." + }, + "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." + }, + "id": { + "type": "string", + "title": "Id", + "description": "Article ID." + }, + "author": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Author", + "description": "Author of the news." + }, + "teaser": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Teaser", + "description": "Teaser of the news." + }, + "channels": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Channels", + "description": "Channels associated with the news." + }, + "stocks": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Stocks", + "description": "Stocks associated with the news." + }, + "tags": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Tags", + "description": "Tags associated with the news." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Updated", + "description": "Updated date of the news." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "id" + ], + "title": "BenzingaWorldNewsData", + "description": "Benzinga World News Data." + }, + "Chart": { + "properties": { + "content": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Content", + "description": "Raw textual representation of the chart." + }, + "format": { + "anyOf": [ + { + "$ref": "#/components/schemas/ChartFormat" + }, + { + "type": "null" + } + ], + "description": "Complementary attribute to the `content` attribute. It specifies the format of the chart.", + "default": "plotly" + }, + "fig": { + "anyOf": [ + {}, + { + "type": "null" + } + ], + "title": "Fig", + "description": "The figure object.", + "exclude_from_api": true + } + }, + "type": "object", + "title": "Chart", + "description": "Model for Chart." + }, + "ChartFormat": { + "type": "string", + "enum": [ + "plotly" + ], + "const": "plotly", + "title": "ChartFormat", + "description": "Chart format." + }, + "ECBBalanceOfPaymentsData": { + "properties": { + "period": { + "type": "string", + "format": "date", + "title": "Period", + "description": "The date representing the beginning of the reporting period." + }, + "current_account_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account Balance", + "description": "Current Account Balance (Billions of EUR)" + }, + "current_account_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account Credit", + "description": "Current Account Credit (Billions of EUR)" + }, + "current_account_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account Debit", + "description": "Current Account Debit (Billions of EUR)" + }, + "goods_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goods Balance", + "description": "Goods Balance (Billions of EUR)" + }, + "goods_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goods Credit", + "description": "Goods Credit (Billions of EUR)" + }, + "goods_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goods Debit", + "description": "Goods Debit (Billions of EUR)" + }, + "services_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services Balance", + "description": "Services Balance (Billions of EUR)" + }, + "services_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services Credit", + "description": "Services Credit (Billions of EUR)" + }, + "services_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services Debit", + "description": "Services Debit (Billions of EUR)" + }, + "primary_income_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income Balance", + "description": "Primary Income Balance (Billions of EUR)" + }, + "primary_income_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income Credit", + "description": "Primary Income Credit (Billions of EUR)" + }, + "primary_income_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income Debit", + "description": "Primary Income Debit (Billions of EUR)" + }, + "investment_income_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Investment Income Balance", + "description": "Investment Income Balance (Billions of EUR)" + }, + "investment_income_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Investment Income Credit", + "description": "Investment Income Credits (Billions of EUR)" + }, + "investment_income_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Investment Income Debit", + "description": "Investment Income Debits (Billions of EUR)" + }, + "secondary_income_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Secondary Income Balance", + "description": "Secondary Income Balance (Billions of EUR)" + }, + "secondary_income_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Secondary Income Credit", + "description": "Secondary Income Credit (Billions of EUR)" + }, + "secondary_income_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Secondary Income Debit", + "description": "Secondary Income Debit (Billions of EUR)" + }, + "capital_account_balance": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Account Balance", + "description": "Capital Account Balance (Billions of EUR)" + }, + "capital_account_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Account Credit", + "description": "Capital Account Credit (Billions of EUR)" + }, + "capital_account_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Account Debit", + "description": "Capital Account Debit (Billions of EUR)" + }, + "assets_total": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Total", + "description": "Assets Total (Billions of EUR)" + }, + "assets_currency_and_deposits": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Currency And Deposits", + "description": "Assets Currency and Deposits (Billions of EUR)" + }, + "assets_loans": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Loans", + "description": "Assets Loans (Billions of EUR)" + }, + "assets_trade_credit_and_advances": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Trade Credit And Advances", + "description": "Assets Trade Credits and Advances (Billions of EUR)" + }, + "assets_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Eurosystem", + "description": "Assets Eurosystem (Billions of EUR)" + }, + "assets_other_mfi_ex_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Other Mfi Ex Eurosystem", + "description": "Assets Other MFIs outside Eurosystem (Billions of EUR)" + }, + "assets_government": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Government", + "description": "Assets Government (Billions of EUR)" + }, + "assets_other_sectors": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Other Sectors", + "description": "Assets Other Sectors (Billions of EUR)" + }, + "liabilities_total": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Total", + "description": "Liabilities Total (Billions of EUR)" + }, + "liabilities_currency_and_deposits": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Currency And Deposits", + "description": "Liabilities Currency and Deposits (Billions of EUR)" + }, + "liabilities_loans": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Loans", + "description": "Liabilities Loans (Billions of EUR)" + }, + "liabilities_trade_credit_and_advances": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Trade Credit And Advances", + "description": "Liabilities Trade Credits and Advances (Billions of EUR)" + }, + "liabilities_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Eurosystem", + "description": "Liabilities Eurosystem (Billions of EUR)" + }, + "liabilities_other_mfi_ex_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Other Mfi Ex Eurosystem", + "description": "Liabilities Other MFIs outside Eurosystem (Billions of EUR)" + }, + "liabilities_government": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Government", + "description": "Liabilities Government (Billions of EUR)" + }, + "liabilities_other_sectors": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Other Sectors", + "description": "Liabilities Other Sectors (Billions of EUR)" + }, + "assets_equity_and_fund_shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Equity And Fund Shares", + "description": "Assets Equity and Investment Fund Shares (Billions of EUR)" + }, + "assets_equity_shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Equity Shares", + "description": "Assets Equity Shares (Billions of EUR)" + }, + "assets_investment_fund_shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Investment Fund Shares", + "description": "Assets Investment Fund Shares (Billions of EUR)" + }, + "assets_debt_short_term": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Debt Short Term", + "description": "Assets Debt Short Term (Billions of EUR)" + }, + "assets_debt_long_term": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Debt Long Term", + "description": "Assets Debt Long Term (Billions of EUR)" + }, + "assets_resident_sector_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Resident Sector Eurosystem", + "description": "Assets Resident Sector Eurosystem (Billions of EUR)" + }, + "assets_resident_sector_mfi_ex_eurosystem": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Resident Sector Mfi Ex Eurosystem", + "description": "Assets Resident Sector MFIs outside Eurosystem (Billions of EUR)" + }, + "assets_resident_sector_government": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Resident Sector Government", + "description": "Assets Resident Sector Government (Billions of EUR)" + }, + "assets_resident_sector_other": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Resident Sector Other", + "description": "Assets Resident Sector Other (Billions of EUR)" + }, + "liabilities_equity_and_fund_shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Equity And Fund Shares", + "description": "Liabilities Equity and Investment Fund Shares (Billions of EUR)" + }, + "liabilities_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Equity", + "description": "Liabilities Equity (Billions of EUR)" + }, + "liabilities_investment_fund_shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Investment Fund Shares", + "description": "Liabilities Investment Fund Shares (Billions of EUR)" + }, + "liabilities_debt_short_term": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Debt Short Term", + "description": "Liabilities Debt Short Term (Billions of EUR)" + }, + "liabilities_debt_long_term": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Debt Long Term", + "description": "Liabilities Debt Long Term (Billions of EUR)" + }, + "liabilities_resident_sector_government": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Resident Sector Government", + "description": "Liabilities Resident Sector Government (Billions of EUR)" + }, + "liabilities_resident_sector_other": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Resident Sector Other", + "description": "Liabilities Resident Sector Other (Billions of EUR)" + }, + "assets_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Equity", + "description": "Assets Equity (Billions of EUR)" + }, + "assets_debt_instruments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Debt Instruments", + "description": "Assets Debt Instruments (Billions of EUR)" + }, + "assets_mfi": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Mfi", + "description": "Assets MFIs (Billions of EUR)" + }, + "assets_non_mfi": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Non Mfi", + "description": "Assets Non MFIs (Billions of EUR)" + }, + "assets_direct_investment_abroad": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Assets Direct Investment Abroad", + "description": "Assets Direct Investment Abroad (Billions of EUR)" + }, + "liabilities_debt_instruments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Debt Instruments", + "description": "Liabilities Debt Instruments (Billions of EUR)" + }, + "liabilities_mfi": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Mfi", + "description": "Liabilities MFIs (Billions of EUR)" + }, + "liabilities_non_mfi": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Non Mfi", + "description": "Liabilities Non MFIs (Billions of EUR)" + }, + "liabilities_direct_investment_euro_area": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Liabilities Direct Investment Euro Area", + "description": "Liabilities Direct Investment in Euro Area (Billions of EUR)" + }, + "investment_total_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Investment Total Credit", + "description": "Investment Total Credit (Billions of EUR)" + }, + "investment_total_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Investment Total Debit", + "description": "Investment Total Debit (Billions of EUR)" + }, + "equity_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Equity Credit", + "description": "Equity Credit (Billions of EUR)" + }, + "equity_reinvested_earnings_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Equity Reinvested Earnings Credit", + "description": "Equity Reinvested Earnings Credit (Billions of EUR)" + }, + "equity_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Equity Debit", + "description": "Equity Debit (Billions of EUR)" + }, + "equity_reinvested_earnings_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Equity Reinvested Earnings Debit", + "description": "Equity Reinvested Earnings Debit (Billions of EUR)" + }, + "debt_instruments_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt Instruments Credit", + "description": "Debt Instruments Credit (Billions of EUR)" + }, + "debt_instruments_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt Instruments Debit", + "description": "Debt Instruments Debit (Billions of EUR)" + }, + "portfolio_investment_equity_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Investment Equity Credit", + "description": "Portfolio Investment Equity Credit (Billions of EUR)" + }, + "portfolio_investment_equity_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Investment Equity Debit", + "description": "Portfolio Investment Equity Debit (Billions of EUR)" + }, + "portfolio_investment_debt_instruments_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Investment Debt Instruments Credit", + "description": "Portfolio Investment Debt Instruments Credit (Billions of EUR)" + }, + "portofolio_investment_debt_instruments_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portofolio Investment Debt Instruments Debit", + "description": "Portfolio Investment Debt Instruments Debit (Billions of EUR)" + }, + "other_investment_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Investment Credit", + "description": "Other Investment Credit (Billions of EUR)" + }, + "other_investment_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Investment Debit", + "description": "Other Investment Debit (Billions of EUR)" + }, + "reserve_assets_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Reserve Assets Credit", + "description": "Reserve Assets Credit (Billions of EUR)" + }, + "services_total_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services Total Credit", + "description": "Services Total Credit (Billions of EUR)" + }, + "services_total_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services Total Debit", + "description": "Services Total Debit (Billions of EUR)" + }, + "transport_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Transport Credit", + "description": "Transport Credit (Billions of EUR)" + }, + "transport_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Transport Debit", + "description": "Transport Debit (Billions of EUR)" + }, + "travel_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Travel Credit", + "description": "Travel Credit (Billions of EUR)" + }, + "travel_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Travel Debit", + "description": "Travel Debit (Billions of EUR)" + }, + "financial_services_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Financial Services Credit", + "description": "Financial Services Credit (Billions of EUR)" + }, + "financial_services_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Financial Services Debit", + "description": "Financial Services Debit (Billions of EUR)" + }, + "communications_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Communications Credit", + "description": "Communications Credit (Billions of EUR)" + }, + "communications_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Communications Debit", + "description": "Communications Debit (Billions of EUR)" + }, + "other_business_services_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Business Services Credit", + "description": "Other Business Services Credit (Billions of EUR)" + }, + "other_business_services_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Business Services Debit", + "description": "Other Business Services Debit (Billions of EUR)" + }, + "other_services_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Services Credit", + "description": "Other Services Credit (Billions of EUR)" + }, + "other_services_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Services Debit", + "description": "Other Services Debit (Billions of EUR)" + }, + "primary_income_employee_compensation_credit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income Employee Compensation Credit", + "description": "Primary Income Employee Compensation Credit (Billions of EUR)" + }, + "primary_income_employee_compensation_debit": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income Employee Compensation Debit", + "description": "Primary Income Employee Compensation Debit (Billions of EUR)" + }, + "current_account": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account", + "description": "Current Account Balance (Billions of EUR)" + }, + "goods": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goods", + "description": "Goods Balance (Billions of EUR)" + }, + "services": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Services", + "description": "Services Balance (Billions of EUR)" + }, + "primary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Primary Income", + "description": "Primary Income Balance (Billions of EUR)" + }, + "secondary_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Secondary Income", + "description": "Secondary Income Balance (Billions of EUR)" + }, + "capital_account": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Account", + "description": "Capital Account Balance (Billions of EUR)" + }, + "net_lending_to_rest_of_world": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Lending To Rest Of World", + "description": "Balance of net lending to the rest of the world (Billions of EUR)" + }, + "financial_account": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Financial Account", + "description": "Financial Account Balance (Billions of EUR)" + }, + "direct_investment": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Direct Investment", + "description": "Direct Investment Balance (Billions of EUR)" + }, + "portfolio_investment": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Investment", + "description": "Portfolio Investment Balance (Billions of EUR)" + }, + "financial_derivatives": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Financial Derivatives", + "description": "Financial Derivatives Balance (Billions of EUR)" + }, + "other_investment": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Investment", + "description": "Other Investment Balance (Billions of EUR)" + }, + "reserve_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Reserve Assets", + "description": "Reserve Assets Balance (Billions of EUR)" + }, + "errors_and_ommissions": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Errors And Ommissions", + "description": "Errors and Omissions (Billions of EUR)" + } + }, + "additionalProperties": true, + "type": "object", + "title": "ECBBalanceOfPaymentsData", + "description": "ECB Balance of Payments Data." + }, + "ECBCurrencyReferenceRatesData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "eur": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eur", + "description": "Euro." + }, + "usd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Usd", + "description": "US Dollar." + }, + "jpy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Jpy", + "description": "Japanese Yen." + }, + "bgn": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Bgn", + "description": "Bulgarian Lev." + }, + "czk": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Czk", + "description": "Czech Koruna." + }, + "dkk": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dkk", + "description": "Danish Krone." + }, + "gbp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gbp", + "description": "Pound Sterling." + }, + "huf": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Huf", + "description": "Hungarian Forint." + }, + "pln": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pln", + "description": "Polish Zloty." + }, + "ron": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ron", + "description": "Romanian Leu." + }, + "sek": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Sek", + "description": "Swedish Krona." + }, + "chf": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Chf", + "description": "Swiss Franc." + }, + "isk": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Isk", + "description": "Icelandic Krona." + }, + "nok": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Nok", + "description": "Norwegian Krone." + }, + "try": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Try", + "description": "Turkish Lira." + }, + "aud": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Aud", + "description": "Australian Dollar." + }, + "brl": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Brl", + "description": "Brazilian Real." + }, + "cad": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cad", + "description": "Canadian Dollar." + }, + "cny": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cny", + "description": "Chinese Yuan." + }, + "hkd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Hkd", + "description": "Hong Kong Dollar." + }, + "idr": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Idr", + "description": "Indonesian Rupiah." + }, + "ils": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ils", + "description": "Israeli Shekel." + }, + "inr": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Inr", + "description": "Indian Rupee." + }, + "krw": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Krw", + "description": "South Korean Won." + }, + "mxn": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Mxn", + "description": "Mexican Peso." + }, + "myr": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Myr", + "description": "Malaysian Ringgit." + }, + "nzd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Nzd", + "description": "New Zealand Dollar." + }, + "php": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Php", + "description": "Philippine Peso." + }, + "sgd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Sgd", + "description": "Singapore Dollar." + }, + "thb": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Thb", + "description": "Thai Baht." + }, + "zar": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Zar", + "description": "South African Rand." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "ECBCurrencyReferenceRatesData", + "description": "ECB Currency Reference Rates Data." + }, + "ECBEUYieldCurveData": { + "properties": { + "maturity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Maturity", + "description": "Maturity, in years." + }, + "rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Rate", + "description": "Yield curve rate, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "title": "ECBEUYieldCurveData", + "description": "ECB Yield Curve Data." + }, + "ECBYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "ECBYieldCurveData", + "description": "ECB Yield Curve Data." + }, + "EconDbAvailableIndicatorsData": { + "properties": { + "symbol_root": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol Root", + "description": "The root symbol representing the indicator." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. The root symbol with additional codes." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The name of the country, region, or entity represented by the symbol." + }, + "iso": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Iso", + "description": "The ISO code of the country, region, or entity represented by the symbol." + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description", + "description": "The description of the indicator." + }, + "frequency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Frequency", + "description": "The frequency of the indicator data." + }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency", + "description": "The currency, or unit, the data is based in." + }, + "scale": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Scale", + "description": "The scale of the data." + }, + "multiplier": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Multiplier", + "description": "The multiplier of the data to arrive at whole units." + }, + "transformation": { + "type": "string", + "title": "Transformation", + "description": "Transformation type." + }, + "source": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source", + "description": "The original source of the data." + }, + "first_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "First Date", + "description": "The first date of the data." + }, + "last_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Last Date", + "description": "The last date of the data." + }, + "last_insert_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Insert Timestamp", + "description": "The time of the last update. Data is typically reported with a lag." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "multiplier", + "transformation" + ], + "title": "EconDbAvailableIndicatorsData", + "description": "EconDB Available Indicators Data." + }, + "EconDbCountryProfileData": { + "properties": { + "country": { + "type": "string", + "title": "Country", + "description": "" + }, + "population": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Population", + "description": "Population." + }, + "gdp_usd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Usd", + "description": "Gross Domestic Product, in billions of USD." + }, + "gdp_qoq": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Qoq", + "description": "GDP growth quarter-over-quarter change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "gdp_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Gdp Yoy", + "description": "GDP growth year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "cpi_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cpi Yoy", + "description": "Consumer Price Index year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "core_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Core Yoy", + "description": "Core Consumer Price Index year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "retail_sales_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Retail Sales Yoy", + "description": "Retail Sales year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "industrial_production_yoy": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Industrial Production Yoy", + "description": "Industrial Production year-over-year change, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "policy_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Policy Rate", + "description": "Short term policy rate, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "yield_10y": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Yield 10Y", + "description": "10-year government bond yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "govt_debt_gdp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Govt Debt Gdp", + "description": "Government debt as a percent (normalized) of GDP.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "current_account_gdp": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Account Gdp", + "description": "Current account balance as a percent (normalized) of GDP.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "jobless_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Jobless Rate", + "description": "Unemployment rate, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "country" + ], + "title": "EconDbCountryProfileData", + "description": "EconDB Country Profile Data." + }, + "EconDbEconomicIndicatorsData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "symbol_root": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol Root", + "description": "The root symbol for the indicator (e.g. GDP)." + }, + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Country", + "description": "The country represented by the data." + }, + "value": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Value", + "description": "" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "EconDbEconomicIndicatorsData", + "description": "EconDB Economic Indicators Data." + }, + "EconDbYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "EconDbYieldCurveData", + "description": "EconDB Yield Curve Data." + }, + "FMPAnalystEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "estimated_revenue_low": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Revenue Low", + "description": "Estimated revenue low." + }, + "estimated_revenue_high": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Revenue High", + "description": "Estimated revenue high." + }, + "estimated_revenue_avg": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Revenue Avg", + "description": "Estimated revenue average." + }, + "estimated_sga_expense_low": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Sga Expense Low", + "description": "Estimated SGA expense low." + }, + "estimated_sga_expense_high": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Estimated Sga Expense High", + "description": "Estimated SGA expense high." + }, + "estimated_sga_expense_avg": { + "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": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Estimated Eps Avg", + "description": "Estimated EPS average." + }, + "estimated_eps_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Estimated Eps High", + "description": "Estimated EPS high." + }, + "estimated_eps_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Estimated Eps Low", + "description": "Estimated EPS low." + }, + "number_analyst_estimated_revenue": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Analyst Estimated Revenue", + "description": "Number of analysts who estimated revenue." + }, + "number_analysts_estimated_eps": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Analysts Estimated Eps", + "description": "Number of analysts who estimated EPS." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "FMPAnalystEstimatesData", + "description": "FMP Analyst Estimates Data." + }, + "FMPAvailableIndicesData": { + "properties": { + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the index." + }, + "currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Currency", + "description": "Currency the index is traded in." + }, + "stockExchange": { + "type": "string", + "title": "Stockexchange", + "description": "Stock exchange where the index is listed." + }, + "exchangeShortName": { + "type": "string", + "title": "Exchangeshortname", + "description": "Short name of the stock exchange where the index is listed." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "stockExchange", + "exchangeShortName" + ], + "title": "FMPAvailableIndicesData", + "description": "FMP Available Indices Data." + }, + "FMPBalanceSheetData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "The fiscal period of the report." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "The fiscal year of the fiscal period." + }, + "filing_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Filing Date", + "description": "The date when the filing was made." + }, + "accepted_date": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Accepted Date", + "description": "The date and time when the filing was accepted." + }, + "reported_currency": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reported Currency", + "description": "The currency in which the balance sheet was reported." + }, + "cash_and_cash_equivalents": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash And Cash Equivalents", + "description": "Cash and cash equivalents." + }, + "short_term_investments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Short Term Investments", + "description": "Short term investments." + }, + "cash_and_short_term_investments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Cash And Short Term Investments", + "description": "Cash and short term investments." + }, + "net_receivables": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Receivables", + "description": "Net receivables." + }, + "inventory": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Inventory", + "description": "Inventory." + }, + "other_current_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Current Assets", + "description": "Other current assets." + }, + "total_current_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Current Assets", + "description": "Total current assets." + }, + "plant_property_equipment_net": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Plant Property Equipment Net", + "description": "Plant property equipment net." + }, + "goodwill": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goodwill", + "description": "Goodwill." + }, + "intangible_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Intangible Assets", + "description": "Intangible assets." + }, + "goodwill_and_intangible_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Goodwill And Intangible Assets", + "description": "Goodwill and intangible assets." + }, + "long_term_investments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Long Term Investments", + "description": "Long term investments." + }, + "tax_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Tax Assets", + "description": "Tax assets." + }, + "other_non_current_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Non Current Assets", + "description": "Other non current assets." + }, + "non_current_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Non Current Assets", + "description": "Total non current assets." + }, + "other_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Assets", + "description": "Other assets." + }, + "total_assets": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Assets", + "description": "Total assets." + }, + "accounts_payable": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Accounts Payable", + "description": "Accounts payable." + }, + "short_term_debt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Short Term Debt", + "description": "Short term debt." + }, + "tax_payables": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Tax Payables", + "description": "Tax payables." + }, + "current_deferred_revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Current Deferred Revenue", + "description": "Current deferred revenue." + }, + "other_current_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Current Liabilities", + "description": "Other current liabilities." + }, + "total_current_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Current Liabilities", + "description": "Total current liabilities." + }, + "long_term_debt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Long Term Debt", + "description": "Long term debt." + }, + "deferred_revenue_non_current": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Deferred Revenue Non Current", + "description": "Non current deferred revenue." + }, + "deferred_tax_liabilities_non_current": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Deferred Tax Liabilities Non Current", + "description": "Deferred tax liabilities non current." + }, + "other_non_current_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Non Current Liabilities", + "description": "Other non current liabilities." + }, + "total_non_current_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Non Current Liabilities", + "description": "Total non current liabilities." + }, + "other_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Liabilities", + "description": "Other liabilities." + }, + "capital_lease_obligations": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capital Lease Obligations", + "description": "Capital lease obligations." + }, + "total_liabilities": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Liabilities", + "description": "Total liabilities." + }, + "preferred_stock": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Preferred Stock", + "description": "Preferred stock." + }, + "common_stock": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Common Stock", + "description": "Common stock." + }, + "retained_earnings": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Retained Earnings", + "description": "Retained earnings." + }, + "accumulated_other_comprehensive_income": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Accumulated Other Comprehensive Income", + "description": "Accumulated other comprehensive income (loss)." + }, + "other_shareholders_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Shareholders Equity", + "description": "Other shareholders equity." + }, + "other_total_shareholders_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Other Total Shareholders Equity", + "description": "Other total shareholders equity." + }, + "total_common_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Common Equity", + "description": "Total common equity." + }, + "total_equity_non_controlling_interests": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Equity Non Controlling Interests", + "description": "Total equity non controlling interests." + }, + "total_liabilities_and_shareholders_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Liabilities And Shareholders Equity", + "description": "Total liabilities and shareholders equity." + }, + "minority_interest": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minority Interest", + "description": "Minority interest." + }, + "total_liabilities_and_total_equity": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Liabilities And Total Equity", + "description": "Total liabilities and total equity." + }, + "total_investments": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Investments", + "description": "Total investments." + }, + "total_debt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Total Debt", + "description": "Total debt." + }, + "net_debt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Debt", + "description": "Net debt." + }, + "link": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Link", + "description": "Link to the filing." + }, + "final_link": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Final Link", + "description": "Link to the filing document." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending" + ], + "title": "FMPBalanceSheetData", + "description": "FMP Balance Sheet Data." + }, + "FMPBalanceSheetGrowthData": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "period": { + "type": "string", + "title": "Period", + "description": "Reporting period." + }, + "growth_cash_and_cash_equivalents": { + "type": "number", + "title": "Growth Cash And Cash Equivalents", + "description": "Growth rate of cash and cash equivalents." + }, + "growth_short_term_investments": { + "type": "number", + "title": "Growth Short Term Investments", + "description": "Growth rate of short-term investments." + }, + "growth_cash_and_short_term_investments": { + "type": "number", + "title": "Growth Cash And Short Term Investments", + "description": "Growth rate of cash and short-term investments." + }, + "growth_net_receivables": { + "type": "number", + "title": "Growth Net Receivables", + "description": "Growth rate of net receivables." + }, + "growth_inventory": { + "type": "number", + "title": "Growth Inventory", + "description": "Growth rate of inventory." + }, + "growth_other_current_assets": { + "type": "number", + "title": "Growth Other Current Assets", + "description": "Growth rate of other current assets." + }, + "growth_total_current_assets": { + "type": "number", + "title": "Growth Total Current Assets", + "description": "Growth rate of total current assets." + }, + "growth_property_plant_equipment_net": { + "type": "number", + "title": "Growth Property Plant Equipment Net", + "description": "Growth rate of net property, plant, and equipment." + }, + "growth_goodwill": { + "type": "number", + "title": "Growth Goodwill", + "description": "Growth rate of goodwill." + }, + "growth_intangible_assets": { + "type": "number", + "title": "Growth Intangible Assets", + "description": "Growth rate of intangible assets." + }, + "growth_goodwill_and_intangible_assets": { + "type": "number", + "title": "Growth Goodwill And Intangible Assets", + "description": "Growth rate of goodwill and intangible assets." + }, + "growth_long_term_investments": { + "type": "number", + "title": "Growth Long Term Investments", + "description": "Growth rate of long-term investments." + }, + "growth_tax_assets": { + "type": "number", + "title": "Growth Tax Assets", + "description": "Growth rate of tax assets." + }, + "growth_other_non_current_assets": { + "type": "number", + "title": "Growth Other Non Current Assets", + "description": "Growth rate of other non-current assets." + }, + "growth_total_non_current_assets": { + "type": "number", + "title": "Growth Total Non Current Assets", + "description": "Growth rate of total non-current assets." + }, + "growth_other_assets": { + "type": "number", + "title": "Growth Other Assets", + "description": "Growth rate of other assets." + }, + "growth_total_assets": { + "type": "number", + "title": "Growth Total Assets", + "description": "Growth rate of total assets." + }, + "growth_account_payables": { + "type": "number", + "title": "Growth Account Payables", + "description": "Growth rate of accounts payable." + }, + "growth_short_term_debt": { + "type": "number", + "title": "Growth Short Term Debt", + "description": "Growth rate of short-term debt." + }, + "growth_tax_payables": { + "type": "number", + "title": "Growth Tax Payables", + "description": "Growth rate of tax payables." + }, + "growth_deferred_revenue": { + "type": "number", + "title": "Growth Deferred Revenue", + "description": "Growth rate of deferred revenue." + }, + "growth_other_current_liabilities": { + "type": "number", + "title": "Growth Other Current Liabilities", + "description": "Growth rate of other current liabilities." + }, + "growth_total_current_liabilities": { + "type": "number", + "title": "Growth Total Current Liabilities", + "description": "Growth rate of total current liabilities." + }, + "growth_long_term_debt": { + "type": "number", + "title": "Growth Long Term Debt", + "description": "Growth rate of long-term debt." + }, + "growth_deferred_revenue_non_current": { + "type": "number", + "title": "Growth Deferred Revenue Non Current", + "description": "Growth rate of non-current deferred revenue." + }, + "growth_deferrred_tax_liabilities_non_current": { + "type": "number", + "title": "Growth Deferrred Tax Liabilities Non Current", + "description": "Growth rate of non-current deferred tax liabilities." + }, + "growth_other_non_current_liabilities": { + "type": "number", + "title": "Growth Other Non Current Liabilities", + "description": "Growth rate of other non-current liabilities." + }, + "growth_total_non_current_liabilities": { + "type": "number", + "title": "Growth Total Non Current Liabilities", + "description": "Growth rate of total non-current liabilities." + }, + "growth_other_liabilities": { + "type": "number", + "title": "Growth Other Liabilities", + "description": "Growth rate of other liabilities." + }, + "growth_total_liabilities": { + "type": "number", + "title": "Growth Total Liabilities", + "description": "Growth rate of total liabilities." + }, + "growth_common_stock": { + "type": "number", + "title": "Growth Common Stock", + "description": "Growth rate of common stock." + }, + "growth_retained_earnings": { + "type": "number", + "title": "Growth Retained Earnings", + "description": "Growth rate of retained earnings." + }, + "growth_accumulated_other_comprehensive_income_loss": { + "type": "number", + "title": "Growth Accumulated Other Comprehensive Income Loss", + "description": "Growth rate of accumulated other comprehensive income/loss." + }, + "growth_othertotal_stockholders_equity": { + "type": "number", + "title": "Growth Othertotal Stockholders Equity", + "description": "Growth rate of other total stockholders' equity." + }, + "growth_total_stockholders_equity": { + "type": "number", + "title": "Growth Total Stockholders Equity", + "description": "Growth rate of total stockholders' equity." + }, + "growth_total_liabilities_and_stockholders_equity": { + "type": "number", + "title": "Growth Total Liabilities And Stockholders Equity", + "description": "Growth rate of total liabilities and stockholders' equity." + }, + "growth_total_investments": { + "type": "number", + "title": "Growth Total Investments", + "description": "Growth rate of total investments." + }, + "growth_total_debt": { + "type": "number", + "title": "Growth Total Debt", + "description": "Growth rate of total debt." + }, + "growth_net_debt": { + "type": "number", + "title": "Growth Net Debt", + "description": "Growth rate of net debt." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "period", + "growth_cash_and_cash_equivalents", + "growth_short_term_investments", + "growth_cash_and_short_term_investments", + "growth_net_receivables", + "growth_inventory", + "growth_other_current_assets", + "growth_total_current_assets", + "growth_property_plant_equipment_net", + "growth_goodwill", + "growth_intangible_assets", + "growth_goodwill_and_intangible_assets", + "growth_long_term_investments", + "growth_tax_assets", + "growth_other_non_current_assets", + "growth_total_non_current_assets", + "growth_other_assets", + "growth_total_assets", + "growth_account_payables", + "growth_short_term_debt", + "growth_tax_payables", + "growth_deferred_revenue", + "growth_other_current_liabilities", + "growth_total_current_liabilities", + "growth_long_term_debt", + "growth_deferred_revenue_non_current", + "growth_deferrred_tax_liabilities_non_current", + "growth_other_non_current_liabilities", + "growth_total_non_current_liabilities", + "growth_other_liabilities", + "growth_total_liabilities", + "growth_common_stock", + "growth_retained_earnings", + "growth_accumulated_other_comprehensive_income_loss", + "growth_othertotal_stockholders_equity", + "growth_total_stockholders_equity", + "growth_total_liabilities_and_stockholders_equity", + "growth_total_investments", + "growth_total_debt", + "growth_net_debt" + ], + "title": "FMPBalanceSheetGrowthData", + "description": "FMP Balance Sheet Growth Data." + }, + "FMPCalendarDividendData": { + "properties": { + "ex_dividend_date": { + "type": "string", + "format": "date", + "title": "Ex Dividend Date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "amount": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Amount", + "description": "The dividend amount per share." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "record_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Record Date", + "description": "The record date of ownership for eligibility." + }, + "payment_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Payment Date", + "description": "The payment date of the dividend." + }, + "declaration_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Declaration Date", + "description": "Declaration date of the dividend." + }, + "adjDividend": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Adjdividend", + "description": "The adjusted-dividend amount." + }, + "label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Label", + "description": "Ex-dividend date formatted for display." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "ex_dividend_date", + "symbol" + ], + "title": "FMPCalendarDividendData", + "description": "FMP Dividend Calendar Data." + }, + "FMPCalendarEarningsData": { + "properties": { + "report_date": { + "type": "string", + "format": "date", + "title": "Report Date", + "description": "The date of the earnings report." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "eps_previous": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps Previous", + "description": "The earnings-per-share from the same previously reported period." + }, + "eps_consensus": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps Consensus", + "description": "The analyst conesus earnings-per-share estimate." + }, + "eps": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Eps", + "description": "The actual earnings per share announced." + }, + "revenue": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revenue", + "description": "The actual reported revenue." + }, + "revenueEstimated": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Revenueestimated", + "description": "The revenue forecast consensus." + }, + "fiscalDateEnding": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Fiscaldateending", + "description": "The fiscal period end date." + }, + "time": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Time", + "description": "The reporting time - e.g. after market close." + }, + "updatedFromDate": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Updatedfromdate", + "description": "The date the data was updated last." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "report_date", + "symbol" + ], + "title": "FMPCalendarEarningsData", + "description": "FMP Earnings Calendar Data." + }, + "FMPCalendarSplitsData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "label": { + "type": "string", + "title": "Label", + "description": "Label of the stock splits." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "numerator": { + "type": "number", + "title": "Numerator", + "description": "Numerator of the stock splits." + }, + "denominator": { + "type": "number", + "title": "Denominator", + "description": "Denominator of the stock splits." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "label", + "symbol", + "numerator", + "denominator" + ], + "title": "FMPCalendarSplitsData", + "description": "FMP Calendar Splits Data." + }, + "FMPCashFlowStatementData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_period": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Total Ratings", - "description": "Number of recommendations made by this analyst." + "title": "Fiscal Period", + "description": "The fiscal period of the report." }, - "overall_gain_count": { + "fiscal_year": { "anyOf": [ { "type": "integer" @@ -20566,74 +28137,72 @@ "type": "null" } ], - "title": "Overall Gain Count", - "description": "The number of ratings that have gained value since the date of recommendation" + "title": "Fiscal Year", + "description": "The fiscal year of the fiscal period." }, - "overall_loss_count": { + "filing_date": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Overall Loss Count", - "description": "The number of ratings that have lost value since the date of recommendation" + "title": "Filing Date", + "description": "The date of the filing." }, - "overall_average_return": { + "accepted_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Overall Average Return", - "description": "The average percent (normalized) price difference per rating since the date of recommendation", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Accepted Date", + "description": "The date the filing was accepted." }, - "overall_std_dev": { + "reported_currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Overall Std Dev", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Reported Currency", + "description": "The currency in which the cash flow statement was reported." }, - "gain_count_1m": { + "net_income": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 1M", - "description": "The number of ratings that have gained value over the last month" + "title": "Net Income", + "description": "Net income." }, - "loss_count_1m": { + "depreciation_and_amortization": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 1M", - "description": "The number of ratings that have lost value over the last month" + "title": "Depreciation And Amortization", + "description": "Depreciation and amortization." }, - "average_return_1m": { + "deferred_income_tax": { "anyOf": [ { "type": "number" @@ -20642,12 +28211,10 @@ "type": "null" } ], - "title": "Average Return 1M", - "description": "The average percent (normalized) price difference per rating over the last month", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Deferred Income Tax", + "description": "Deferred income tax." }, - "std_dev_1m": { + "stock_based_compensation": { "anyOf": [ { "type": "number" @@ -20656,36 +28223,34 @@ "type": "null" } ], - "title": "Std Dev 1M", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Stock Based Compensation", + "description": "Stock-based compensation." }, - "gain_count_3m": { + "change_in_working_capital": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 3M", - "description": "The number of ratings that have gained value over the last 3 months" + "title": "Change In Working Capital", + "description": "Change in working capital." }, - "loss_count_3m": { + "change_in_account_receivables": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 3M", - "description": "The number of ratings that have lost value over the last 3 months" + "title": "Change In Account Receivables", + "description": "Change in account receivables." }, - "average_return_3m": { + "change_in_inventory": { "anyOf": [ { "type": "number" @@ -20694,12 +28259,10 @@ "type": "null" } ], - "title": "Average Return 3M", - "description": "The average percent (normalized) price difference per rating over the last 3 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Change In Inventory", + "description": "Change in inventory." }, - "std_dev_3m": { + "change_in_account_payable": { "anyOf": [ { "type": "number" @@ -20708,36 +28271,34 @@ "type": "null" } ], - "title": "Std Dev 3M", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Change In Account Payable", + "description": "Change in account payable." }, - "gain_count_6m": { + "change_in_other_working_capital": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 6M", - "description": "The number of ratings that have gained value over the last 6 months" + "title": "Change In Other Working Capital", + "description": "Change in other working capital." }, - "loss_count_6m": { + "change_in_other_non_cash_items": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 6M", - "description": "The number of ratings that have lost value over the last 6 months" + "title": "Change In Other Non Cash Items", + "description": "Change in other non-cash items." }, - "average_return_6m": { + "net_cash_from_operating_activities": { "anyOf": [ { "type": "number" @@ -20746,12 +28307,10 @@ "type": "null" } ], - "title": "Average Return 6M", - "description": "The average percent (normalized) price difference per rating over the last 6 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Net Cash From Operating Activities", + "description": "Net cash from operating activities." }, - "std_dev_6m": { + "purchase_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" @@ -20760,36 +28319,34 @@ "type": "null" } ], - "title": "Std Dev 6M", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Purchase Of Property Plant And Equipment", + "description": "Purchase of property, plant and equipment." }, - "gain_count_9m": { + "acquisitions": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 9M", - "description": "The number of ratings that have gained value over the last 9 months" + "title": "Acquisitions", + "description": "Acquisitions." }, - "loss_count_9m": { + "purchase_of_investment_securities": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 9M", - "description": "The number of ratings that have lost value over the last 9 months" + "title": "Purchase Of Investment Securities", + "description": "Purchase of investment securities." }, - "average_return_9m": { + "sale_and_maturity_of_investments": { "anyOf": [ { "type": "number" @@ -20798,12 +28355,10 @@ "type": "null" } ], - "title": "Average Return 9M", - "description": "The average percent (normalized) price difference per rating over the last 9 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Sale And Maturity Of Investments", + "description": "Sale and maturity of investments." }, - "std_dev_9m": { + "other_investing_activities": { "anyOf": [ { "type": "number" @@ -20812,36 +28367,34 @@ "type": "null" } ], - "title": "Std Dev 9M", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Investing Activities", + "description": "Other investing activities." }, - "gain_count_1y": { + "net_cash_from_investing_activities": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 1Y", - "description": "The number of ratings that have gained value over the last 1 year" + "title": "Net Cash From Investing Activities", + "description": "Net cash from investing activities." }, - "loss_count_1y": { + "repayment_of_debt": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 1Y", - "description": "The number of ratings that have lost value over the last 1 year" + "title": "Repayment Of Debt", + "description": "Repayment of debt." }, - "average_return_1y": { + "issuance_of_common_equity": { "anyOf": [ { "type": "number" @@ -20850,12 +28403,10 @@ "type": "null" } ], - "title": "Average Return 1Y", - "description": "The average percent (normalized) price difference per rating over the last 1 year", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Issuance Of Common Equity", + "description": "Issuance of common equity." }, - "std_dev_1y": { + "repurchase_of_common_equity": { "anyOf": [ { "type": "number" @@ -20864,36 +28415,34 @@ "type": "null" } ], - "title": "Std Dev 1Y", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Repurchase Of Common Equity", + "description": "Repurchase of common equity." }, - "gain_count_2y": { + "payment_of_dividends": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 2Y", - "description": "The number of ratings that have gained value over the last 2 years" + "title": "Payment Of Dividends", + "description": "Payment of dividends." }, - "loss_count_2y": { + "other_financing_activities": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 2Y", - "description": "The number of ratings that have lost value over the last 2 years" + "title": "Other Financing Activities", + "description": "Other financing activities." }, - "average_return_2y": { + "net_cash_from_financing_activities": { "anyOf": [ { "type": "number" @@ -20902,12 +28451,10 @@ "type": "null" } ], - "title": "Average Return 2Y", - "description": "The average percent (normalized) price difference per rating over the last 2 years", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Net Cash From Financing Activities", + "description": "Net cash from financing activities." }, - "std_dev_2y": { + "effect_of_exchange_rate_changes_on_cash": { "anyOf": [ { "type": "number" @@ -20916,36 +28463,34 @@ "type": "null" } ], - "title": "Std Dev 2Y", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Effect Of Exchange Rate Changes On Cash", + "description": "Effect of exchange rate changes on cash." }, - "gain_count_3y": { + "net_change_in_cash_and_equivalents": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Gain Count 3Y", - "description": "The number of ratings that have gained value over the last 3 years" + "title": "Net Change In Cash And Equivalents", + "description": "Net change in cash and equivalents." }, - "loss_count_3y": { + "cash_at_beginning_of_period": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Loss Count 3Y", - "description": "The number of ratings that have lost value over the last 3 years" + "title": "Cash At Beginning Of Period", + "description": "Cash at beginning of period." }, - "average_return_3y": { + "cash_at_end_of_period": { "anyOf": [ { "type": "number" @@ -20954,12 +28499,10 @@ "type": "null" } ], - "title": "Average Return 3Y", - "description": "The average percent (normalized) price difference per rating over the last 3 years", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Cash At End Of Period", + "description": "Cash at end of period." }, - "std_dev_3y": { + "operating_cash_flow": { "anyOf": [ { "type": "number" @@ -20968,69 +28511,33 @@ "type": "null" } ], - "title": "Std Dev 3Y", - "description": "The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "name_full" - ], - "title": "BenzingaAnalystSearch", - "description": "Benzinga Analyst Search Data." - }, - "BenzingaCompanyNews": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. Here it is the published date of the article." - }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the article." + "title": "Operating Cash Flow", + "description": "Operating cash flow." }, - "text": { + "capital_expenditure": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Capital Expenditure", + "description": "Capital expenditure." }, - "images": { + "free_cash_flow": { "anyOf": [ { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" + "type": "number" }, { "type": "null" } ], - "title": "Images", - "description": "URL to the images of the news." - }, - "url": { - "type": "string", - "title": "Url", - "description": "URL to the article." + "title": "Free Cash Flow" }, - "symbols": { + "link": { "anyOf": [ { "type": "string" @@ -21039,15 +28546,10 @@ "type": "null" } ], - "title": "Symbols", - "description": "Symbols associated with the article." - }, - "id": { - "type": "string", - "title": "Id", - "description": "Article ID." + "title": "Link", + "description": "Link to the filing." }, - "author": { + "final_link": { "anyOf": [ { "type": "string" @@ -21056,10 +28558,21 @@ "type": "null" } ], - "title": "Author", - "description": "Author of the article." - }, - "teaser": { + "title": "Final Link", + "description": "Link to the filing document." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending" + ], + "title": "FMPCashFlowStatementData", + "description": "FMP Cash Flow Statement Data." + }, + "FMPCashFlowStatementGrowthData": { + "properties": { + "symbol": { "anyOf": [ { "type": "string" @@ -21068,105 +28581,232 @@ "type": "null" } ], - "title": "Teaser", - "description": "Teaser of the news." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "channels": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Channels", - "description": "Channels associated with the news." + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "stocks": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Stocks", - "description": "Stocks associated with the news." + "period": { + "type": "string", + "title": "Period", + "description": "Period the statement is returned for." }, - "tags": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Tags", - "description": "Tags associated with the news." + "growth_net_income": { + "type": "number", + "title": "Growth Net Income", + "description": "Growth rate of net income." }, - "updated": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated", - "description": "Updated date of the news." + "growth_depreciation_and_amortization": { + "type": "number", + "title": "Growth Depreciation And Amortization", + "description": "Growth rate of depreciation and amortization." + }, + "growth_deferred_income_tax": { + "type": "number", + "title": "Growth Deferred Income Tax", + "description": "Growth rate of deferred income tax." + }, + "growth_stock_based_compensation": { + "type": "number", + "title": "Growth Stock Based Compensation", + "description": "Growth rate of stock-based compensation." + }, + "growth_change_in_working_capital": { + "type": "number", + "title": "Growth Change In Working Capital", + "description": "Growth rate of change in working capital." + }, + "growth_accounts_receivables": { + "type": "number", + "title": "Growth Accounts Receivables", + "description": "Growth rate of accounts receivables." + }, + "growth_inventory": { + "type": "number", + "title": "Growth Inventory", + "description": "Growth rate of inventory." + }, + "growth_accounts_payables": { + "type": "number", + "title": "Growth Accounts Payables", + "description": "Growth rate of accounts payables." + }, + "growth_other_working_capital": { + "type": "number", + "title": "Growth Other Working Capital", + "description": "Growth rate of other working capital." + }, + "growth_other_non_cash_items": { + "type": "number", + "title": "Growth Other Non Cash Items", + "description": "Growth rate of other non-cash items." + }, + "growth_net_cash_provided_by_operating_activities": { + "type": "number", + "title": "Growth Net Cash Provided By Operating Activities", + "description": "Growth rate of net cash provided by operating activities." + }, + "growth_investments_in_property_plant_and_equipment": { + "type": "number", + "title": "Growth Investments In Property Plant And Equipment", + "description": "Growth rate of investments in property, plant, and equipment." + }, + "growth_acquisitions_net": { + "type": "number", + "title": "Growth Acquisitions Net", + "description": "Growth rate of net acquisitions." + }, + "growth_purchases_of_investments": { + "type": "number", + "title": "Growth Purchases Of Investments", + "description": "Growth rate of purchases of investments." + }, + "growth_sales_maturities_of_investments": { + "type": "number", + "title": "Growth Sales Maturities Of Investments", + "description": "Growth rate of sales maturities of investments." + }, + "growth_other_investing_activities": { + "type": "number", + "title": "Growth Other Investing Activities", + "description": "Growth rate of other investing activities." + }, + "growth_net_cash_used_for_investing_activities": { + "type": "number", + "title": "Growth Net Cash Used For Investing Activities", + "description": "Growth rate of net cash used for investing activities." + }, + "growth_debt_repayment": { + "type": "number", + "title": "Growth Debt Repayment", + "description": "Growth rate of debt repayment." + }, + "growth_common_stock_issued": { + "type": "number", + "title": "Growth Common Stock Issued", + "description": "Growth rate of common stock issued." + }, + "growth_common_stock_repurchased": { + "type": "number", + "title": "Growth Common Stock Repurchased", + "description": "Growth rate of common stock repurchased." + }, + "growth_dividends_paid": { + "type": "number", + "title": "Growth Dividends Paid", + "description": "Growth rate of dividends paid." + }, + "growth_other_financing_activities": { + "type": "number", + "title": "Growth Other Financing Activities", + "description": "Growth rate of other financing activities." + }, + "growth_net_cash_used_provided_by_financing_activities": { + "type": "number", + "title": "Growth Net Cash Used Provided By Financing Activities", + "description": "Growth rate of net cash used/provided by financing activities." + }, + "growth_effect_of_forex_changes_on_cash": { + "type": "number", + "title": "Growth Effect Of Forex Changes On Cash", + "description": "Growth rate of the effect of foreign exchange changes on cash." + }, + "growth_net_change_in_cash": { + "type": "number", + "title": "Growth Net Change In Cash", + "description": "Growth rate of net change in cash." + }, + "growth_cash_at_end_of_period": { + "type": "number", + "title": "Growth Cash At End Of Period", + "description": "Growth rate of cash at the end of the period." + }, + "growth_cash_at_beginning_of_period": { + "type": "number", + "title": "Growth Cash At Beginning Of Period", + "description": "Growth rate of cash at the beginning of the period." + }, + "growth_operating_cash_flow": { + "type": "number", + "title": "Growth Operating Cash Flow", + "description": "Growth rate of operating cash flow." + }, + "growth_capital_expenditure": { + "type": "number", + "title": "Growth Capital Expenditure", + "description": "Growth rate of capital expenditure." + }, + "growth_free_cash_flow": { + "type": "number", + "title": "Growth Free Cash Flow", + "description": "Growth rate of free cash flow." } }, "additionalProperties": true, "type": "object", "required": [ "date", - "title", - "url", - "id" + "period", + "growth_net_income", + "growth_depreciation_and_amortization", + "growth_deferred_income_tax", + "growth_stock_based_compensation", + "growth_change_in_working_capital", + "growth_accounts_receivables", + "growth_inventory", + "growth_accounts_payables", + "growth_other_working_capital", + "growth_other_non_cash_items", + "growth_net_cash_provided_by_operating_activities", + "growth_investments_in_property_plant_and_equipment", + "growth_acquisitions_net", + "growth_purchases_of_investments", + "growth_sales_maturities_of_investments", + "growth_other_investing_activities", + "growth_net_cash_used_for_investing_activities", + "growth_debt_repayment", + "growth_common_stock_issued", + "growth_common_stock_repurchased", + "growth_dividends_paid", + "growth_other_financing_activities", + "growth_net_cash_used_provided_by_financing_activities", + "growth_effect_of_forex_changes_on_cash", + "growth_net_change_in_cash", + "growth_cash_at_end_of_period", + "growth_cash_at_beginning_of_period", + "growth_operating_cash_flow", + "growth_capital_expenditure", + "growth_free_cash_flow" ], - "title": "BenzingaCompanyNews", - "description": "Benzinga Company News Data." + "title": "FMPCashFlowStatementGrowthData", + "description": "FMP Cash Flow Statement Growth Data." }, - "BenzingaPriceTarget": { + "FMPCompanyFilingsData": { "properties": { - "published_date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" - } - ], - "title": "Published Date", - "description": "Published date of the price target." + "filing_date": { + "type": "string", + "format": "date", + "title": "Filing Date", + "description": "The date of the filing." }, - "published_time": { + "accepted_date": { "anyOf": [ { "type": "string", - "format": "time" + "format": "date-time" }, { "type": "null" } ], - "title": "Published Time", - "description": "Time of the original rating, UTC." + "title": "Accepted Date", + "description": "Accepted date of the filing." }, "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "exchange": { "anyOf": [ { "type": "string" @@ -21175,10 +28815,10 @@ "type": "null" } ], - "title": "Exchange", - "description": "Exchange where the company is traded." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "company_name": { + "cik": { "anyOf": [ { "type": "string" @@ -21187,10 +28827,10 @@ "type": "null" } ], - "title": "Company Name", - "description": "Name of company that is the subject of rating." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "analyst_name": { + "report_type": { "anyOf": [ { "type": "string" @@ -21199,10 +28839,10 @@ "type": "null" } ], - "title": "Analyst Name", - "description": "Analyst name." + "title": "Report Type", + "description": "Type of filing." }, - "analyst_firm": { + "filing_url": { "anyOf": [ { "type": "string" @@ -21211,10 +28851,38 @@ "type": "null" } ], - "title": "Analyst Firm", - "description": "Name of the analyst firm that published the price target." + "title": "Filing Url", + "description": "URL to the filing page." }, - "currency": { + "report_url": { + "type": "string", + "title": "Report Url", + "description": "URL to the actual report." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "filing_date", + "report_url" + ], + "title": "FMPCompanyFilingsData", + "description": "FMP Company Filings Data." + }, + "FMPCompanyNewsData": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data. Here it is the published date of the article." + }, + "title": { + "type": "string", + "title": "Title", + "description": "Title of the article." + }, + "text": { "anyOf": [ { "type": "string" @@ -21223,46 +28891,69 @@ "type": "null" } ], - "title": "Currency", - "description": "Currency the data is denominated in." + "title": "Text", + "description": "Text/body of the article." }, - "price_target": { + "images": { "anyOf": [ { - "type": "number" + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" }, { "type": "null" } ], - "title": "Price Target", - "description": "The current price target." + "title": "Images", + "description": "Images associated with the article." }, - "adj_price_target": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Adj Price Target", - "description": "Adjusted price target for splits and stock dividends." + "url": { + "type": "string", + "title": "Url", + "description": "URL to the article." }, - "price_target_previous": { + "symbols": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Price Target Previous", - "description": "Previous price target." + "title": "Symbols", + "description": "Symbols associated with the article." }, - "previous_adj_price_target": { + "source": { + "type": "string", + "title": "Source", + "description": "Name of the news source." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "url", + "source" + ], + "title": "FMPCompanyNewsData", + "description": "FMP Company News Data." + }, + "FMPCompanyOverviewData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "price": { "anyOf": [ { "type": "number" @@ -21271,10 +28962,10 @@ "type": "null" } ], - "title": "Previous Adj Price Target", - "description": "Previous adjusted price target." + "title": "Price", + "description": "Price of the company." }, - "price_when_posted": { + "beta": { "anyOf": [ { "type": "number" @@ -21283,99 +28974,70 @@ "type": "null" } ], - "title": "Price When Posted", - "description": "Price when posted." + "title": "Beta", + "description": "Beta of the company." }, - "rating_current": { + "vol_avg": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Rating Current", - "description": "The analyst's rating for the company." + "title": "Vol Avg", + "description": "Volume average of the company." }, - "rating_previous": { + "mkt_cap": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Rating Previous", - "description": "Previous analyst rating for the company." + "title": "Mkt Cap", + "description": "Market capitalization of the company." }, - "action": { + "last_div": { "anyOf": [ { - "type": "string", - "enum": [ - "Downgrades", - "Maintains", - "Reinstates", - "Reiterates", - "Upgrades", - "Assumes", - "Initiates Coverage On", - "Terminates Coverage On", - "Removes", - "Suspends", - "Firm Dissolved" - ] + "type": "number" }, { "type": "null" } ], - "title": "Action", - "description": "Description of the change in rating from firm's last rating.Note that all of these terms are precisely defined." + "title": "Last Div", + "description": "Last dividend of the company." }, - "action_change": { + "range": { "anyOf": [ { - "type": "string", - "enum": [ - "Announces", - "Maintains", - "Lowers", - "Raises", - "Removes", - "Adjusts" - ] + "type": "string" }, { "type": "null" } ], - "title": "Action Change", - "description": "Description of the change in price target from firm's last price target." + "title": "Range", + "description": "Range of the company." }, - "importance": { + "changes": { "anyOf": [ { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 3, - 4, - 5 - ] + "type": "number" }, { "type": "null" } ], - "title": "Importance", - "description": "Subjective Basis of How Important Event is to Market. 5 = High" + "title": "Changes", + "description": "Changes of the company." }, - "notes": { + "company_name": { "anyOf": [ { "type": "string" @@ -21384,10 +29046,10 @@ "type": "null" } ], - "title": "Notes", - "description": "Notes of the price target." + "title": "Company Name", + "description": "Company name of the company." }, - "analyst_id": { + "currency": { "anyOf": [ { "type": "string" @@ -21396,10 +29058,10 @@ "type": "null" } ], - "title": "Analyst Id", - "description": "Id of the analyst." + "title": "Currency", + "description": "Currency of the company." }, - "url_news": { + "cik": { "anyOf": [ { "type": "string" @@ -21408,10 +29070,10 @@ "type": "null" } ], - "title": "Url News", - "description": "URL for analyst ratings news articles for this ticker on Benzinga.com." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "url_analyst": { + "isin": { "anyOf": [ { "type": "string" @@ -21420,10 +29082,10 @@ "type": "null" } ], - "title": "Url Analyst", - "description": "URL for analyst ratings page for this ticker on Benzinga.com." + "title": "Isin", + "description": "ISIN of the company." }, - "id": { + "cusip": { "anyOf": [ { "type": "string" @@ -21432,64 +29094,10 @@ "type": "null" } ], - "title": "Id", - "description": "Unique ID of this entry." - }, - "last_updated": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Updated", - "description": "Last updated timestamp, UTC." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "published_date", - "symbol" - ], - "title": "BenzingaPriceTarget", - "description": "Benzinga Price Target Data." - }, - "BenzingaWorldNews": { - "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 article." + "title": "Cusip", + "description": "CUSIP of the company." }, - "text": { + "exchange": { "anyOf": [ { "type": "string" @@ -21498,10 +29106,10 @@ "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Exchange", + "description": "Exchange of the company." }, - "url": { + "exchange_short_name": { "anyOf": [ { "type": "string" @@ -21510,15 +29118,10 @@ "type": "null" } ], - "title": "Url", - "description": "URL to the article." - }, - "id": { - "type": "string", - "title": "Id", - "description": "Article ID." + "title": "Exchange Short Name", + "description": "Exchange short name of the company." }, - "author": { + "industry": { "anyOf": [ { "type": "string" @@ -21527,10 +29130,10 @@ "type": "null" } ], - "title": "Author", - "description": "Author of the news." + "title": "Industry", + "description": "Industry of the company." }, - "teaser": { + "website": { "anyOf": [ { "type": "string" @@ -21539,10 +29142,10 @@ "type": "null" } ], - "title": "Teaser", - "description": "Teaser of the news." + "title": "Website", + "description": "Website of the company." }, - "channels": { + "description": { "anyOf": [ { "type": "string" @@ -21551,10 +29154,10 @@ "type": "null" } ], - "title": "Channels", - "description": "Channels associated with the news." + "title": "Description", + "description": "Description of the company." }, - "stocks": { + "ceo": { "anyOf": [ { "type": "string" @@ -21563,10 +29166,10 @@ "type": "null" } ], - "title": "Stocks", - "description": "Stocks associated with the news." + "title": "Ceo", + "description": "CEO of the company." }, - "tags": { + "sector": { "anyOf": [ { "type": "string" @@ -21575,175 +29178,94 @@ "type": "null" } ], - "title": "Tags", - "description": "Tags associated with the news." - }, - "updated": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated", - "description": "Updated date of the news." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "title", - "id" - ], - "title": "BenzingaWorldNews", - "description": "Benzinga World News Data." - }, - "Chart": { - "properties": { - "content": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Content", - "description": "Raw textual representation of the chart." - }, - "format": { - "anyOf": [ - { - "$ref": "#/components/schemas/ChartFormat" - }, - { - "type": "null" - } - ], - "description": "Complementary attribute to the `content` attribute. It specifies the format of the chart.", - "default": "plotly" - }, - "fig": { - "anyOf": [ - {}, - { - "type": "null" - } - ], - "title": "Fig", - "description": "The figure object.", - "exclude_from_api": true - } - }, - "type": "object", - "title": "Chart" - }, - "ChartFormat": { - "type": "string", - "enum": [ - "plotly" - ], - "const": "plotly", - "title": "ChartFormat" - }, - "ECBBalanceOfPayments": { - "properties": { - "period": { - "type": "string", - "format": "date", - "title": "Period", - "description": "The date representing the beginning of the reporting period." + "title": "Sector", + "description": "Sector of the company." }, - "current_account_balance": { + "country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Account Balance", - "description": "Current Account Balance (Billions of EUR)" + "title": "Country", + "description": "Country of the company." }, - "current_account_credit": { + "full_time_employees": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Account Credit", - "description": "Current Account Credit (Billions of EUR)" + "title": "Full Time Employees", + "description": "Full time employees of the company." }, - "current_account_debit": { + "phone": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Account Debit", - "description": "Current Account Debit (Billions of EUR)" + "title": "Phone", + "description": "Phone of the company." }, - "goods_balance": { + "address": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Goods Balance", - "description": "Goods Balance (Billions of EUR)" + "title": "Address", + "description": "Address of the company." }, - "goods_credit": { + "city": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Goods Credit", - "description": "Goods Credit (Billions of EUR)" + "title": "City", + "description": "City of the company." }, - "goods_debit": { + "state": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Goods Debit", - "description": "Goods Debit (Billions of EUR)" + "title": "State", + "description": "State of the company." }, - "services_balance": { + "zip": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Services Balance", - "description": "Services Balance (Billions of EUR)" + "title": "Zip", + "description": "Zip of the company." }, - "services_credit": { + "dcf_diff": { "anyOf": [ { "type": "number" @@ -21752,10 +29274,10 @@ "type": "null" } ], - "title": "Services Credit", - "description": "Services Credit (Billions of EUR)" + "title": "Dcf Diff", + "description": "Discounted cash flow difference of the company." }, - "services_debit": { + "dcf": { "anyOf": [ { "type": "number" @@ -21764,58 +29286,132 @@ "type": "null" } ], - "title": "Services Debit", - "description": "Services Debit (Billions of EUR)" + "title": "Dcf", + "description": "Discounted cash flow of the company." }, - "primary_income_balance": { + "image": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Primary Income Balance", - "description": "Primary Income Balance (Billions of EUR)" + "title": "Image", + "description": "Image of the company." }, - "primary_income_credit": { + "ipo_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Primary Income Credit", - "description": "Primary Income Credit (Billions of EUR)" + "title": "Ipo Date", + "description": "IPO date of the company." }, - "primary_income_debit": { + "default_image": { + "type": "boolean", + "title": "Default Image", + "description": "If the image is the default image." + }, + "is_etf": { + "type": "boolean", + "title": "Is Etf", + "description": "If the company is an ETF." + }, + "is_actively_trading": { + "type": "boolean", + "title": "Is Actively Trading", + "description": "If the company is actively trading." + }, + "is_adr": { + "type": "boolean", + "title": "Is Adr", + "description": "If the company is an ADR." + }, + "is_fund": { + "type": "boolean", + "title": "Is Fund", + "description": "If the company is a fund." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "default_image", + "is_etf", + "is_actively_trading", + "is_adr", + "is_fund" + ], + "title": "FMPCompanyOverviewData", + "description": "FMP Company Overview Data." + }, + "FMPCryptoHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Primary Income Debit", - "description": "Primary Income Debit (Billions of EUR)" + "title": "Date", + "description": "The date of the data." }, - "investment_income_balance": { + "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" + "type": "number", + "exclusiveMinimum": 0.0 }, { "type": "null" } ], - "title": "Investment Income Balance", - "description": "Investment Income Balance (Billions of EUR)" + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, - "investment_income_credit": { + "adj_close": { "anyOf": [ { "type": "number" @@ -21824,10 +29420,10 @@ "type": "null" } ], - "title": "Investment Income Credit", - "description": "Investment Income Credits (Billions of EUR)" + "title": "Adj Close", + "description": "The adjusted close price." }, - "investment_income_debit": { + "change": { "anyOf": [ { "type": "number" @@ -21836,10 +29432,10 @@ "type": "null" } ], - "title": "Investment Income Debit", - "description": "Investment Income Debits (Billions of EUR)" + "title": "Change", + "description": "Change in the price from the previous close." }, - "secondary_income_balance": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -21848,70 +29444,130 @@ "type": "null" } ], - "title": "Secondary Income Balance", - "description": "Secondary Income Balance (Billions of EUR)" + "title": "Changeovertime", + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "open", + "high", + "low", + "close", + "volume" + ], + "title": "FMPCryptoHistoricalData", + "description": "FMP Crypto Historical Price Data." + }, + "FMPCryptoSearchData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (Crypto)" }, - "secondary_income_credit": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Secondary Income Credit", - "description": "Secondary Income Credit (Billions of EUR)" + "title": "Name", + "description": "Name of the crypto." }, - "secondary_income_debit": { + "currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Secondary Income Debit", - "description": "Secondary Income Debit (Billions of EUR)" + "title": "Currency", + "description": "The currency the crypto trades for." }, - "capital_account_balance": { + "stockExchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Capital Account Balance", - "description": "Capital Account Balance (Billions of EUR)" + "title": "Stockexchange", + "description": "The exchange code the crypto trades on." }, - "capital_account_credit": { + "exchangeShortName": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Capital Account Credit", - "description": "Capital Account Credit (Billions of EUR)" - }, - "capital_account_debit": { + "title": "Exchangeshortname", + "description": "The short name of the exchange the crypto trades on." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPCryptoSearchData", + "description": "FMP Crypto Search Data." + }, + "FMPCurrencyHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Capital Account Debit", - "description": "Capital Account Debit (Billions of EUR)" + "title": "Date", + "description": "The date of the data." }, - "assets_total": { + "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" @@ -21920,22 +29576,23 @@ "type": "null" } ], - "title": "Assets Total", - "description": "Assets Total (Billions of EUR)" + "title": "Volume", + "description": "The trading volume." }, - "assets_currency_and_deposits": { + "vwap": { "anyOf": [ { - "type": "number" + "type": "number", + "exclusiveMinimum": 0.0 }, { "type": "null" } ], - "title": "Assets Currency And Deposits", - "description": "Assets Currency and Deposits (Billions of EUR)" + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, - "assets_loans": { + "adj_close": { "anyOf": [ { "type": "number" @@ -21944,10 +29601,10 @@ "type": "null" } ], - "title": "Assets Loans", - "description": "Assets Loans (Billions of EUR)" + "title": "Adj Close", + "description": "The adjusted close price." }, - "assets_trade_credit_and_advances": { + "change": { "anyOf": [ { "type": "number" @@ -21956,10 +29613,10 @@ "type": "null" } ], - "title": "Assets Trade Credit And Advances", - "description": "Assets Trade Credits and Advances (Billions of EUR)" + "title": "Change", + "description": "Change in the price from the previous close." }, - "assets_eurosystem": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -21968,46 +29625,100 @@ "type": "null" } ], - "title": "Assets Eurosystem", - "description": "Assets Eurosystem (Billions of EUR)" + "title": "Changeovertime", + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "open", + "high", + "low", + "close" + ], + "title": "FMPCurrencyHistoricalData", + "description": "FMP Currency Historical Price Data." + }, + "FMPCurrencyPairsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol of the currency pair." }, - "assets_other_mfi_ex_eurosystem": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Other Mfi Ex Eurosystem", - "description": "Assets Other MFIs outside Eurosystem (Billions of EUR)" + "title": "Name", + "description": "Name of the currency pair." }, - "assets_government": { + "currency": { + "type": "string", + "title": "Currency", + "description": "Base currency of the currency pair." + }, + "stock_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Government", - "description": "Assets Government (Billions of EUR)" + "title": "Stock Exchange", + "description": "Stock exchange of the currency pair." }, - "assets_other_sectors": { + "exchange_short_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Other Sectors", - "description": "Assets Other Sectors (Billions of EUR)" + "title": "Exchange Short Name", + "description": "Short name of the stock exchange of the currency pair." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "currency" + ], + "title": "FMPCurrencyPairsData", + "description": "FMP Currency Available Pairs Data." + }, + "FMPCurrencySnapshotsData": { + "properties": { + "base_currency": { + "type": "string", + "title": "Base Currency", + "description": "The base, or domestic, currency." }, - "liabilities_total": { + "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" @@ -22016,10 +29727,10 @@ "type": "null" } ], - "title": "Liabilities Total", - "description": "Liabilities Total (Billions of EUR)" + "title": "Open", + "description": "The open price." }, - "liabilities_currency_and_deposits": { + "high": { "anyOf": [ { "type": "number" @@ -22028,10 +29739,10 @@ "type": "null" } ], - "title": "Liabilities Currency And Deposits", - "description": "Liabilities Currency and Deposits (Billions of EUR)" + "title": "High", + "description": "The high price." }, - "liabilities_loans": { + "low": { "anyOf": [ { "type": "number" @@ -22040,10 +29751,10 @@ "type": "null" } ], - "title": "Liabilities Loans", - "description": "Liabilities Loans (Billions of EUR)" + "title": "Low", + "description": "The low price." }, - "liabilities_trade_credit_and_advances": { + "close": { "anyOf": [ { "type": "number" @@ -22052,22 +29763,22 @@ "type": "null" } ], - "title": "Liabilities Trade Credit And Advances", - "description": "Liabilities Trade Credits and Advances (Billions of EUR)" + "title": "Close", + "description": "The close price." }, - "liabilities_eurosystem": { + "volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Liabilities Eurosystem", - "description": "Liabilities Eurosystem (Billions of EUR)" + "title": "Volume", + "description": "The trading volume." }, - "liabilities_other_mfi_ex_eurosystem": { + "prev_close": { "anyOf": [ { "type": "number" @@ -22076,10 +29787,10 @@ "type": "null" } ], - "title": "Liabilities Other Mfi Ex Eurosystem", - "description": "Liabilities Other MFIs outside Eurosystem (Billions of EUR)" + "title": "Prev Close", + "description": "The previous close price." }, - "liabilities_government": { + "change": { "anyOf": [ { "type": "number" @@ -22088,10 +29799,10 @@ "type": "null" } ], - "title": "Liabilities Government", - "description": "Liabilities Government (Billions of EUR)" + "title": "Change", + "description": "The change in the price from the previous close." }, - "liabilities_other_sectors": { + "change_percent": { "anyOf": [ { "type": "number" @@ -22100,10 +29811,12 @@ "type": "null" } ], - "title": "Liabilities Other Sectors", - "description": "Liabilities Other Sectors (Billions of EUR)" + "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" }, - "assets_equity_and_fund_shares": { + "ma_50": { "anyOf": [ { "type": "number" @@ -22112,10 +29825,10 @@ "type": "null" } ], - "title": "Assets Equity And Fund Shares", - "description": "Assets Equity and Investment Fund Shares (Billions of EUR)" + "title": "Ma 50", + "description": "The 50-day moving average." }, - "assets_equity_shares": { + "ma_200": { "anyOf": [ { "type": "number" @@ -22124,10 +29837,10 @@ "type": "null" } ], - "title": "Assets Equity Shares", - "description": "Assets Equity Shares (Billions of EUR)" + "title": "Ma 200", + "description": "The 200-day moving average." }, - "assets_investment_fund_shares": { + "year_high": { "anyOf": [ { "type": "number" @@ -22136,10 +29849,10 @@ "type": "null" } ], - "title": "Assets Investment Fund Shares", - "description": "Assets Investment Fund Shares (Billions of EUR)" + "title": "Year High", + "description": "The 52-week high." }, - "assets_debt_short_term": { + "year_low": { "anyOf": [ { "type": "number" @@ -22148,131 +29861,225 @@ "type": "null" } ], - "title": "Assets Debt Short Term", - "description": "Assets Debt Short Term (Billions of EUR)" + "title": "Year Low", + "description": "The 52-week low." }, - "assets_debt_long_term": { + "last_rate_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Assets Debt Long Term", - "description": "Assets Debt Long Term (Billions of EUR)" + "title": "Last Rate Timestamp", + "description": "The timestamp of the last rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "base_currency", + "counter_currency", + "last_rate" + ], + "title": "FMPCurrencySnapshotsData", + "description": "FMP Currency Snapshots Data." + }, + "FMPDiscoveryFilingsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "assets_resident_sector_eurosystem": { + "cik": { + "type": "string", + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." + }, + "title": { + "type": "string", + "title": "Title", + "description": "Title of the filing." + }, + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data." + }, + "form_type": { + "type": "string", + "title": "Form Type", + "description": "The form type of the filing" + }, + "link": { + "type": "string", + "title": "Link", + "description": "URL to the filing page on the SEC site." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "cik", + "title", + "date", + "form_type", + "link" + ], + "title": "FMPDiscoveryFilingsData", + "description": "FMP Discovery Filings Data." + }, + "FMPEarningsCallTranscriptData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "quarter": { + "type": "integer", + "title": "Quarter", + "description": "Quarter of the earnings call transcript." + }, + "year": { + "type": "integer", + "title": "Year", + "description": "Year of the earnings call transcript." + }, + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data." + }, + "content": { + "type": "string", + "title": "Content", + "description": "Content of the earnings call transcript." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "quarter", + "year", + "date", + "content" + ], + "title": "FMPEarningsCallTranscriptData", + "description": "FMP Earnings Call Transcript Data." + }, + "FMPEconomicCalendarData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Assets Resident Sector Eurosystem", - "description": "Assets Resident Sector Eurosystem (Billions of EUR)" + "title": "Date", + "description": "The date of the data." }, - "assets_resident_sector_mfi_ex_eurosystem": { + "country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Resident Sector Mfi Ex Eurosystem", - "description": "Assets Resident Sector MFIs outside Eurosystem (Billions of EUR)" + "title": "Country", + "description": "Country of event." }, - "assets_resident_sector_government": { + "category": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Resident Sector Government", - "description": "Assets Resident Sector Government (Billions of EUR)" + "title": "Category", + "description": "Category of event." }, - "assets_resident_sector_other": { + "event": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Assets Resident Sector Other", - "description": "Assets Resident Sector Other (Billions of EUR)" + "title": "Event", + "description": "Event name." }, - "liabilities_equity_and_fund_shares": { + "importance": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Liabilities Equity And Fund Shares", - "description": "Liabilities Equity and Investment Fund Shares (Billions of EUR)" + "title": "Importance", + "description": "The importance level for the event." }, - "liabilities_equity": { + "source": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Liabilities Equity", - "description": "Liabilities Equity (Billions of EUR)" + "title": "Source", + "description": "Source of the data." }, - "liabilities_investment_fund_shares": { + "currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Liabilities Investment Fund Shares", - "description": "Liabilities Investment Fund Shares (Billions of EUR)" + "title": "Currency", + "description": "Currency of the data." }, - "liabilities_debt_short_term": { + "unit": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Liabilities Debt Short Term", - "description": "Liabilities Debt Short Term (Billions of EUR)" + "title": "Unit", + "description": "Unit of the data." }, - "liabilities_debt_long_term": { + "consensus": { "anyOf": [ { - "type": "number" + "type": "string" }, - { - "type": "null" - } - ], - "title": "Liabilities Debt Long Term", - "description": "Liabilities Debt Long Term (Billions of EUR)" - }, - "liabilities_resident_sector_government": { - "anyOf": [ { "type": "number" }, @@ -22280,23 +30087,14 @@ "type": "null" } ], - "title": "Liabilities Resident Sector Government", - "description": "Liabilities Resident Sector Government (Billions of EUR)" + "title": "Consensus", + "description": "Average forecast among a representative group of economists." }, - "liabilities_resident_sector_other": { + "previous": { "anyOf": [ { - "type": "number" + "type": "string" }, - { - "type": "null" - } - ], - "title": "Liabilities Resident Sector Other", - "description": "Liabilities Resident Sector Other (Billions of EUR)" - }, - "assets_equity": { - "anyOf": [ { "type": "number" }, @@ -22304,23 +30102,14 @@ "type": "null" } ], - "title": "Assets Equity", - "description": "Assets Equity (Billions of EUR)" + "title": "Previous", + "description": "Value for the previous period after the revision (if revision is applicable)." }, - "assets_debt_instruments": { + "revised": { "anyOf": [ { - "type": "number" + "type": "string" }, - { - "type": "null" - } - ], - "title": "Assets Debt Instruments", - "description": "Assets Debt Instruments (Billions of EUR)" - }, - "assets_mfi": { - "anyOf": [ { "type": "number" }, @@ -22328,23 +30117,14 @@ "type": "null" } ], - "title": "Assets Mfi", - "description": "Assets MFIs (Billions of EUR)" + "title": "Revised", + "description": "Revised previous value, if applicable." }, - "assets_non_mfi": { + "actual": { "anyOf": [ { - "type": "number" + "type": "string" }, - { - "type": "null" - } - ], - "title": "Assets Non Mfi", - "description": "Assets Non MFIs (Billions of EUR)" - }, - "assets_direct_investment_abroad": { - "anyOf": [ { "type": "number" }, @@ -22352,10 +30132,10 @@ "type": "null" } ], - "title": "Assets Direct Investment Abroad", - "description": "Assets Direct Investment Abroad (Billions of EUR)" + "title": "Actual", + "description": "Latest released value." }, - "liabilities_debt_instruments": { + "change": { "anyOf": [ { "type": "number" @@ -22364,10 +30144,10 @@ "type": "null" } ], - "title": "Liabilities Debt Instruments", - "description": "Liabilities Debt Instruments (Billions of EUR)" + "title": "Change", + "description": "Value change since previous." }, - "liabilities_mfi": { + "change_percent": { "anyOf": [ { "type": "number" @@ -22376,58 +30156,93 @@ "type": "null" } ], - "title": "Liabilities Mfi", - "description": "Liabilities MFIs (Billions of EUR)" + "title": "Change Percent", + "description": "Percentage change since previous." }, - "liabilities_non_mfi": { + "last_updated": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Liabilities Non Mfi", - "description": "Liabilities Non MFIs (Billions of EUR)" + "title": "Last Updated", + "description": "Last updated timestamp." }, - "liabilities_direct_investment_euro_area": { + "created_at": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Liabilities Direct Investment Euro Area", - "description": "Liabilities Direct Investment in Euro Area (Billions of EUR)" - }, - "investment_total_credit": { + "title": "Created At", + "description": "Created at timestamp." + } + }, + "additionalProperties": true, + "type": "object", + "title": "FMPEconomicCalendarData", + "description": "FMP Economics Calendar Data.\n\nSource: https://site.financialmodelingprep.com/developer/docs/economic-calendar-api" + }, + "FMPEquityHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Investment Total Credit", - "description": "Investment Total Credit (Billions of EUR)" + "title": "Date", + "description": "The date of the data." }, - "investment_total_debit": { + "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": "Investment Total Debit", - "description": "Investment Total Debit (Billions of EUR)" + "title": "Volume", + "description": "The trading volume." }, - "equity_credit": { + "vwap": { "anyOf": [ { "type": "number" @@ -22436,22 +30251,22 @@ "type": "null" } ], - "title": "Equity Credit", - "description": "Equity Credit (Billions of EUR)" + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, - "equity_reinvested_earnings_credit": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Equity Reinvested Earnings Credit", - "description": "Equity Reinvested Earnings Credit (Billions of EUR)" + "title": "Symbol", + "description": "Symbol of the equity." }, - "equity_debit": { + "adj_close": { "anyOf": [ { "type": "number" @@ -22460,10 +30275,10 @@ "type": "null" } ], - "title": "Equity Debit", - "description": "Equity Debit (Billions of EUR)" + "title": "Adj Close", + "description": "The adjusted close price." }, - "equity_reinvested_earnings_debit": { + "unadjusted_volume": { "anyOf": [ { "type": "number" @@ -22472,10 +30287,10 @@ "type": "null" } ], - "title": "Equity Reinvested Earnings Debit", - "description": "Equity Reinvested Earnings Debit (Billions of EUR)" + "title": "Unadjusted Volume", + "description": "Unadjusted volume of the symbol." }, - "debt_instruments_credit": { + "change": { "anyOf": [ { "type": "number" @@ -22484,10 +30299,10 @@ "type": "null" } ], - "title": "Debt Instruments Credit", - "description": "Debt Instruments Credit (Billions of EUR)" + "title": "Change", + "description": "Change in the price from the previous close." }, - "debt_instruments_debit": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -22496,552 +30311,800 @@ "type": "null" } ], - "title": "Debt Instruments Debit", - "description": "Debt Instruments Debit (Billions of EUR)" + "title": "Changeovertime", + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "open", + "high", + "low", + "close" + ], + "title": "FMPEquityHistoricalData", + "description": "FMP Equity Historical Price Data." + }, + "FMPEquityOwnershipData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "cik": { + "type": "integer", + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." + }, + "filing_date": { + "type": "string", + "format": "date", + "title": "Filing Date", + "description": "Filing date of the stock ownership." + }, + "investor_name": { + "type": "string", + "title": "Investor Name", + "description": "Investor name of the stock ownership." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "security_name": { + "type": "string", + "title": "Security Name", + "description": "Security name of the stock ownership." + }, + "type_of_security": { + "type": "string", + "title": "Type Of Security", + "description": "Type of security of the stock ownership." + }, + "security_cusip": { + "type": "string", + "title": "Security Cusip", + "description": "Security cusip of the stock ownership." + }, + "shares_type": { + "type": "string", + "title": "Shares Type", + "description": "Shares type of the stock ownership." + }, + "put_call_share": { + "type": "string", + "title": "Put Call Share", + "description": "Put call share of the stock ownership." + }, + "investment_discretion": { + "type": "string", + "title": "Investment Discretion", + "description": "Investment discretion of the stock ownership." + }, + "industry_title": { + "type": "string", + "title": "Industry Title", + "description": "Industry title of the stock ownership." + }, + "weight": { + "type": "number", + "title": "Weight", + "description": "Weight of the stock ownership." + }, + "last_weight": { + "type": "number", + "title": "Last Weight", + "description": "Last weight of the stock ownership." + }, + "change_in_weight": { + "type": "number", + "title": "Change In Weight", + "description": "Change in weight of the stock ownership." + }, + "change_in_weight_percentage": { + "type": "number", + "title": "Change In Weight Percentage", + "description": "Change in weight percentage of the stock ownership." + }, + "market_value": { + "type": "integer", + "title": "Market Value", + "description": "Market value of the stock ownership." + }, + "last_market_value": { + "type": "integer", + "title": "Last Market Value", + "description": "Last market value of the stock ownership." + }, + "change_in_market_value": { + "type": "integer", + "title": "Change In Market Value", + "description": "Change in market value of the stock ownership." + }, + "change_in_market_value_percentage": { + "type": "number", + "title": "Change In Market Value Percentage", + "description": "Change in market value percentage of the stock ownership." + }, + "shares_number": { + "type": "integer", + "title": "Shares Number", + "description": "Shares number of the stock ownership." + }, + "last_shares_number": { + "type": "integer", + "title": "Last Shares Number", + "description": "Last shares number of the stock ownership." + }, + "change_in_shares_number": { + "type": "number", + "title": "Change In Shares Number", + "description": "Change in shares number of the stock ownership." + }, + "change_in_shares_number_percentage": { + "type": "number", + "title": "Change In Shares Number Percentage", + "description": "Change in shares number percentage of the stock ownership." + }, + "quarter_end_price": { + "type": "number", + "title": "Quarter End Price", + "description": "Quarter end price of the stock ownership." + }, + "avg_price_paid": { + "type": "number", + "title": "Avg Price Paid", + "description": "Average price paid of the stock ownership." + }, + "is_new": { + "type": "boolean", + "title": "Is New", + "description": "Is the stock ownership new." + }, + "is_sold_out": { + "type": "boolean", + "title": "Is Sold Out", + "description": "Is the stock ownership sold out." + }, + "ownership": { + "type": "number", + "title": "Ownership", + "description": "How much is the ownership." + }, + "last_ownership": { + "type": "number", + "title": "Last Ownership", + "description": "Last ownership amount." + }, + "change_in_ownership": { + "type": "number", + "title": "Change In Ownership", + "description": "Change in ownership amount." + }, + "change_in_ownership_percentage": { + "type": "number", + "title": "Change In Ownership Percentage", + "description": "Change in ownership percentage." + }, + "holding_period": { + "type": "integer", + "title": "Holding Period", + "description": "Holding period of the stock ownership." + }, + "first_added": { + "type": "string", + "format": "date", + "title": "First Added", + "description": "First added date of the stock ownership." + }, + "performance": { + "type": "number", + "title": "Performance", + "description": "Performance of the stock ownership." + }, + "performance_percentage": { + "type": "number", + "title": "Performance Percentage", + "description": "Performance percentage of the stock ownership." + }, + "last_performance": { + "type": "number", + "title": "Last Performance", + "description": "Last performance of the stock ownership." + }, + "change_in_performance": { + "type": "number", + "title": "Change In Performance", + "description": "Change in performance of the stock ownership." + }, + "is_counted_for_performance": { + "type": "boolean", + "title": "Is Counted For Performance", + "description": "Is the stock ownership counted for performance." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "cik", + "filing_date", + "investor_name", + "symbol", + "security_name", + "type_of_security", + "security_cusip", + "shares_type", + "put_call_share", + "investment_discretion", + "industry_title", + "weight", + "last_weight", + "change_in_weight", + "change_in_weight_percentage", + "market_value", + "last_market_value", + "change_in_market_value", + "change_in_market_value_percentage", + "shares_number", + "last_shares_number", + "change_in_shares_number", + "change_in_shares_number_percentage", + "quarter_end_price", + "avg_price_paid", + "is_new", + "is_sold_out", + "ownership", + "last_ownership", + "change_in_ownership", + "change_in_ownership_percentage", + "holding_period", + "first_added", + "performance", + "performance_percentage", + "last_performance", + "change_in_performance", + "is_counted_for_performance" + ], + "title": "FMPEquityOwnershipData", + "description": "FMP Equity Ownership Data." + }, + "FMPEquityPeersData": { + "properties": { + "peers_list": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Peers List", + "description": "A list of equity peers based on sector, exchange and market cap." + } + }, + "additionalProperties": true, + "type": "object", + "title": "FMPEquityPeersData", + "description": "FMP Equity Peers Data." + }, + "FMPEquityProfileData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "portfolio_investment_equity_credit": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Portfolio Investment Equity Credit", - "description": "Portfolio Investment Equity Credit (Billions of EUR)" + "title": "Name", + "description": "Common name of the company." }, - "portfolio_investment_equity_debit": { + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Portfolio Investment Equity Debit", - "description": "Portfolio Investment Equity Debit (Billions of EUR)" + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "portfolio_investment_debt_instruments_credit": { + "cusip": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Portfolio Investment Debt Instruments Credit", - "description": "Portfolio Investment Debt Instruments Credit (Billions of EUR)" + "title": "Cusip", + "description": "CUSIP identifier for the company." }, - "portofolio_investment_debt_instruments_debit": { + "isin": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Portofolio Investment Debt Instruments Debit", - "description": "Portfolio Investment Debt Instruments Debit (Billions of EUR)" + "title": "Isin", + "description": "International Securities Identification Number." }, - "other_investment_credit": { + "lei": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Investment Credit", - "description": "Other Investment Credit (Billions of EUR)" + "title": "Lei", + "description": "Legal Entity Identifier assigned to the company." }, - "other_investment_debit": { + "legal_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Investment Debit", - "description": "Other Investment Debit (Billions of EUR)" + "title": "Legal Name", + "description": "Official legal name of the company." }, - "reserve_assets_credit": { + "stock_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Reserve Assets Credit", - "description": "Reserve Assets Credit (Billions of EUR)" + "title": "Stock Exchange", + "description": "Stock exchange where the company is traded." }, - "services_total_credit": { + "sic": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Services Total Credit", - "description": "Services Total Credit (Billions of EUR)" + "title": "Sic", + "description": "Standard Industrial Classification code for the company." }, - "services_total_debit": { + "short_description": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Services Total Debit", - "description": "Services Total Debit (Billions of EUR)" + "title": "Short Description", + "description": "Short description of the company." }, - "transport_credit": { + "long_description": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Transport Credit", - "description": "Transport Credit (Billions of EUR)" + "title": "Long Description", + "description": "Long description of the company." }, - "transport_debit": { + "ceo": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Transport Debit", - "description": "Transport Debit (Billions of EUR)" + "title": "Ceo", + "description": "Chief Executive Officer of the company." }, - "travel_credit": { + "company_url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Travel Credit", - "description": "Travel Credit (Billions of EUR)" + "title": "Company Url", + "description": "URL of the company's website." }, - "travel_debit": { + "business_address": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Travel Debit", - "description": "Travel Debit (Billions of EUR)" + "title": "Business Address", + "description": "Address of the company's headquarters." }, - "financial_services_credit": { + "mailing_address": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Financial Services Credit", - "description": "Financial Services Credit (Billions of EUR)" + "title": "Mailing Address", + "description": "Mailing address of the company." }, - "financial_services_debit": { + "business_phone_no": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Financial Services Debit", - "description": "Financial Services Debit (Billions of EUR)" + "title": "Business Phone No", + "description": "Phone number of the company's headquarters." }, - "communications_credit": { + "hq_address_1": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Communications Credit", - "description": "Communications Credit (Billions of EUR)" + "title": "Hq Address 1", + "description": "Address of the company's headquarters." }, - "communications_debit": { + "hq_address_2": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Communications Debit", - "description": "Communications Debit (Billions of EUR)" + "title": "Hq Address 2", + "description": "Address of the company's headquarters." }, - "other_business_services_credit": { + "hq_address_city": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Business Services Credit", - "description": "Other Business Services Credit (Billions of EUR)" + "title": "Hq Address City", + "description": "City of the company's headquarters." }, - "other_business_services_debit": { + "hq_address_postal_code": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Business Services Debit", - "description": "Other Business Services Debit (Billions of EUR)" + "title": "Hq Address Postal Code", + "description": "Zip code of the company's headquarters." }, - "other_services_credit": { + "hq_state": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Services Credit", - "description": "Other Services Credit (Billions of EUR)" + "title": "Hq State", + "description": "State of the company's headquarters." }, - "other_services_debit": { + "hq_country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Services Debit", - "description": "Other Services Debit (Billions of EUR)" + "title": "Hq Country", + "description": "Country of the company's headquarters." }, - "primary_income_employee_compensation_credit": { + "inc_state": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Primary Income Employee Compensation Credit", - "description": "Primary Income Employee Compensation Credit (Billions of EUR)" + "title": "Inc State", + "description": "State in which the company is incorporated." }, - "primary_income_employee_compensation_debit": { + "inc_country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Primary Income Employee Compensation Debit", - "description": "Primary Income Employee Compensation Debit (Billions of EUR)" + "title": "Inc Country", + "description": "Country in which the company is incorporated." }, - "current_account": { + "employees": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Current Account", - "description": "Current Account Balance (Billions of EUR)" + "title": "Employees", + "description": "Number of employees working for the company." }, - "goods": { + "entity_legal_form": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Goods", - "description": "Goods Balance (Billions of EUR)" + "title": "Entity Legal Form", + "description": "Legal form of the company." }, - "services": { + "entity_status": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Services", - "description": "Services Balance (Billions of EUR)" + "title": "Entity Status", + "description": "Status of the company." }, - "primary_income": { + "latest_filing_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Primary Income", - "description": "Primary Income Balance (Billions of EUR)" + "title": "Latest Filing Date", + "description": "Date of the company's latest filing." }, - "secondary_income": { + "irs_number": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Secondary Income", - "description": "Secondary Income Balance (Billions of EUR)" + "title": "Irs Number", + "description": "IRS number assigned to the company." }, - "capital_account": { + "sector": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Capital Account", - "description": "Capital Account Balance (Billions of EUR)" + "title": "Sector", + "description": "Sector in which the company operates." }, - "net_lending_to_rest_of_world": { + "industry_category": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Lending To Rest Of World", - "description": "Balance of net lending to the rest of the world (Billions of EUR)" + "title": "Industry Category", + "description": "Category of industry in which the company operates." }, - "financial_account": { + "industry_group": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Financial Account", - "description": "Financial Account Balance (Billions of EUR)" + "title": "Industry Group", + "description": "Group of industry in which the company operates." }, - "direct_investment": { + "template": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Direct Investment", - "description": "Direct Investment Balance (Billions of EUR)" + "title": "Template", + "description": "Template used to standardize the company's financial statements." }, - "portfolio_investment": { + "standardized_active": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Portfolio Investment", - "description": "Portfolio Investment Balance (Billions of EUR)" + "title": "Standardized Active", + "description": "Whether the company is active or not." }, - "financial_derivatives": { + "first_fundamental_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Financial Derivatives", - "description": "Financial Derivatives Balance (Billions of EUR)" + "title": "First Fundamental Date", + "description": "Date of the company's first fundamental." }, - "other_investment": { + "last_fundamental_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Other Investment", - "description": "Other Investment Balance (Billions of EUR)" + "title": "Last Fundamental Date", + "description": "Date of the company's last fundamental." }, - "reserve_assets": { + "first_stock_price_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Reserve Assets", - "description": "Reserve Assets Balance (Billions of EUR)" + "title": "First Stock Price Date", + "description": "Date of the company's first stock price." }, - "errors_and_ommissions": { + "last_stock_price_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Errors And Ommissions", - "description": "Errors and Omissions (Billions of EUR)" - } - }, - "additionalProperties": true, - "type": "object", - "title": "ECBBalanceOfPayments", - "description": "ECB Balance of Payments Data." - }, - "ECBCurrencyReferenceRates": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Last Stock Price Date", + "description": "Date of the company's last stock price." }, - "eur": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Eur", - "description": "Euro." + "is_etf": { + "type": "boolean", + "title": "Is Etf", + "description": "If the symbol is an ETF." }, - "usd": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Usd", - "description": "US Dollar." + "is_actively_trading": { + "type": "boolean", + "title": "Is Actively Trading", + "description": "If the company is actively trading." }, - "jpy": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Jpy", - "description": "Japanese Yen." + "is_adr": { + "type": "boolean", + "title": "Is Adr", + "description": "If the stock is an ADR." }, - "bgn": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Bgn", - "description": "Bulgarian Lev." + "is_fund": { + "type": "boolean", + "title": "Is Fund", + "description": "If the company is a fund." }, - "czk": { + "image": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Czk", - "description": "Czech Koruna." + "title": "Image", + "description": "Image of the company." }, - "dkk": { + "currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Dkk", - "description": "Danish Krone." + "title": "Currency", + "description": "Currency in which the stock is traded." }, - "gbp": { + "mktCap": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Gbp", - "description": "Pound Sterling." + "title": "Mktcap", + "description": "Market capitalization of the company." }, - "huf": { + "price": { "anyOf": [ { "type": "number" @@ -23050,10 +31113,10 @@ "type": "null" } ], - "title": "Huf", - "description": "Hungarian Forint." + "title": "Price", + "description": "The last traded price." }, - "pln": { + "year_high": { "anyOf": [ { "type": "number" @@ -23062,10 +31125,10 @@ "type": "null" } ], - "title": "Pln", - "description": "Polish Zloty." + "title": "Year High", + "description": "The one-year high of the price." }, - "ron": { + "year_low": { "anyOf": [ { "type": "number" @@ -23074,22 +31137,22 @@ "type": "null" } ], - "title": "Ron", - "description": "Romanian Leu." + "title": "Year Low", + "description": "The one-year low of the price." }, - "sek": { + "volAvg": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Sek", - "description": "Swedish Krona." + "title": "Volavg", + "description": "Average daily trading volume." }, - "chf": { + "lastDiv": { "anyOf": [ { "type": "number" @@ -23098,10 +31161,10 @@ "type": "null" } ], - "title": "Chf", - "description": "Swiss Franc." + "title": "Lastdiv", + "description": "The annualized dividend payment based on the most recent regular dividend payment." }, - "isk": { + "beta": { "anyOf": [ { "type": "number" @@ -23110,46 +31173,66 @@ "type": "null" } ], - "title": "Isk", - "description": "Icelandic Krona." + "title": "Beta", + "description": "Beta of the stock relative to the market." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "is_etf", + "is_actively_trading", + "is_adr", + "is_fund" + ], + "title": "FMPEquityProfileData", + "description": "FMP Equity Profile Data." + }, + "FMPEquityQuoteData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "nok": { + "asset_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Nok", - "description": "Norwegian Krone." + "title": "Asset Type", + "description": "Type of asset - i.e, stock, ETF, etc." }, - "try": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Try", - "description": "Turkish Lira." + "title": "Name", + "description": "Name of the company or asset." }, - "aud": { + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Aud", - "description": "Australian Dollar." + "title": "Exchange", + "description": "The name or symbol of the venue where the data is from." }, - "brl": { + "bid": { "anyOf": [ { "type": "number" @@ -23158,34 +31241,34 @@ "type": "null" } ], - "title": "Brl", - "description": "Brazilian Real." + "title": "Bid", + "description": "Price of the top bid order." }, - "cad": { + "bid_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Cad", - "description": "Canadian Dollar." + "title": "Bid Size", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." }, - "cny": { + "bid_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Cny", - "description": "Chinese Yuan." + "title": "Bid Exchange", + "description": "The specific trading venue where the purchase order was placed." }, - "hkd": { + "ask": { "anyOf": [ { "type": "number" @@ -23194,130 +31277,178 @@ "type": "null" } ], - "title": "Hkd", - "description": "Hong Kong Dollar." + "title": "Ask", + "description": "Price of the top ask order." }, - "idr": { + "ask_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Idr", - "description": "Indonesian Rupiah." + "title": "Ask Size", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." }, - "ils": { + "ask_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ils", - "description": "Israeli Shekel." + "title": "Ask Exchange", + "description": "The specific trading venue where the sale order was placed." }, - "inr": { + "quote_conditions": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Inr", - "description": "Indian Rupee." + "title": "Quote Conditions", + "description": "Conditions or condition codes applicable to the quote." }, - "krw": { + "quote_indicators": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Krw", - "description": "South Korean Won." + "title": "Quote Indicators", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO." }, - "mxn": { + "sales_conditions": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Mxn", - "description": "Mexican Peso." + "title": "Sales Conditions", + "description": "Conditions or condition codes applicable to the sale." }, - "myr": { + "sequence_number": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Myr", - "description": "Malaysian Ringgit." + "title": "Sequence Number", + "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)." }, - "nzd": { + "market_center": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Nzd", - "description": "New Zealand Dollar." + "title": "Market Center", + "description": "The ID of the UTP participant that originated the message." }, - "php": { + "participant_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Php", - "description": "Philippine Peso." + "title": "Participant Timestamp", + "description": "Timestamp for when the quote was generated by the exchange." }, - "sgd": { + "trf_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Sgd", - "description": "Singapore Dollar." + "title": "Trf Timestamp", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." }, - "thb": { + "sip_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Thb", - "description": "Thai Baht." + "title": "Sip Timestamp", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." }, - "zar": { + "last_price": { "anyOf": [ { "type": "number" @@ -23326,127 +31457,99 @@ "type": "null" } ], - "title": "Zar", - "description": "South African Rand." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "ECBCurrencyReferenceRates", - "description": "ECB Currency Reference Rates Data." - }, - "ECBEUYieldCurve": { - "properties": { - "maturity": { + "title": "Last Price", + "description": "Price of the last trade." + }, + "last_tick": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Maturity", - "description": "Maturity, in years." + "title": "Last Tick", + "description": "Whether the last sale was an up or down tick." }, - "rate": { + "last_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Rate", - "description": "Yield curve rate, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "title": "ECBEUYieldCurve", - "description": "ECB Yield Curve Data." - }, - "FMPAnalystEstimates": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Last Size", + "description": "Size of the last trade." }, - "estimated_revenue_low": { + "last_timestamp": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Estimated Revenue Low", - "description": "Estimated revenue low." + "title": "Last Timestamp", + "description": "Date and Time when the last price was recorded." }, - "estimated_revenue_high": { + "open": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Revenue High", - "description": "Estimated revenue high." + "title": "Open", + "description": "The open price." }, - "estimated_revenue_avg": { + "high": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Revenue Avg", - "description": "Estimated revenue average." + "title": "High", + "description": "The high price." }, - "estimated_sga_expense_low": { + "low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Sga Expense Low", - "description": "Estimated SGA expense low." + "title": "Low", + "description": "The low price." }, - "estimated_sga_expense_high": { + "close": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Sga Expense High", - "description": "Estimated SGA expense high." + "title": "Close", + "description": "The close price." }, - "estimated_sga_expense_avg": { + "volume": { "anyOf": [ + { + "type": "number" + }, { "type": "integer" }, @@ -23454,11 +31557,14 @@ "type": "null" } ], - "title": "Estimated Sga Expense Avg", - "description": "Estimated SGA expense average." + "title": "Volume", + "description": "The trading volume." }, - "estimated_ebitda_low": { + "exchange_volume": { "anyOf": [ + { + "type": "number" + }, { "type": "integer" }, @@ -23466,94 +31572,95 @@ "type": "null" } ], - "title": "Estimated Ebitda Low", - "description": "Estimated EBITDA low." + "title": "Exchange Volume", + "description": "Volume of shares exchanged during the trading day on the specific exchange." }, - "estimated_ebitda_high": { + "prev_close": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Ebitda High", - "description": "Estimated EBITDA high." + "title": "Prev Close", + "description": "The previous close price." }, - "estimated_ebitda_avg": { + "change": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Ebitda Avg", - "description": "Estimated EBITDA average." + "title": "Change", + "description": "Change in price from previous close." }, - "estimated_ebit_low": { + "change_percent": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Ebit Low", - "description": "Estimated EBIT low." + "title": "Change Percent", + "description": "Change in price as a normalized percentage.", + "x-frontendmultiply": 100 }, - "estimated_ebit_high": { + "year_high": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Ebit High", - "description": "Estimated EBIT high." + "title": "Year High", + "description": "The one year high (52W High)." }, - "estimated_ebit_avg": { + "year_low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Ebit Avg", - "description": "Estimated EBIT average." + "title": "Year Low", + "description": "The one year low (52W Low)." }, - "estimated_net_income_low": { + "price_avg_50": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Net Income Low", - "description": "Estimated net income low." + "title": "Price Avg 50", + "description": "50 day moving average price." }, - "estimated_net_income_high": { + "price_avg_200": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Estimated Net Income High", - "description": "Estimated net income high." + "title": "Price Avg 200", + "description": "200 day moving average price." }, - "estimated_net_income_avg": { + "avg_volume": { "anyOf": [ { "type": "integer" @@ -23562,10 +31669,10 @@ "type": "null" } ], - "title": "Estimated Net Income Avg", - "description": "Estimated net income average." + "title": "Avg Volume", + "description": "Average volume over the last 10 trading days." }, - "estimated_eps_avg": { + "market_cap": { "anyOf": [ { "type": "number" @@ -23574,22 +31681,22 @@ "type": "null" } ], - "title": "Estimated Eps Avg", - "description": "Estimated EPS average." + "title": "Market Cap", + "description": "Market cap of the company." }, - "estimated_eps_high": { + "shares_outstanding": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Estimated Eps High", - "description": "Estimated EPS high." + "title": "Shares Outstanding", + "description": "Number of shares outstanding." }, - "estimated_eps_low": { + "eps": { "anyOf": [ { "type": "number" @@ -23598,98 +31705,68 @@ "type": "null" } ], - "title": "Estimated Eps Low", - "description": "Estimated EPS low." + "title": "Eps", + "description": "Earnings per share." }, - "number_analyst_estimated_revenue": { + "pe": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Number Analyst Estimated Revenue", - "description": "Number of analysts who estimated revenue." + "title": "Pe", + "description": "Price earnings ratio." }, - "number_analysts_estimated_eps": { + "earnings_announcement": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Number Analysts Estimated Eps", - "description": "Number of analysts who estimated EPS." + "title": "Earnings Announcement", + "description": "Upcoming earnings announcement date." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "date" + "symbol" ], - "title": "FMPAnalystEstimates", - "description": "FMP Analyst Estimates Data." + "title": "FMPEquityQuoteData", + "description": "FMP Equity Quote Data." }, - "FMPAvailableIndices": { + "FMPEquityScreenerData": { "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", "title": "Name", - "description": "Name of the index." + "description": "Name of the company." }, - "currency": { + "marketCap": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Currency", - "description": "Currency the index is traded in." - }, - "stock_exchange": { - "type": "string", - "title": "Stock Exchange", - "description": "Stock exchange where the index is listed." - }, - "exchange_short_name": { - "type": "string", - "title": "Exchange Short Name", - "description": "Short name of the stock exchange where the index is listed." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "stock_exchange", - "exchange_short_name" - ], - "title": "FMPAvailableIndices", - "description": "FMP Available Indices Data." - }, - "FMPBalanceSheet": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "title": "Marketcap", + "description": "The market cap of ticker." }, - "fiscal_period": { + "sector": { "anyOf": [ { "type": "string" @@ -23698,132 +31775,155 @@ "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the report." + "title": "Sector", + "description": "The sector the ticker belongs to." }, - "fiscal_year": { + "industry": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." + "title": "Industry", + "description": "The industry ticker belongs to." }, - "filing_date": { + "beta": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Filing Date", - "description": "The date when the filing was made." + "title": "Beta", + "description": "The beta of the ETF." }, - "accepted_date": { + "price": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Accepted Date", - "description": "The date and time when the filing was accepted." + "title": "Price", + "description": "The current price." }, - "reported_currency": { + "lastAnnualDividend": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Reported Currency", - "description": "The currency in which the balance sheet was reported." + "title": "Lastannualdividend", + "description": "The last annual amount dividend paid." }, - "cash_and_cash_equivalents": { + "volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Cash And Cash Equivalents", - "description": "Cash and cash equivalents." + "title": "Volume", + "description": "The current trading volume." }, - "short_term_investments": { + "exchangeShortName": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Short Term Investments", - "description": "Short term investments." + "title": "Exchangeshortname", + "description": "The exchange code the asset trades on." }, - "cash_and_short_term_investments": { + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Cash And Short Term Investments", - "description": "Cash and short term investments." + "title": "Exchange", + "description": "The full name of the primary exchange." }, - "net_receivables": { + "country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Receivables", - "description": "Net receivables." + "title": "Country", + "description": "The two-letter country abbreviation where the head office is located." }, - "inventory": { + "isEtf": { "anyOf": [ { - "type": "number" + "type": "boolean", + "enum": [ + true, + false + ] }, { "type": "null" } ], - "title": "Inventory", - "description": "Inventory." + "title": "Isetf", + "description": "Whether the ticker is an ETF." }, - "other_current_assets": { + "isActivelyTrading": { "anyOf": [ { - "type": "number" + "type": "boolean", + "enum": [ + true, + false + ] }, { "type": "null" } ], - "title": "Other Current Assets", - "description": "Other current assets." + "title": "Isactivelytrading", + "description": "Whether the ETF is actively trading." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "name" + ], + "title": "FMPEquityScreenerData", + "description": "FMP Equity Screener Data." + }, + "FMPEquityValuationMultiplesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "total_current_assets": { + "revenue_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23832,10 +31932,10 @@ "type": "null" } ], - "title": "Total Current Assets", - "description": "Total current assets." + "title": "Revenue Per Share Ttm", + "description": "Revenue per share calculated as trailing twelve months." }, - "plant_property_equipment_net": { + "net_income_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23844,10 +31944,10 @@ "type": "null" } ], - "title": "Plant Property Equipment Net", - "description": "Plant property equipment net." + "title": "Net Income Per Share Ttm", + "description": "Net income per share calculated as trailing twelve months." }, - "goodwill": { + "operating_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23856,10 +31956,10 @@ "type": "null" } ], - "title": "Goodwill", - "description": "Goodwill." + "title": "Operating Cash Flow Per Share Ttm", + "description": "Operating cash flow per share calculated as trailing twelve months." }, - "intangible_assets": { + "free_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23868,10 +31968,10 @@ "type": "null" } ], - "title": "Intangible Assets", - "description": "Intangible assets." + "title": "Free Cash Flow Per Share Ttm", + "description": "Free cash flow per share calculated as trailing twelve months." }, - "goodwill_and_intangible_assets": { + "cash_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23880,10 +31980,10 @@ "type": "null" } ], - "title": "Goodwill And Intangible Assets", - "description": "Goodwill and intangible assets." + "title": "Cash Per Share Ttm", + "description": "Cash per share calculated as trailing twelve months." }, - "long_term_investments": { + "book_value_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23892,10 +31992,10 @@ "type": "null" } ], - "title": "Long Term Investments", - "description": "Long term investments." + "title": "Book Value Per Share Ttm", + "description": "Book value per share calculated as trailing twelve months." }, - "tax_assets": { + "tangible_book_value_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23904,10 +32004,10 @@ "type": "null" } ], - "title": "Tax Assets", - "description": "Tax assets." + "title": "Tangible Book Value Per Share Ttm", + "description": "Tangible book value per share calculated as trailing twelve months." }, - "other_non_current_assets": { + "shareholders_equity_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23916,10 +32016,10 @@ "type": "null" } ], - "title": "Other Non Current Assets", - "description": "Other non current assets." + "title": "Shareholders Equity Per Share Ttm", + "description": "Shareholders equity per share calculated as trailing twelve months." }, - "non_current_assets": { + "interest_debt_per_share_ttm": { "anyOf": [ { "type": "number" @@ -23928,10 +32028,10 @@ "type": "null" } ], - "title": "Non Current Assets", - "description": "Total non current assets." + "title": "Interest Debt Per Share Ttm", + "description": "Interest debt per share calculated as trailing twelve months." }, - "other_assets": { + "market_cap_ttm": { "anyOf": [ { "type": "number" @@ -23940,10 +32040,10 @@ "type": "null" } ], - "title": "Other Assets", - "description": "Other assets." + "title": "Market Cap Ttm", + "description": "Market capitalization calculated as trailing twelve months." }, - "total_assets": { + "enterprise_value_ttm": { "anyOf": [ { "type": "number" @@ -23952,10 +32052,10 @@ "type": "null" } ], - "title": "Total Assets", - "description": "Total assets." + "title": "Enterprise Value Ttm", + "description": "Enterprise value calculated as trailing twelve months." }, - "accounts_payable": { + "pe_ratio_ttm": { "anyOf": [ { "type": "number" @@ -23964,10 +32064,10 @@ "type": "null" } ], - "title": "Accounts Payable", - "description": "Accounts payable." + "title": "Pe Ratio Ttm", + "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months." }, - "short_term_debt": { + "price_to_sales_ratio_ttm": { "anyOf": [ { "type": "number" @@ -23976,10 +32076,10 @@ "type": "null" } ], - "title": "Short Term Debt", - "description": "Short term debt." + "title": "Price To Sales Ratio Ttm", + "description": "Price-to-sales ratio calculated as trailing twelve months." }, - "tax_payables": { + "pocf_ratio_ttm": { "anyOf": [ { "type": "number" @@ -23988,10 +32088,10 @@ "type": "null" } ], - "title": "Tax Payables", - "description": "Tax payables." + "title": "Pocf Ratio Ttm", + "description": "Price-to-operating cash flow ratio calculated as trailing twelve months." }, - "current_deferred_revenue": { + "pfcf_ratio_ttm": { "anyOf": [ { "type": "number" @@ -24000,10 +32100,10 @@ "type": "null" } ], - "title": "Current Deferred Revenue", - "description": "Current deferred revenue." + "title": "Pfcf Ratio Ttm", + "description": "Price-to-free cash flow ratio calculated as trailing twelve months." }, - "other_current_liabilities": { + "pb_ratio_ttm": { "anyOf": [ { "type": "number" @@ -24012,10 +32112,10 @@ "type": "null" } ], - "title": "Other Current Liabilities", - "description": "Other current liabilities." + "title": "Pb Ratio Ttm", + "description": "Price-to-book ratio calculated as trailing twelve months." }, - "total_current_liabilities": { + "ptb_ratio_ttm": { "anyOf": [ { "type": "number" @@ -24024,10 +32124,10 @@ "type": "null" } ], - "title": "Total Current Liabilities", - "description": "Total current liabilities." + "title": "Ptb Ratio Ttm", + "description": "Price-to-tangible book ratio calculated as trailing twelve months." }, - "long_term_debt": { + "ev_to_sales_ttm": { "anyOf": [ { "type": "number" @@ -24036,10 +32136,10 @@ "type": "null" } ], - "title": "Long Term Debt", - "description": "Long term debt." + "title": "Ev To Sales Ttm", + "description": "Enterprise value-to-sales ratio calculated as trailing twelve months." }, - "deferred_revenue_non_current": { + "enterprise_value_over_ebitda_ttm": { "anyOf": [ { "type": "number" @@ -24048,10 +32148,10 @@ "type": "null" } ], - "title": "Deferred Revenue Non Current", - "description": "Non current deferred revenue." + "title": "Enterprise Value Over Ebitda Ttm", + "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months." }, - "deferred_tax_liabilities_non_current": { + "ev_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" @@ -24060,10 +32160,10 @@ "type": "null" } ], - "title": "Deferred Tax Liabilities Non Current", - "description": "Deferred tax liabilities non current." + "title": "Ev To Operating Cash Flow Ttm", + "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months." }, - "other_non_current_liabilities": { + "ev_to_free_cash_flow_ttm": { "anyOf": [ { "type": "number" @@ -24072,10 +32172,10 @@ "type": "null" } ], - "title": "Other Non Current Liabilities", - "description": "Other non current liabilities." + "title": "Ev To Free Cash Flow Ttm", + "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months." }, - "total_non_current_liabilities": { + "earnings_yield_ttm": { "anyOf": [ { "type": "number" @@ -24084,10 +32184,10 @@ "type": "null" } ], - "title": "Total Non Current Liabilities", - "description": "Total non current liabilities." + "title": "Earnings Yield Ttm", + "description": "Earnings yield calculated as trailing twelve months." }, - "other_liabilities": { + "free_cash_flow_yield_ttm": { "anyOf": [ { "type": "number" @@ -24096,10 +32196,10 @@ "type": "null" } ], - "title": "Other Liabilities", - "description": "Other liabilities." + "title": "Free Cash Flow Yield Ttm", + "description": "Free cash flow yield calculated as trailing twelve months." }, - "capital_lease_obligations": { + "debt_to_equity_ttm": { "anyOf": [ { "type": "number" @@ -24108,10 +32208,10 @@ "type": "null" } ], - "title": "Capital Lease Obligations", - "description": "Capital lease obligations." + "title": "Debt To Equity Ttm", + "description": "Debt-to-equity ratio calculated as trailing twelve months." }, - "total_liabilities": { + "debt_to_assets_ttm": { "anyOf": [ { "type": "number" @@ -24120,10 +32220,10 @@ "type": "null" } ], - "title": "Total Liabilities", - "description": "Total liabilities." + "title": "Debt To Assets Ttm", + "description": "Debt-to-assets ratio calculated as trailing twelve months." }, - "preferred_stock": { + "net_debt_to_ebitda_ttm": { "anyOf": [ { "type": "number" @@ -24132,10 +32232,10 @@ "type": "null" } ], - "title": "Preferred Stock", - "description": "Preferred stock." + "title": "Net Debt To Ebitda Ttm", + "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months." }, - "common_stock": { + "current_ratio_ttm": { "anyOf": [ { "type": "number" @@ -24144,10 +32244,10 @@ "type": "null" } ], - "title": "Common Stock", - "description": "Common stock." + "title": "Current Ratio Ttm", + "description": "Current ratio calculated as trailing twelve months." }, - "retained_earnings": { + "interest_coverage_ttm": { "anyOf": [ { "type": "number" @@ -24156,10 +32256,10 @@ "type": "null" } ], - "title": "Retained Earnings", - "description": "Retained earnings." + "title": "Interest Coverage Ttm", + "description": "Interest coverage calculated as trailing twelve months." }, - "accumulated_other_comprehensive_income": { + "income_quality_ttm": { "anyOf": [ { "type": "number" @@ -24168,10 +32268,10 @@ "type": "null" } ], - "title": "Accumulated Other Comprehensive Income", - "description": "Accumulated other comprehensive income (loss)." + "title": "Income Quality Ttm", + "description": "Income quality calculated as trailing twelve months." }, - "other_shareholders_equity": { + "dividend_yield_ttm": { "anyOf": [ { "type": "number" @@ -24180,10 +32280,10 @@ "type": "null" } ], - "title": "Other Shareholders Equity", - "description": "Other shareholders equity." + "title": "Dividend Yield Ttm", + "description": "Dividend yield calculated as trailing twelve months." }, - "other_total_shareholders_equity": { + "dividend_yield_percentage_ttm": { "anyOf": [ { "type": "number" @@ -24192,10 +32292,10 @@ "type": "null" } ], - "title": "Other Total Shareholders Equity", - "description": "Other total shareholders equity." + "title": "Dividend Yield Percentage Ttm", + "description": "Dividend yield percentage calculated as trailing twelve months." }, - "total_common_equity": { + "dividend_to_market_cap_ttm": { "anyOf": [ { "type": "number" @@ -24204,10 +32304,10 @@ "type": "null" } ], - "title": "Total Common Equity", - "description": "Total common equity." + "title": "Dividend To Market Cap Ttm", + "description": "Dividend to market capitalization ratio calculated as trailing twelve months." }, - "total_equity_non_controlling_interests": { + "dividend_per_share_ttm": { "anyOf": [ { "type": "number" @@ -24216,10 +32316,10 @@ "type": "null" } ], - "title": "Total Equity Non Controlling Interests", - "description": "Total equity non controlling interests." + "title": "Dividend Per Share Ttm", + "description": "Dividend per share calculated as trailing twelve months." }, - "total_liabilities_and_shareholders_equity": { + "payout_ratio_ttm": { "anyOf": [ { "type": "number" @@ -24228,10 +32328,10 @@ "type": "null" } ], - "title": "Total Liabilities And Shareholders Equity", - "description": "Total liabilities and shareholders equity." + "title": "Payout Ratio Ttm", + "description": "Payout ratio calculated as trailing twelve months." }, - "minority_interest": { + "sales_general_and_administrative_to_revenue_ttm": { "anyOf": [ { "type": "number" @@ -24240,10 +32340,10 @@ "type": "null" } ], - "title": "Minority Interest", - "description": "Minority interest." + "title": "Sales General And Administrative To Revenue Ttm", + "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months." }, - "total_liabilities_and_total_equity": { + "research_and_development_to_revenue_ttm": { "anyOf": [ { "type": "number" @@ -24252,10 +32352,10 @@ "type": "null" } ], - "title": "Total Liabilities And Total Equity", - "description": "Total liabilities and total equity." + "title": "Research And Development To Revenue Ttm", + "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months." }, - "total_investments": { + "intangibles_to_total_assets_ttm": { "anyOf": [ { "type": "number" @@ -24264,10 +32364,10 @@ "type": "null" } ], - "title": "Total Investments", - "description": "Total investments." + "title": "Intangibles To Total Assets Ttm", + "description": "Intangibles-to-total assets ratio calculated as trailing twelve months." }, - "total_debt": { + "capex_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" @@ -24276,10 +32376,10 @@ "type": "null" } ], - "title": "Total Debt", - "description": "Total debt." + "title": "Capex To Operating Cash Flow Ttm", + "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months." }, - "net_debt": { + "capex_to_revenue_ttm": { "anyOf": [ { "type": "number" @@ -24288,325 +32388,58 @@ "type": "null" } ], - "title": "Net Debt", - "description": "Net debt." + "title": "Capex To Revenue Ttm", + "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months." }, - "link": { + "capex_to_depreciation_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Link", - "description": "Link to the filing." + "title": "Capex To Depreciation Ttm", + "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months." }, - "final_link": { + "stock_based_compensation_to_revenue_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Final Link", - "description": "Link to the filing document." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending" - ], - "title": "FMPBalanceSheet", - "description": "FMP Balance Sheet Data." - }, - "FMPBalanceSheetGrowth": { - "properties": { - "symbol": { + "title": "Stock Based Compensation To Revenue Ttm", + "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months." + }, + "graham_number_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "period": { - "type": "string", - "title": "Period", - "description": "Reporting period." - }, - "growth_cash_and_cash_equivalents": { - "type": "number", - "title": "Growth Cash And Cash Equivalents", - "description": "Growth rate of cash and cash equivalents." - }, - "growth_short_term_investments": { - "type": "number", - "title": "Growth Short Term Investments", - "description": "Growth rate of short-term investments." - }, - "growth_cash_and_short_term_investments": { - "type": "number", - "title": "Growth Cash And Short Term Investments", - "description": "Growth rate of cash and short-term investments." - }, - "growth_net_receivables": { - "type": "number", - "title": "Growth Net Receivables", - "description": "Growth rate of net receivables." - }, - "growth_inventory": { - "type": "number", - "title": "Growth Inventory", - "description": "Growth rate of inventory." - }, - "growth_other_current_assets": { - "type": "number", - "title": "Growth Other Current Assets", - "description": "Growth rate of other current assets." - }, - "growth_total_current_assets": { - "type": "number", - "title": "Growth Total Current Assets", - "description": "Growth rate of total current assets." - }, - "growth_property_plant_equipment_net": { - "type": "number", - "title": "Growth Property Plant Equipment Net", - "description": "Growth rate of net property, plant, and equipment." - }, - "growth_goodwill": { - "type": "number", - "title": "Growth Goodwill", - "description": "Growth rate of goodwill." - }, - "growth_intangible_assets": { - "type": "number", - "title": "Growth Intangible Assets", - "description": "Growth rate of intangible assets." - }, - "growth_goodwill_and_intangible_assets": { - "type": "number", - "title": "Growth Goodwill And Intangible Assets", - "description": "Growth rate of goodwill and intangible assets." - }, - "growth_long_term_investments": { - "type": "number", - "title": "Growth Long Term Investments", - "description": "Growth rate of long-term investments." - }, - "growth_tax_assets": { - "type": "number", - "title": "Growth Tax Assets", - "description": "Growth rate of tax assets." - }, - "growth_other_non_current_assets": { - "type": "number", - "title": "Growth Other Non Current Assets", - "description": "Growth rate of other non-current assets." - }, - "growth_total_non_current_assets": { - "type": "number", - "title": "Growth Total Non Current Assets", - "description": "Growth rate of total non-current assets." - }, - "growth_other_assets": { - "type": "number", - "title": "Growth Other Assets", - "description": "Growth rate of other assets." - }, - "growth_total_assets": { - "type": "number", - "title": "Growth Total Assets", - "description": "Growth rate of total assets." - }, - "growth_account_payables": { - "type": "number", - "title": "Growth Account Payables", - "description": "Growth rate of accounts payable." - }, - "growth_short_term_debt": { - "type": "number", - "title": "Growth Short Term Debt", - "description": "Growth rate of short-term debt." - }, - "growth_tax_payables": { - "type": "number", - "title": "Growth Tax Payables", - "description": "Growth rate of tax payables." - }, - "growth_deferred_revenue": { - "type": "number", - "title": "Growth Deferred Revenue", - "description": "Growth rate of deferred revenue." - }, - "growth_other_current_liabilities": { - "type": "number", - "title": "Growth Other Current Liabilities", - "description": "Growth rate of other current liabilities." - }, - "growth_total_current_liabilities": { - "type": "number", - "title": "Growth Total Current Liabilities", - "description": "Growth rate of total current liabilities." - }, - "growth_long_term_debt": { - "type": "number", - "title": "Growth Long Term Debt", - "description": "Growth rate of long-term debt." - }, - "growth_deferred_revenue_non_current": { - "type": "number", - "title": "Growth Deferred Revenue Non Current", - "description": "Growth rate of non-current deferred revenue." - }, - "growth_deferrred_tax_liabilities_non_current": { - "type": "number", - "title": "Growth Deferrred Tax Liabilities Non Current", - "description": "Growth rate of non-current deferred tax liabilities." - }, - "growth_other_non_current_liabilities": { - "type": "number", - "title": "Growth Other Non Current Liabilities", - "description": "Growth rate of other non-current liabilities." - }, - "growth_total_non_current_liabilities": { - "type": "number", - "title": "Growth Total Non Current Liabilities", - "description": "Growth rate of total non-current liabilities." - }, - "growth_other_liabilities": { - "type": "number", - "title": "Growth Other Liabilities", - "description": "Growth rate of other liabilities." - }, - "growth_total_liabilities": { - "type": "number", - "title": "Growth Total Liabilities", - "description": "Growth rate of total liabilities." - }, - "growth_common_stock": { - "type": "number", - "title": "Growth Common Stock", - "description": "Growth rate of common stock." - }, - "growth_retained_earnings": { - "type": "number", - "title": "Growth Retained Earnings", - "description": "Growth rate of retained earnings." - }, - "growth_accumulated_other_comprehensive_income_loss": { - "type": "number", - "title": "Growth Accumulated Other Comprehensive Income Loss", - "description": "Growth rate of accumulated other comprehensive income/loss." - }, - "growth_othertotal_stockholders_equity": { - "type": "number", - "title": "Growth Othertotal Stockholders Equity", - "description": "Growth rate of other total stockholders' equity." - }, - "growth_total_stockholders_equity": { - "type": "number", - "title": "Growth Total Stockholders Equity", - "description": "Growth rate of total stockholders' equity." - }, - "growth_total_liabilities_and_stockholders_equity": { - "type": "number", - "title": "Growth Total Liabilities And Stockholders Equity", - "description": "Growth rate of total liabilities and stockholders' equity." - }, - "growth_total_investments": { - "type": "number", - "title": "Growth Total Investments", - "description": "Growth rate of total investments." - }, - "growth_total_debt": { - "type": "number", - "title": "Growth Total Debt", - "description": "Growth rate of total debt." - }, - "growth_net_debt": { - "type": "number", - "title": "Growth Net Debt", - "description": "Growth rate of net debt." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "period", - "growth_cash_and_cash_equivalents", - "growth_short_term_investments", - "growth_cash_and_short_term_investments", - "growth_net_receivables", - "growth_inventory", - "growth_other_current_assets", - "growth_total_current_assets", - "growth_property_plant_equipment_net", - "growth_goodwill", - "growth_intangible_assets", - "growth_goodwill_and_intangible_assets", - "growth_long_term_investments", - "growth_tax_assets", - "growth_other_non_current_assets", - "growth_total_non_current_assets", - "growth_other_assets", - "growth_total_assets", - "growth_account_payables", - "growth_short_term_debt", - "growth_tax_payables", - "growth_deferred_revenue", - "growth_other_current_liabilities", - "growth_total_current_liabilities", - "growth_long_term_debt", - "growth_deferred_revenue_non_current", - "growth_deferrred_tax_liabilities_non_current", - "growth_other_non_current_liabilities", - "growth_total_non_current_liabilities", - "growth_other_liabilities", - "growth_total_liabilities", - "growth_common_stock", - "growth_retained_earnings", - "growth_accumulated_other_comprehensive_income_loss", - "growth_othertotal_stockholders_equity", - "growth_total_stockholders_equity", - "growth_total_liabilities_and_stockholders_equity", - "growth_total_investments", - "growth_total_debt", - "growth_net_debt" - ], - "title": "FMPBalanceSheetGrowth", - "description": "FMP Balance Sheet Growth Data." - }, - "FMPCalendarDividend": { - "properties": { - "ex_dividend_date": { - "type": "string", - "format": "date", - "title": "Ex Dividend Date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." + "title": "Graham Number Ttm", + "description": "Graham number calculated as trailing twelve months." }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "roic_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Roic Ttm", + "description": "Return on invested capital calculated as trailing twelve months." }, - "amount": { + "return_on_tangible_assets_ttm": { "anyOf": [ { "type": "number" @@ -24615,61 +32448,58 @@ "type": "null" } ], - "title": "Amount", - "description": "The dividend amount per share." + "title": "Return On Tangible Assets Ttm", + "description": "Return on tangible assets calculated as trailing twelve months." }, - "name": { + "graham_net_net_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the entity." + "title": "Graham Net Net Ttm", + "description": "Graham net-net working capital calculated as trailing twelve months." }, - "record_date": { + "working_capital_ttm": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Record Date", - "description": "The record date of ownership for eligibility." + "title": "Working Capital Ttm", + "description": "Working capital calculated as trailing twelve months." }, - "payment_date": { + "tangible_asset_value_ttm": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Payment Date", - "description": "The payment date of the dividend." + "title": "Tangible Asset Value Ttm", + "description": "Tangible asset value calculated as trailing twelve months." }, - "declaration_date": { + "net_current_asset_value_ttm": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Declaration Date", - "description": "Declaration date of the dividend." + "title": "Net Current Asset Value Ttm", + "description": "Net current asset value calculated as trailing twelve months." }, - "adjusted_amount": { + "invested_capital_ttm": { "anyOf": [ { "type": "number" @@ -24678,57 +32508,46 @@ "type": "null" } ], - "title": "Adjusted Amount", - "description": "The adjusted-dividend amount." + "title": "Invested Capital Ttm", + "description": "Invested capital calculated as trailing twelve months." }, - "label": { + "average_receivables_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Label", - "description": "Ex-dividend date formatted for display." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "ex_dividend_date", - "symbol" - ], - "title": "FMPCalendarDividend", - "description": "FMP Dividend Calendar Data." - }, - "FMPCalendarEarnings": { - "properties": { - "report_date": { - "type": "string", - "format": "date", - "title": "Report Date", - "description": "The date of the earnings report." + "title": "Average Receivables Ttm", + "description": "Average receivables calculated as trailing twelve months." }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "average_payables_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Average Payables Ttm", + "description": "Average payables calculated as trailing twelve months." }, - "name": { + "average_inventory_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the entity." + "title": "Average Inventory Ttm", + "description": "Average inventory calculated as trailing twelve months." }, - "eps_previous": { + "days_sales_outstanding_ttm": { "anyOf": [ { "type": "number" @@ -24737,10 +32556,10 @@ "type": "null" } ], - "title": "Eps Previous", - "description": "The earnings-per-share from the same previously reported period." + "title": "Days Sales Outstanding Ttm", + "description": "Days sales outstanding calculated as trailing twelve months." }, - "eps_consensus": { + "days_payables_outstanding_ttm": { "anyOf": [ { "type": "number" @@ -24749,10 +32568,10 @@ "type": "null" } ], - "title": "Eps Consensus", - "description": "The analyst conesus earnings-per-share estimate." + "title": "Days Payables Outstanding Ttm", + "description": "Days payables outstanding calculated as trailing twelve months." }, - "eps_actual": { + "days_of_inventory_on_hand_ttm": { "anyOf": [ { "type": "number" @@ -24761,10 +32580,10 @@ "type": "null" } ], - "title": "Eps Actual", - "description": "The actual earnings per share announced." + "title": "Days Of Inventory On Hand Ttm", + "description": "Days of inventory on hand calculated as trailing twelve months." }, - "revenue_actual": { + "receivables_turnover_ttm": { "anyOf": [ { "type": "number" @@ -24773,10 +32592,10 @@ "type": "null" } ], - "title": "Revenue Actual", - "description": "The actual reported revenue." + "title": "Receivables Turnover Ttm", + "description": "Receivables turnover calculated as trailing twelve months." }, - "revenue_consensus": { + "payables_turnover_ttm": { "anyOf": [ { "type": "number" @@ -24785,107 +32604,148 @@ "type": "null" } ], - "title": "Revenue Consensus", - "description": "The revenue forecast consensus." + "title": "Payables Turnover Ttm", + "description": "Payables turnover calculated as trailing twelve months." }, - "period_ending": { + "inventory_turnover_ttm": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Period Ending", - "description": "The fiscal period end date." + "title": "Inventory Turnover Ttm", + "description": "Inventory turnover calculated as trailing twelve months." }, - "reporting_time": { + "roe_ttm": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Reporting Time", - "description": "The reporting time - e.g. after market close." + "title": "Roe Ttm", + "description": "Return on equity calculated as trailing twelve months." }, - "updated_date": { + "capex_per_share_ttm": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Updated Date", - "description": "The date the data was updated last." + "title": "Capex Per Share Ttm", + "description": "Capital expenditures per share calculated as trailing twelve months." } }, "additionalProperties": true, "type": "object", "required": [ - "report_date", "symbol" ], - "title": "FMPCalendarEarnings", - "description": "FMP Earnings Calendar Data." + "title": "FMPEquityValuationMultiplesData", + "description": "FMP Equity Valuation Multiples Data." }, - "FMPCalendarSplits": { + "FMPEtfCountriesData": { "properties": { - "date": { + "country": { "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "label": { + "title": "Country", + "description": "The country of the exposure. Corresponding values are normalized percentage points." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "country" + ], + "title": "FMPEtfCountriesData", + "description": "FMP ETF Countries Data." + }, + "FMPEtfEquityExposureData": { + "properties": { + "equity_symbol": { "type": "string", - "title": "Label", - "description": "Label of the stock splits." + "title": "Equity Symbol", + "description": "The symbol of the equity requested." }, - "symbol": { + "etf_symbol": { "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Etf Symbol", + "description": "The symbol of the ETF with exposure to the requested equity." }, - "numerator": { - "type": "number", - "title": "Numerator", - "description": "Numerator of the stock splits." + "shares": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Shares", + "description": "The number of shares held in the ETF." }, - "denominator": { - "type": "number", - "title": "Denominator", - "description": "Denominator of the stock splits." + "weight": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Weight", + "description": "The weight of the equity in the ETF, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "market_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Market Value", + "description": "The market value of the equity position in the ETF." } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "label", - "symbol", - "numerator", - "denominator" + "equity_symbol", + "etf_symbol" ], - "title": "FMPCalendarSplits", - "description": "FMP Calendar Splits Data." + "title": "FMPEtfEquityExposureData", + "description": "FMP ETF Equity Exposure Data." }, - "FMPCashFlowStatement": { + "FMPEtfHoldingsData": { "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" }, - "fiscal_period": { + "name": { "anyOf": [ { "type": "string" @@ -24894,10 +32754,58 @@ "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the report." + "title": "Name", + "description": "Name of the ETF holding." }, - "fiscal_year": { + "lei": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Lei", + "description": "The LEI of the holding." + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Title", + "description": "The title of the holding." + }, + "cusip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cusip", + "description": "The CUSIP of the holding." + }, + "isin": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isin", + "description": "The ISIN of the holding." + }, + "balance": { "anyOf": [ { "type": "integer" @@ -24906,24 +32814,200 @@ "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." + "title": "Balance", + "description": "The balance of the holding, in shares or units." }, - "filing_date": { + "units": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" + }, + { + "type": "number" }, { "type": "null" } ], - "title": "Filing Date", - "description": "The date of the filing." + "title": "Units", + "description": "The type of units." }, - "accepted_date": { + "cur_cd": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cur Cd", + "description": "The currency of the holding." + }, + "valUsd": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Valusd", + "description": "The value of the holding, in dollars." + }, + "pctVal": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pctval", + "description": "The weight of the holding, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "payoffProfile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Payoffprofile", + "description": "The payoff profile of the holding." + }, + "assetCat": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Assetcat", + "description": "The asset category of the holding." + }, + "issuerCat": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Issuercat", + "description": "The issuer category of the holding." + }, + "invCountry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Invcountry", + "description": "The country of the holding." + }, + "isRestrictedSec": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isrestrictedsec", + "description": "Whether the holding is restricted." + }, + "fairValLevel": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fairvallevel", + "description": "The fair value level of the holding." + }, + "isCashCollateral": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Iscashcollateral", + "description": "Whether the holding is cash collateral." + }, + "isNonCashCollateral": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isnoncashcollateral", + "description": "Whether the holding is non-cash collateral." + }, + "isLoanByFund": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Isloanbyfund", + "description": "Whether the holding is loan by fund." + }, + "cik": { "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Cik", + "description": "The CIK of the filing." + }, + "acceptanceTime": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Acceptancetime", + "description": "The acceptance datetime of the filing." + }, + "updated": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, { "type": "string", "format": "date-time" @@ -24932,10 +33016,40 @@ "type": "null" } ], - "title": "Accepted Date", - "description": "The date the filing was accepted." + "title": "Updated", + "description": "The date the data was updated." + } + }, + "additionalProperties": true, + "type": "object", + "title": "FMPEtfHoldingsData", + "description": "FMP ETF Holdings Data." + }, + "FMPEtfHoldingsDateData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FMPEtfHoldingsDateData", + "description": "FMP ETF Holdings Data." + }, + "FMPEtfInfoData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" }, - "reported_currency": { + "name": { "anyOf": [ { "type": "string" @@ -24944,94 +33058,94 @@ "type": "null" } ], - "title": "Reported Currency", - "description": "The currency in which the cash flow statement was reported." + "title": "Name", + "description": "Name of the ETF." }, - "net_income": { + "description": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income", - "description": "Net income." + "title": "Description", + "description": "Description of the fund." }, - "depreciation_and_amortization": { + "inception_date": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Depreciation And Amortization", - "description": "Depreciation and amortization." + "title": "Inception Date", + "description": "Inception date of the ETF." }, - "deferred_income_tax": { + "etfCompany": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Deferred Income Tax", - "description": "Deferred income tax." + "title": "Etfcompany", + "description": "Company of the ETF." }, - "stock_based_compensation": { + "cusip": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Stock Based Compensation", - "description": "Stock-based compensation." + "title": "Cusip", + "description": "CUSIP of the ETF." }, - "change_in_working_capital": { + "isin": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change In Working Capital", - "description": "Change in working capital." + "title": "Isin", + "description": "ISIN of the ETF." }, - "change_in_account_receivables": { + "domicile": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change In Account Receivables", - "description": "Change in account receivables." + "title": "Domicile", + "description": "Domicile of the ETF." }, - "change_in_inventory": { + "asset_class": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change In Inventory", - "description": "Change in inventory." + "title": "Asset Class", + "description": "Asset class of the ETF." }, - "change_in_account_payable": { + "aum": { "anyOf": [ { "type": "number" @@ -25040,10 +33154,10 @@ "type": "null" } ], - "title": "Change In Account Payable", - "description": "Change in account payable." + "title": "Aum", + "description": "Assets under management." }, - "change_in_other_working_capital": { + "nav": { "anyOf": [ { "type": "number" @@ -25052,22 +33166,22 @@ "type": "null" } ], - "title": "Change In Other Working Capital", - "description": "Change in other working capital." + "title": "Nav", + "description": "Net asset value of the ETF." }, - "change_in_other_non_cash_items": { + "nav_currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change In Other Non Cash Items", - "description": "Change in other non-cash items." + "title": "Nav Currency", + "description": "Currency of the ETF's net asset value." }, - "net_cash_from_operating_activities": { + "expense_ratio": { "anyOf": [ { "type": "number" @@ -25076,22 +33190,24 @@ "type": "null" } ], - "title": "Net Cash From Operating Activities", - "description": "Net cash from operating activities." + "title": "Expense Ratio", + "description": "The expense ratio, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "purchase_of_property_plant_and_equipment": { + "holdings_count": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Purchase Of Property Plant And Equipment", - "description": "Purchase of property, plant and equipment." + "title": "Holdings Count", + "description": "Number of holdings." }, - "acquisitions": { + "avg_volume": { "anyOf": [ { "type": "number" @@ -25100,34 +33216,52 @@ "type": "null" } ], - "title": "Acquisitions", - "description": "Acquisitions." + "title": "Avg Volume", + "description": "Average daily trading volume." }, - "purchase_of_investment_securities": { + "website": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Purchase Of Investment Securities", - "description": "Purchase of investment securities." + "title": "Website", + "description": "Website of the issuer." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "name", + "inception_date" + ], + "title": "FMPEtfInfoData", + "description": "FMP ETF Info Data." + }, + "FMPEtfSearchData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data.(ETF)" }, - "sale_and_maturity_of_investments": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Sale And Maturity Of Investments", - "description": "Sale and maturity of investments." + "title": "Name", + "description": "Name of the ETF." }, - "other_investing_activities": { + "marketCap": { "anyOf": [ { "type": "number" @@ -25136,34 +33270,34 @@ "type": "null" } ], - "title": "Other Investing Activities", - "description": "Other investing activities." + "title": "Marketcap", + "description": "The market cap of the ETF." }, - "net_cash_from_investing_activities": { + "sector": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Cash From Investing Activities", - "description": "Net cash from investing activities." + "title": "Sector", + "description": "The sector of the ETF." }, - "repayment_of_debt": { + "industry": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Repayment Of Debt", - "description": "Repayment of debt." + "title": "Industry", + "description": "The industry of the ETF." }, - "issuance_of_common_equity": { + "beta": { "anyOf": [ { "type": "number" @@ -25172,10 +33306,10 @@ "type": "null" } ], - "title": "Issuance Of Common Equity", - "description": "Issuance of common equity." + "title": "Beta", + "description": "The beta of the ETF." }, - "repurchase_of_common_equity": { + "price": { "anyOf": [ { "type": "number" @@ -25184,10 +33318,10 @@ "type": "null" } ], - "title": "Repurchase Of Common Equity", - "description": "Repurchase of common equity." + "title": "Price", + "description": "The current price of the ETF." }, - "payment_of_dividends": { + "lastAnnualDividend": { "anyOf": [ { "type": "number" @@ -25196,10 +33330,10 @@ "type": "null" } ], - "title": "Payment Of Dividends", - "description": "Payment of dividends." + "title": "Lastannualdividend", + "description": "The last annual dividend paid." }, - "other_financing_activities": { + "volume": { "anyOf": [ { "type": "number" @@ -25208,58 +33342,78 @@ "type": "null" } ], - "title": "Other Financing Activities", - "description": "Other financing activities." + "title": "Volume", + "description": "The current trading volume of the ETF." }, - "net_cash_from_financing_activities": { + "exchangeShortName": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Cash From Financing Activities", - "description": "Net cash from financing activities." + "title": "Exchangeshortname", + "description": "The exchange code the ETF trades on." }, - "effect_of_exchange_rate_changes_on_cash": { + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Effect Of Exchange Rate Changes On Cash", - "description": "Effect of exchange rate changes on cash." + "title": "Exchange", + "description": "The full name of the exchange the ETF trades on." }, - "net_change_in_cash_and_equivalents": { + "country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Change In Cash And Equivalents", - "description": "Net change in cash and equivalents." + "title": "Country", + "description": "The country the ETF is registered in." }, - "cash_at_beginning_of_period": { + "isActivelyTrading": { "anyOf": [ { - "type": "number" + "type": "boolean", + "enum": [ + true, + false + ] }, { "type": "null" } ], - "title": "Cash At Beginning Of Period", - "description": "Cash at beginning of period." + "title": "Isactivelytrading", + "description": "Whether the ETF is actively trading." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPEtfSearchData", + "description": "FMP ETF Search Data." + }, + "FMPEtfSectorsData": { + "properties": { + "sector": { + "type": "string", + "title": "Sector", + "description": "Sector of exposure." }, - "cash_at_end_of_period": { + "weight": { "anyOf": [ { "type": "number" @@ -25268,57 +33422,75 @@ "type": "null" } ], - "title": "Cash At End Of Period", - "description": "Cash at end of period." + "title": "Weight", + "description": "Exposure of the ETF to the sector in normalized percentage points." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "sector", + "weight" + ], + "title": "FMPEtfSectorsData", + "description": "FMP ETF Sectors Data." + }, + "FMPExecutiveCompensationData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "operating_cash_flow": { + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Operating Cash Flow", - "description": "Operating cash flow." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "capital_expenditure": { + "company_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Capital Expenditure", - "description": "Capital expenditure." + "title": "Company Name", + "description": "The name of the company." }, - "free_cash_flow": { + "industry": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Free Cash Flow" + "title": "Industry", + "description": "The industry of the company." }, - "link": { + "year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Link", - "description": "Link to the filing." + "title": "Year", + "description": "Year of the compensation." }, - "final_link": { + "name_and_position": { "anyOf": [ { "type": "string" @@ -25327,366 +33499,114 @@ "type": "null" } ], - "title": "Final Link", - "description": "Link to the filing document." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending" - ], - "title": "FMPCashFlowStatement", - "description": "FMP Cash Flow Statement Data." - }, - "FMPCashFlowStatementGrowth": { - "properties": { - "symbol": { + "title": "Name And Position", + "description": "Name and position." + }, + "salary": { "anyOf": [ { - "type": "string" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "period": { - "type": "string", - "title": "Period", - "description": "Period the statement is returned for." - }, - "growth_net_income": { - "type": "number", - "title": "Growth Net Income", - "description": "Growth rate of net income." - }, - "growth_depreciation_and_amortization": { - "type": "number", - "title": "Growth Depreciation And Amortization", - "description": "Growth rate of depreciation and amortization." - }, - "growth_deferred_income_tax": { - "type": "number", - "title": "Growth Deferred Income Tax", - "description": "Growth rate of deferred income tax." - }, - "growth_stock_based_compensation": { - "type": "number", - "title": "Growth Stock Based Compensation", - "description": "Growth rate of stock-based compensation." - }, - "growth_change_in_working_capital": { - "type": "number", - "title": "Growth Change In Working Capital", - "description": "Growth rate of change in working capital." - }, - "growth_accounts_receivables": { - "type": "number", - "title": "Growth Accounts Receivables", - "description": "Growth rate of accounts receivables." - }, - "growth_inventory": { - "type": "number", - "title": "Growth Inventory", - "description": "Growth rate of inventory." - }, - "growth_accounts_payables": { - "type": "number", - "title": "Growth Accounts Payables", - "description": "Growth rate of accounts payables." - }, - "growth_other_working_capital": { - "type": "number", - "title": "Growth Other Working Capital", - "description": "Growth rate of other working capital." - }, - "growth_other_non_cash_items": { - "type": "number", - "title": "Growth Other Non Cash Items", - "description": "Growth rate of other non-cash items." - }, - "growth_net_cash_provided_by_operating_activities": { - "type": "number", - "title": "Growth Net Cash Provided By Operating Activities", - "description": "Growth rate of net cash provided by operating activities." - }, - "growth_investments_in_property_plant_and_equipment": { - "type": "number", - "title": "Growth Investments In Property Plant And Equipment", - "description": "Growth rate of investments in property, plant, and equipment." - }, - "growth_acquisitions_net": { - "type": "number", - "title": "Growth Acquisitions Net", - "description": "Growth rate of net acquisitions." - }, - "growth_purchases_of_investments": { - "type": "number", - "title": "Growth Purchases Of Investments", - "description": "Growth rate of purchases of investments." - }, - "growth_sales_maturities_of_investments": { - "type": "number", - "title": "Growth Sales Maturities Of Investments", - "description": "Growth rate of sales maturities of investments." - }, - "growth_other_investing_activities": { - "type": "number", - "title": "Growth Other Investing Activities", - "description": "Growth rate of other investing activities." - }, - "growth_net_cash_used_for_investing_activities": { - "type": "number", - "title": "Growth Net Cash Used For Investing Activities", - "description": "Growth rate of net cash used for investing activities." - }, - "growth_debt_repayment": { - "type": "number", - "title": "Growth Debt Repayment", - "description": "Growth rate of debt repayment." - }, - "growth_common_stock_issued": { - "type": "number", - "title": "Growth Common Stock Issued", - "description": "Growth rate of common stock issued." - }, - "growth_common_stock_repurchased": { - "type": "number", - "title": "Growth Common Stock Repurchased", - "description": "Growth rate of common stock repurchased." - }, - "growth_dividends_paid": { - "type": "number", - "title": "Growth Dividends Paid", - "description": "Growth rate of dividends paid." - }, - "growth_other_financing_activities": { - "type": "number", - "title": "Growth Other Financing Activities", - "description": "Growth rate of other financing activities." - }, - "growth_net_cash_used_provided_by_financing_activities": { - "type": "number", - "title": "Growth Net Cash Used Provided By Financing Activities", - "description": "Growth rate of net cash used/provided by financing activities." - }, - "growth_effect_of_forex_changes_on_cash": { - "type": "number", - "title": "Growth Effect Of Forex Changes On Cash", - "description": "Growth rate of the effect of foreign exchange changes on cash." - }, - "growth_net_change_in_cash": { - "type": "number", - "title": "Growth Net Change In Cash", - "description": "Growth rate of net change in cash." - }, - "growth_cash_at_end_of_period": { - "type": "number", - "title": "Growth Cash At End Of Period", - "description": "Growth rate of cash at the end of the period." - }, - "growth_cash_at_beginning_of_period": { - "type": "number", - "title": "Growth Cash At Beginning Of Period", - "description": "Growth rate of cash at the beginning of the period." - }, - "growth_operating_cash_flow": { - "type": "number", - "title": "Growth Operating Cash Flow", - "description": "Growth rate of operating cash flow." - }, - "growth_capital_expenditure": { - "type": "number", - "title": "Growth Capital Expenditure", - "description": "Growth rate of capital expenditure." - }, - "growth_free_cash_flow": { - "type": "number", - "title": "Growth Free Cash Flow", - "description": "Growth rate of free cash flow." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "period", - "growth_net_income", - "growth_depreciation_and_amortization", - "growth_deferred_income_tax", - "growth_stock_based_compensation", - "growth_change_in_working_capital", - "growth_accounts_receivables", - "growth_inventory", - "growth_accounts_payables", - "growth_other_working_capital", - "growth_other_non_cash_items", - "growth_net_cash_provided_by_operating_activities", - "growth_investments_in_property_plant_and_equipment", - "growth_acquisitions_net", - "growth_purchases_of_investments", - "growth_sales_maturities_of_investments", - "growth_other_investing_activities", - "growth_net_cash_used_for_investing_activities", - "growth_debt_repayment", - "growth_common_stock_issued", - "growth_common_stock_repurchased", - "growth_dividends_paid", - "growth_other_financing_activities", - "growth_net_cash_used_provided_by_financing_activities", - "growth_effect_of_forex_changes_on_cash", - "growth_net_change_in_cash", - "growth_cash_at_end_of_period", - "growth_cash_at_beginning_of_period", - "growth_operating_cash_flow", - "growth_capital_expenditure", - "growth_free_cash_flow" - ], - "title": "FMPCashFlowStatementGrowth", - "description": "FMP Cash Flow Statement Growth Data." - }, - "FMPCompanyFilings": { - "properties": { - "filing_date": { - "type": "string", - "format": "date", - "title": "Filing Date", - "description": "The date of the filing." + "title": "Salary", + "description": "Salary." }, - "accepted_date": { + "bonus": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Accepted Date", - "description": "Accepted date of the filing." + "title": "Bonus", + "description": "Bonus payments." }, - "symbol": { + "stock_award": { "anyOf": [ { - "type": "string" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Stock Award", + "description": "Stock awards." }, - "cik": { + "incentive_plan_compensation": { "anyOf": [ { - "type": "string" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "title": "Incentive Plan Compensation", + "description": "Incentive plan compensation." }, - "report_type": { + "all_other_compensation": { "anyOf": [ { - "type": "string" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Report Type", - "description": "Type of filing." + "title": "All Other Compensation", + "description": "All other compensation." }, - "filing_url": { + "total": { "anyOf": [ { - "type": "string" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Filing Url", - "description": "URL to the filing page." - }, - "report_url": { - "type": "string", - "title": "Report Url", - "description": "URL to the actual report." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "filing_date", - "report_url" - ], - "title": "FMPCompanyFilings", - "description": "FMP Company Filings Data." - }, - "FMPCompanyNews": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. Here it is the published date of the article." - }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the article." + "title": "Total", + "description": "Total compensation." }, - "text": { + "filing_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Filing Date", + "description": "Date of the filing." }, - "images": { + "accepted_date": { "anyOf": [ { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Images", - "description": "Images associated with the article." + "title": "Accepted Date", + "description": "Date the filing was accepted." }, "url": { - "type": "string", - "title": "Url", - "description": "URL to the article." - }, - "symbols": { "anyOf": [ { "type": "string" @@ -25695,58 +33615,31 @@ "type": "null" } ], - "title": "Symbols", - "description": "Symbols associated with the article." - }, - "source": { - "type": "string", - "title": "Source", - "description": "Name of the news source." + "title": "Url", + "description": "URL to the filing data." } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "title", - "url", - "source" + "symbol" ], - "title": "FMPCompanyNews", - "description": "FMP Company News Data." + "title": "FMPExecutiveCompensationData", + "description": "FMP Executive Compensation Data." }, - "FMPCompanyOverview": { + "FMPFinancialRatiosData": { "properties": { - "symbol": { + "period_ending": { "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "price": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Price", - "description": "Price of the company." + "title": "Period Ending", + "description": "The date of the data." }, - "beta": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Beta", - "description": "Beta of the company." + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the financial ratios." }, - "vol_avg": { + "fiscal_year": { "anyOf": [ { "type": "integer" @@ -25755,22 +33648,22 @@ "type": "null" } ], - "title": "Vol Avg", - "description": "Volume average of the company." + "title": "Fiscal Year", + "description": "Fiscal year." }, - "mkt_cap": { + "symbol": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Mkt Cap", - "description": "Market capitalization of the company." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "last_div": { + "current_ratio": { "anyOf": [ { "type": "number" @@ -25779,22 +33672,22 @@ "type": "null" } ], - "title": "Last Div", - "description": "Last dividend of the company." + "title": "Current Ratio", + "description": "Current ratio." }, - "range": { + "quick_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Range", - "description": "Range of the company." + "title": "Quick Ratio", + "description": "Quick ratio." }, - "changes": { + "cash_ratio": { "anyOf": [ { "type": "number" @@ -25803,238 +33696,254 @@ "type": "null" } ], - "title": "Changes", - "description": "Changes of the company." + "title": "Cash Ratio", + "description": "Cash ratio." }, - "company_name": { + "days_of_sales_outstanding": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Company Name", - "description": "Company name of the company." + "title": "Days Of Sales Outstanding", + "description": "Days of sales outstanding." }, - "currency": { + "days_of_inventory_outstanding": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "Currency of the company." + "title": "Days Of Inventory Outstanding", + "description": "Days of inventory outstanding." }, - "cik": { + "operating_cycle": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "title": "Operating Cycle", + "description": "Operating cycle." }, - "isin": { + "days_of_payables_outstanding": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Isin", - "description": "ISIN of the company." + "title": "Days Of Payables Outstanding", + "description": "Days of payables outstanding." }, - "cusip": { + "cash_conversion_cycle": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cusip", - "description": "CUSIP of the company." + "title": "Cash Conversion Cycle", + "description": "Cash conversion cycle." }, - "exchange": { + "gross_profit_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange", - "description": "Exchange of the company." + "title": "Gross Profit Margin", + "description": "Gross profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "exchange_short_name": { + "operating_profit_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange Short Name", - "description": "Exchange short name of the company." + "title": "Operating Profit Margin", + "description": "Operating profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "industry": { + "pretax_profit_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry", - "description": "Industry of the company." + "title": "Pretax Profit Margin", + "description": "Pretax profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "website": { + "net_profit_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Website", - "description": "Website of the company." + "title": "Net Profit Margin", + "description": "Net profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "description": { + "effective_tax_rate": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Description", - "description": "Description of the company." + "title": "Effective Tax Rate", + "description": "Effective tax rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "ceo": { + "return_on_assets": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Ceo", - "description": "CEO of the company." + "title": "Return On Assets", + "description": "Return on assets.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "sector": { + "return_on_equity": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Sector", - "description": "Sector of the company." + "title": "Return On Equity", + "description": "Return on equity.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "country": { + "return_on_capital_employed": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Country", - "description": "Country of the company." + "title": "Return On Capital Employed", + "description": "Return on capital employed.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "full_time_employees": { + "net_income_per_ebt": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Full Time Employees", - "description": "Full time employees of the company." + "title": "Net Income Per Ebt", + "description": "Net income per EBT." }, - "phone": { + "ebt_per_ebit": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Phone", - "description": "Phone of the company." + "title": "Ebt Per Ebit", + "description": "EBT per EBIT." }, - "address": { + "ebit_per_revenue": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Address", - "description": "Address of the company." + "title": "Ebit Per Revenue", + "description": "EBIT per revenue." }, - "city": { + "debt_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "City", - "description": "City of the company." + "title": "Debt Ratio", + "description": "Debt ratio." }, - "state": { + "debt_equity_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "State", - "description": "State of the company." + "title": "Debt Equity Ratio", + "description": "Debt equity ratio." }, - "zip": { + "long_term_debt_to_capitalization": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Zip", - "description": "Zip of the company." + "title": "Long Term Debt To Capitalization", + "description": "Long term debt to capitalization." }, - "dcf_diff": { + "total_debt_to_capitalization": { "anyOf": [ { "type": "number" @@ -26043,10 +33952,10 @@ "type": "null" } ], - "title": "Dcf Diff", - "description": "Discounted cash flow difference of the company." + "title": "Total Debt To Capitalization", + "description": "Total debt to capitalization." }, - "dcf": { + "interest_coverage_ratio": { "anyOf": [ { "type": "number" @@ -26055,132 +33964,46 @@ "type": "null" } ], - "title": "Dcf", - "description": "Discounted cash flow of the company." + "title": "Interest Coverage Ratio", + "description": "Interest coverage." }, - "image": { + "cash_flow_to_debt": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Image", - "description": "Image of the company." + "title": "Cash Flow To Debt", + "description": "Cash flow to debt ratio." }, - "ipo_date": { + "company_equity_multiplier": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Ipo Date", - "description": "IPO date of the company." - }, - "default_image": { - "type": "boolean", - "title": "Default Image", - "description": "If the image is the default image." - }, - "is_etf": { - "type": "boolean", - "title": "Is Etf", - "description": "If the company is an ETF." - }, - "is_actively_trading": { - "type": "boolean", - "title": "Is Actively Trading", - "description": "If the company is actively trading." - }, - "is_adr": { - "type": "boolean", - "title": "Is Adr", - "description": "If the company is an ADR." - }, - "is_fund": { - "type": "boolean", - "title": "Is Fund", - "description": "If the company is a fund." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol", - "default_image", - "is_etf", - "is_actively_trading", - "is_adr", - "is_fund" - ], - "title": "FMPCompanyOverview", - "description": "FMP Company Overview Data." - }, - "FMPCryptoHistorical": { - "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." + "title": "Company Equity Multiplier", + "description": "Company equity multiplier." }, - "vwap": { + "receivables_turnover": { "anyOf": [ { - "type": "number", - "exclusiveMinimum": 0.0 + "type": "number" }, { "type": "null" } ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." + "title": "Receivables Turnover", + "description": "Receivables turnover." }, - "adj_close": { + "payables_turnover": { "anyOf": [ { "type": "number" @@ -26189,10 +34012,10 @@ "type": "null" } ], - "title": "Adj Close", - "description": "The adjusted close price." + "title": "Payables Turnover", + "description": "Payables turnover." }, - "change": { + "inventory_turnover": { "anyOf": [ { "type": "number" @@ -26201,10 +34024,10 @@ "type": "null" } ], - "title": "Change", - "description": "Change in the price from the previous close." + "title": "Inventory Turnover", + "description": "Inventory turnover." }, - "change_percent": { + "fixed_asset_turnover": { "anyOf": [ { "type": "number" @@ -26213,130 +34036,70 @@ "type": "null" } ], - "title": "Change Percent", - "description": "Change in the price from the previous close, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close", - "volume" - ], - "title": "FMPCryptoHistorical", - "description": "FMP Crypto Historical Price Data." - }, - "FMPCryptoSearch": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data. (Crypto)" + "title": "Fixed Asset Turnover", + "description": "Fixed asset turnover." }, - "name": { + "asset_turnover": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the crypto." + "title": "Asset Turnover", + "description": "Asset turnover." }, - "currency": { + "operating_cash_flow_per_share": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "The currency the crypto trades for." + "title": "Operating Cash Flow Per Share", + "description": "Operating cash flow per share." }, - "exchange": { + "free_cash_flow_per_share": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange", - "description": "The exchange code the crypto trades on." + "title": "Free Cash Flow Per Share", + "description": "Free cash flow per share." }, - "exchange_name": { + "cash_per_share": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange Name", - "description": "The short name of the exchange the crypto trades on." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPCryptoSearch", - "description": "FMP Crypto Search Data." - }, - "FMPCurrencyHistorical": { - "properties": { - "date": { + "title": "Cash Per Share", + "description": "Cash per share." + }, + "payout_ratio": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { - "type": "string", - "format": "date-time" + "type": "null" } ], - "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." + "title": "Payout Ratio", + "description": "Payout ratio." }, - "volume": { + "operating_cash_flow_sales_ratio": { "anyOf": [ { "type": "number" @@ -26345,23 +34108,22 @@ "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Operating Cash Flow Sales Ratio", + "description": "Operating cash flow sales ratio." }, - "vwap": { + "free_cash_flow_operating_cash_flow_ratio": { "anyOf": [ { - "type": "number", - "exclusiveMinimum": 0.0 + "type": "number" }, { "type": "null" } ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." + "title": "Free Cash Flow Operating Cash Flow Ratio", + "description": "Free cash flow operating cash flow ratio." }, - "adj_close": { + "cash_flow_coverage_ratio": { "anyOf": [ { "type": "number" @@ -26370,10 +34132,10 @@ "type": "null" } ], - "title": "Adj Close", - "description": "The adjusted close price." + "title": "Cash Flow Coverage Ratio", + "description": "Cash flow coverage ratio." }, - "change": { + "short_term_coverage_ratio": { "anyOf": [ { "type": "number" @@ -26382,10 +34144,10 @@ "type": "null" } ], - "title": "Change", - "description": "Change in the price from the previous close." + "title": "Short Term Coverage Ratio", + "description": "Short term coverage ratio." }, - "change_percent": { + "capital_expenditure_coverage_ratio": { "anyOf": [ { "type": "number" @@ -26394,94 +34156,34 @@ "type": "null" } ], - "title": "Change Percent", - "description": "Change in the price from the previous close, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close" - ], - "title": "FMPCurrencyHistorical", - "description": "FMP Currency Historical Price Data." - }, - "FMPCurrencyPairs": { - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "Name of the currency pair." - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol of the currency pair." - }, - "currency": { - "type": "string", - "title": "Currency", - "description": "Base currency of the currency pair." + "title": "Capital Expenditure Coverage Ratio", + "description": "Capital expenditure coverage ratio." }, - "stock_exchange": { + "price_book_value_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Stock Exchange", - "description": "Stock exchange of the currency pair." + "title": "Price Book Value Ratio", + "description": "Price book value ratio." }, - "exchange_short_name": { + "price_to_book_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange Short Name", - "description": "Short name of the stock exchange of the currency pair." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "name", - "symbol", - "currency" - ], - "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'." + "title": "Price To Book Ratio", + "description": "Price to book ratio." }, - "open": { + "price_to_sales_ratio": { "anyOf": [ { "type": "number" @@ -26490,10 +34192,10 @@ "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Price To Sales Ratio", + "description": "Price to sales ratio." }, - "high": { + "price_earnings_ratio": { "anyOf": [ { "type": "number" @@ -26502,10 +34204,10 @@ "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Price Earnings Ratio", + "description": "Price earnings ratio." }, - "low": { + "price_to_free_cash_flows_ratio": { "anyOf": [ { "type": "number" @@ -26514,10 +34216,10 @@ "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Price To Free Cash Flows Ratio", + "description": "Price to free cash flows ratio." }, - "close": { + "price_to_operating_cash_flows_ratio": { "anyOf": [ { "type": "number" @@ -26526,22 +34228,22 @@ "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Price To Operating Cash Flows Ratio", + "description": "Price to operating cash flows ratio." }, - "volume": { + "price_cash_flow_ratio": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Price Cash Flow Ratio", + "description": "Price cash flow ratio." }, - "prev_close": { + "price_earnings_to_growth_ratio": { "anyOf": [ { "type": "number" @@ -26550,10 +34252,10 @@ "type": "null" } ], - "title": "Prev Close", - "description": "The previous close price." + "title": "Price Earnings To Growth Ratio", + "description": "Price earnings to growth ratio." }, - "change": { + "price_sales_ratio": { "anyOf": [ { "type": "number" @@ -26562,10 +34264,10 @@ "type": "null" } ], - "title": "Change", - "description": "The change in the price from the previous close." + "title": "Price Sales Ratio", + "description": "Price sales ratio." }, - "change_percent": { + "dividend_paid_and_capex_coverage_ratio": { "anyOf": [ { "type": "number" @@ -26574,12 +34276,10 @@ "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" + "title": "Dividend Paid And Capex Coverage Ratio", + "description": "Dividend paid and capex coverage ratio." }, - "ma_50": { + "dividend_payout_ratio": { "anyOf": [ { "type": "number" @@ -26588,10 +34288,10 @@ "type": "null" } ], - "title": "Ma 50", - "description": "The 50-day moving average." + "title": "Dividend Payout Ratio", + "description": "Dividend payout ratio." }, - "ma_200": { + "dividend_yield": { "anyOf": [ { "type": "number" @@ -26600,10 +34300,12 @@ "type": "null" } ], - "title": "Ma 200", - "description": "The 200-day moving average." + "title": "Dividend Yield", + "description": "Dividend yield.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "year_high": { + "dividend_per_share": { "anyOf": [ { "type": "number" @@ -26612,10 +34314,10 @@ "type": "null" } ], - "title": "Year High", - "description": "The 52-week high." + "title": "Dividend Per Share", + "description": "Dividend per share." }, - "year_low": { + "enterprise_value_multiple": { "anyOf": [ { "type": "number" @@ -26624,173 +34326,89 @@ "type": "null" } ], - "title": "Year Low", - "description": "The 52-week low." + "title": "Enterprise Value Multiple", + "description": "Enterprise value multiple." }, - "last_rate_timestamp": { + "price_fair_value": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "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": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "cik": { - "type": "string", - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." - }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the filing." - }, - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data." - }, - "form_type": { - "type": "string", - "title": "Form Type", - "description": "The form type of the filing" - }, - "link": { - "type": "string", - "title": "Link", - "description": "URL to the filing page on the SEC site." + "title": "Price Fair Value", + "description": "Price fair value." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "cik", - "title", - "date", - "form_type", - "link" + "period_ending", + "fiscal_period" ], - "title": "FMPDiscoveryFilings", - "description": "FMP Discovery Filings Data." + "title": "FMPFinancialRatiosData", + "description": "FMP Financial Ratios Data." }, - "FMPEarningsCallTranscript": { + "FMPForwardEbitdaEstimatesData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, - "quarter": { - "type": "integer", - "title": "Quarter", - "description": "Quarter of the earnings call transcript." - }, - "year": { - "type": "integer", - "title": "Year", - "description": "Year of the earnings call transcript." - }, - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data." - }, - "content": { - "type": "string", - "title": "Content", - "description": "Content of the earnings call transcript." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol", - "quarter", - "year", - "date", - "content" - ], - "title": "FMPEarningsCallTranscript", - "description": "FMP Earnings Call Transcript Data." - }, - "FMPEconomicCalendar": { - "properties": { - "date": { + "name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Date", - "description": "The date of the data." + "title": "Name", + "description": "Name of the entity." }, - "country": { + "last_updated": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Country", - "description": "Country of event." + "title": "Last Updated", + "description": "The date of the last update." }, - "event": { + "period_ending": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Event", - "description": "Event name." + "title": "Period Ending", + "description": "The end date of the reporting period." }, - "reference": { + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Reference", - "description": "Abbreviated period for which released data refers to." + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." }, - "source": { + "fiscal_period": { "anyOf": [ { "type": "string" @@ -26799,115 +34417,125 @@ "type": "null" } ], - "title": "Source", - "description": "Source of the data." + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." }, - "sourceurl": { + "calendar_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Sourceurl", - "description": "Source URL." + "title": "Calendar Year", + "description": "Calendar year for the estimate." }, - "actual": { + "calendar_period": { "anyOf": [ { - "type": "string" + "type": "integer" }, { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Actual", - "description": "Latest released value." + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." }, - "previous": { + "low_estimate": { "anyOf": [ { - "type": "string" - }, - { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Previous", - "description": "Value for the previous period after the revision (if revision is applicable)." + "title": "Low Estimate", + "description": "The EBITDA estimate low for the period." }, - "consensus": { + "high_estimate": { "anyOf": [ { - "type": "string" - }, - { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Consensus", - "description": "Average forecast among a representative group of economists." + "title": "High Estimate", + "description": "The EBITDA estimate high for the period." }, - "forecast": { + "mean": { "anyOf": [ { - "type": "string" - }, - { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Forecast", - "description": "Trading Economics projections" + "title": "Mean", + "description": "The EBITDA estimate mean for the period." }, - "url": { + "median": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Url", - "description": "Trading Economics URL" + "title": "Median", + "description": "The EBITDA estimate median for the period." }, - "importance": { + "standard_deviation": { "anyOf": [ { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 3 - ] + "type": "integer" }, { - "type": "string" + "type": "null" + } + ], + "title": "Standard Deviation", + "description": "The EBITDA estimate standard deviation for the period." + }, + "number_of_analysts": { + "anyOf": [ + { + "type": "integer" }, { "type": "null" } ], - "title": "Importance", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High" + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPForwardEbitdaEstimatesData", + "description": "FMP Forward EBITDA Data." + }, + "FMPForwardEpsEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "currency": { + "name": { "anyOf": [ { "type": "string" @@ -26916,129 +34544,100 @@ "type": "null" } ], - "title": "Currency", - "description": "Currency of the data." + "title": "Name", + "description": "Name of the entity." }, - "unit": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Unit", - "description": "Unit of the data." + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." }, - "change": { + "fiscal_period": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change", - "description": "Value change since previous." + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." }, - "change_percent": { + "calendar_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Change Percent", - "description": "Percentage change since previous." + "title": "Calendar Year", + "description": "Calendar year for the estimate." }, - "updated_at": { + "calendar_period": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Updated At", - "description": "Last updated timestamp." + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." }, - "created_at": { + "low_estimate": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Created At", - "description": "Created at timestamp." - } - }, - "additionalProperties": true, - "type": "object", - "title": "FMPEconomicCalendar", - "description": "FMP Economics Calendar Data.\n\nSource: https://site.financialmodelingprep.com/developer/docs/economic-calendar-api" - }, - "FMPEquityHistorical": { - "properties": { - "date": { + "title": "Low Estimate", + "description": "Estimated EPS low for the period." + }, + "high_estimate": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { - "type": "string", - "format": "date-time" + "type": "null" } ], - "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." + "title": "High Estimate", + "description": "Estimated EPS high for the period." }, - "volume": { + "mean": { "anyOf": [ { "type": "number" }, - { - "type": "integer" - }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Mean", + "description": "Estimated EPS mean for the period." }, - "vwap": { + "median": { "anyOf": [ { "type": "number" @@ -27047,403 +34646,198 @@ "type": "null" } ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." + "title": "Median", + "description": "Estimated EPS median for the period." }, - "symbol": { + "standard_deviation": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol of the equity." + "title": "Standard Deviation", + "description": "Estimated EPS standard deviation for the period." }, - "adj_close": { + "number_of_analysts": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Adj Close", - "description": "The adjusted close price." + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "FMPForwardEpsEstimatesData", + "description": "FMP Forward EPS Data." + }, + "FMPHistoricalDividendsData": { + "properties": { + "ex_dividend_date": { + "type": "string", + "format": "date", + "title": "Ex Dividend Date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." }, - "unadjusted_volume": { + "amount": { + "type": "number", + "title": "Amount", + "description": "The dividend amount per share." + }, + "label": { + "type": "string", + "title": "Label", + "description": "Label of the historical dividends." + }, + "adj_dividend": { + "type": "number", + "title": "Adj Dividend", + "description": "Adjusted dividend of the historical dividends." + }, + "record_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Unadjusted Volume", - "description": "Unadjusted volume of the symbol." + "title": "Record Date", + "description": "Record date of the historical dividends." }, - "change": { + "payment_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Change", - "description": "Change in the price from the previous close." + "title": "Payment Date", + "description": "Payment date of the historical dividends." }, - "change_percent": { + "declaration_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Change Percent", - "description": "Change in the price from the previous close, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Declaration Date", + "description": "Declaration date of the historical dividends." } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "open", - "high", - "low", - "close" + "ex_dividend_date", + "amount", + "label", + "adj_dividend" ], - "title": "FMPEquityHistorical", - "description": "FMP Equity Historical Price Data." + "title": "FMPHistoricalDividendsData", + "description": "FMP Historical Dividends Data." }, - "FMPEquityOwnership": { + "FMPHistoricalEmployeesData": { "properties": { - "date": { + "symbol": { "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, "cik": { "type": "integer", "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." }, - "filing_date": { - "type": "string", - "format": "date", - "title": "Filing Date", - "description": "Filing date of the stock ownership." - }, - "investor_name": { - "type": "string", - "title": "Investor Name", - "description": "Investor name of the stock ownership." - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "security_name": { - "type": "string", - "title": "Security Name", - "description": "Security name of the stock ownership." - }, - "type_of_security": { - "type": "string", - "title": "Type Of Security", - "description": "Type of security of the stock ownership." - }, - "security_cusip": { + "acceptance_time": { "type": "string", - "title": "Security Cusip", - "description": "Security cusip of the stock ownership." + "format": "date-time", + "title": "Acceptance Time", + "description": "Time of acceptance of the company employee." }, - "shares_type": { + "period_of_report": { "type": "string", - "title": "Shares Type", - "description": "Shares type of the stock ownership." + "format": "date", + "title": "Period Of Report", + "description": "Date of reporting of the company employee." }, - "put_call_share": { + "company_name": { "type": "string", - "title": "Put Call Share", - "description": "Put call share of the stock ownership." + "title": "Company Name", + "description": "Registered name of the company to retrieve the historical employees of." }, - "investment_discretion": { + "form_type": { "type": "string", - "title": "Investment Discretion", - "description": "Investment discretion of the stock ownership." + "title": "Form Type", + "description": "Form type of the company employee." }, - "industry_title": { + "filing_date": { "type": "string", - "title": "Industry Title", - "description": "Industry title of the stock ownership." - }, - "weight": { - "type": "number", - "title": "Weight", - "description": "Weight of the stock ownership." - }, - "last_weight": { - "type": "number", - "title": "Last Weight", - "description": "Last weight of the stock ownership." - }, - "change_in_weight": { - "type": "number", - "title": "Change In Weight", - "description": "Change in weight of the stock ownership." - }, - "change_in_weight_percentage": { - "type": "number", - "title": "Change In Weight Percentage", - "description": "Change in weight percentage of the stock ownership." - }, - "market_value": { - "type": "integer", - "title": "Market Value", - "description": "Market value of the stock ownership." - }, - "last_market_value": { - "type": "integer", - "title": "Last Market Value", - "description": "Last market value of the stock ownership." - }, - "change_in_market_value": { - "type": "integer", - "title": "Change In Market Value", - "description": "Change in market value of the stock ownership." - }, - "change_in_market_value_percentage": { - "type": "number", - "title": "Change In Market Value Percentage", - "description": "Change in market value percentage of the stock ownership." - }, - "shares_number": { - "type": "integer", - "title": "Shares Number", - "description": "Shares number of the stock ownership." - }, - "last_shares_number": { - "type": "integer", - "title": "Last Shares Number", - "description": "Last shares number of the stock ownership." - }, - "change_in_shares_number": { - "type": "number", - "title": "Change In Shares Number", - "description": "Change in shares number of the stock ownership." - }, - "change_in_shares_number_percentage": { - "type": "number", - "title": "Change In Shares Number Percentage", - "description": "Change in shares number percentage of the stock ownership." - }, - "quarter_end_price": { - "type": "number", - "title": "Quarter End Price", - "description": "Quarter end price of the stock ownership." - }, - "avg_price_paid": { - "type": "number", - "title": "Avg Price Paid", - "description": "Average price paid of the stock ownership." - }, - "is_new": { - "type": "boolean", - "title": "Is New", - "description": "Is the stock ownership new." - }, - "is_sold_out": { - "type": "boolean", - "title": "Is Sold Out", - "description": "Is the stock ownership sold out." - }, - "ownership": { - "type": "number", - "title": "Ownership", - "description": "How much is the ownership." - }, - "last_ownership": { - "type": "number", - "title": "Last Ownership", - "description": "Last ownership amount." - }, - "change_in_ownership": { - "type": "number", - "title": "Change In Ownership", - "description": "Change in ownership amount." - }, - "change_in_ownership_percentage": { - "type": "number", - "title": "Change In Ownership Percentage", - "description": "Change in ownership percentage." + "format": "date", + "title": "Filing Date", + "description": "Filing date of the company employee" }, - "holding_period": { + "employee_count": { "type": "integer", - "title": "Holding Period", - "description": "Holding period of the stock ownership." + "title": "Employee Count", + "description": "Count of employees of the company." }, - "first_added": { + "source": { "type": "string", - "format": "date", - "title": "First Added", - "description": "First added date of the stock ownership." - }, - "performance": { - "type": "number", - "title": "Performance", - "description": "Performance of the stock ownership." - }, - "performance_percentage": { - "type": "number", - "title": "Performance Percentage", - "description": "Performance percentage of the stock ownership." - }, - "last_performance": { - "type": "number", - "title": "Last Performance", - "description": "Last performance of the stock ownership." - }, - "change_in_performance": { - "type": "number", - "title": "Change In Performance", - "description": "Change in performance of the stock ownership." - }, - "is_counted_for_performance": { - "type": "boolean", - "title": "Is Counted For Performance", - "description": "Is the stock ownership counted for performance." + "title": "Source", + "description": "Source URL which retrieves this data for the company." } }, "additionalProperties": true, "type": "object", "required": [ - "date", + "symbol", "cik", + "acceptance_time", + "period_of_report", + "company_name", + "form_type", "filing_date", - "investor_name", - "symbol", - "security_name", - "type_of_security", - "security_cusip", - "shares_type", - "put_call_share", - "investment_discretion", - "industry_title", - "weight", - "last_weight", - "change_in_weight", - "change_in_weight_percentage", - "market_value", - "last_market_value", - "change_in_market_value", - "change_in_market_value_percentage", - "shares_number", - "last_shares_number", - "change_in_shares_number", - "change_in_shares_number_percentage", - "quarter_end_price", - "avg_price_paid", - "is_new", - "is_sold_out", - "ownership", - "last_ownership", - "change_in_ownership", - "change_in_ownership_percentage", - "holding_period", - "first_added", - "performance", - "performance_percentage", - "last_performance", - "change_in_performance", - "is_counted_for_performance" + "employee_count", + "source" ], - "title": "FMPEquityOwnership", - "description": "FMP Equity Ownership Data." - }, - "FMPEquityPeers": { - "properties": { - "peers_list": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Peers List", - "description": "A list of equity peers based on sector, exchange and market cap." - } - }, - "additionalProperties": true, - "type": "object", - "title": "FMPEquityPeers", - "description": "FMP Equity Peers Data." + "title": "FMPHistoricalEmployeesData", + "description": "FMP Historical Employees Data." }, - "FMPEquityProfile": { + "FMPHistoricalEpsData": { "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name", - "description": "Common name of the company." - }, - "cik": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." - }, - "cusip": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Cusip", - "description": "CUSIP identifier for the company." - }, - "isin": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Isin", - "description": "International Securities Identification Number." - }, - "lei": { + "announce_time": { "anyOf": [ { "type": "string" @@ -27452,58 +34846,58 @@ "type": "null" } ], - "title": "Lei", - "description": "Legal Entity Identifier assigned to the company." + "title": "Announce Time", + "description": "Timing of the earnings announcement." }, - "legal_name": { + "eps_actual": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Legal Name", - "description": "Official legal name of the company." + "title": "Eps Actual", + "description": "Actual EPS from the earnings date." }, - "stock_exchange": { + "eps_estimated": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Stock Exchange", - "description": "Stock exchange where the company is traded." + "title": "Eps Estimated", + "description": "Estimated EPS for the earnings date." }, - "sic": { + "revenueEstimated": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Sic", - "description": "Standard Industrial Classification code for the company." + "title": "Revenueestimated", + "description": "Estimated consensus revenue for the reporting period." }, - "short_description": { + "revenue": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Short Description", - "description": "Short description of the company." + "title": "Revenue", + "description": "The actual reported revenue." }, - "long_description": { + "time": { "anyOf": [ { "type": "string" @@ -27512,58 +34906,77 @@ "type": "null" } ], - "title": "Long Description", - "description": "Long description of the company." + "title": "Time", + "description": "The reporting time - e.g. after market close." }, - "ceo": { + "updatedFromDate": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Ceo", - "description": "Chief Executive Officer of the company." + "title": "Updatedfromdate", + "description": "The date when the data was last updated." }, - "company_url": { + "fiscalDateEnding": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Company Url", - "description": "URL of the company's website." + "title": "Fiscaldateending", + "description": "The fiscal period end date." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPHistoricalEpsData", + "description": "FMP Historical EPS Data." + }, + "FMPHistoricalSplitsData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "business_address": { + "numerator": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Business Address", - "description": "Address of the company's headquarters." + "title": "Numerator", + "description": "Numerator of the split." }, - "mailing_address": { + "denominator": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Mailing Address", - "description": "Mailing address of the company." + "title": "Denominator", + "description": "Denominator of the split." }, - "business_phone_no": { + "split_ratio": { "anyOf": [ { "type": "string" @@ -27572,10 +34985,27 @@ "type": "null" } ], - "title": "Business Phone No", - "description": "Phone number of the company's headquarters." + "title": "Split Ratio", + "description": "Split ratio." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FMPHistoricalSplitsData", + "description": "FMP Historical Splits Data." + }, + "FMPIncomeStatementData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end date of the reporting period." }, - "hq_address_1": { + "fiscal_period": { "anyOf": [ { "type": "string" @@ -27584,46 +35014,48 @@ "type": "null" } ], - "title": "Hq Address 1", - "description": "Address of the company's headquarters." + "title": "Fiscal Period", + "description": "The fiscal period of the report." }, - "hq_address_2": { + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Hq Address 2", - "description": "Address of the company's headquarters." + "title": "Fiscal Year", + "description": "The fiscal year of the fiscal period." }, - "hq_address_city": { + "filing_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Hq Address City", - "description": "City of the company's headquarters." + "title": "Filing Date", + "description": "The date when the filing was made." }, - "hq_address_postal_code": { + "accepted_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Hq Address Postal Code", - "description": "Zip code of the company's headquarters." + "title": "Accepted Date", + "description": "The date and time when the filing was accepted." }, - "hq_state": { + "reported_currency": { "anyOf": [ { "type": "string" @@ -27632,275 +35064,250 @@ "type": "null" } ], - "title": "Hq State", - "description": "State of the company's headquarters." + "title": "Reported Currency", + "description": "The currency in which the balance sheet was reported." }, - "hq_country": { + "revenue": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Hq Country", - "description": "Country of the company's headquarters." + "title": "Revenue", + "description": "Total revenue." }, - "inc_state": { + "cost_of_revenue": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Inc State", - "description": "State in which the company is incorporated." + "title": "Cost Of Revenue", + "description": "Cost of revenue." }, - "inc_country": { + "gross_profit": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Inc Country", - "description": "Country in which the company is incorporated." + "title": "Gross Profit", + "description": "Gross profit." }, - "employees": { + "gross_profit_margin": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Employees", - "description": "Number of employees working for the company." + "title": "Gross Profit Margin", + "description": "Gross profit margin." }, - "entity_legal_form": { + "general_and_admin_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Entity Legal Form", - "description": "Legal form of the company." + "title": "General And Admin Expense", + "description": "General and administrative expenses." }, - "entity_status": { + "research_and_development_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Entity Status", - "description": "Status of the company." + "title": "Research And Development Expense", + "description": "Research and development expenses." }, - "latest_filing_date": { + "selling_and_marketing_expense": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Latest Filing Date", - "description": "Date of the company's latest filing." + "title": "Selling And Marketing Expense", + "description": "Selling and marketing expenses." }, - "irs_number": { + "selling_general_and_admin_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Irs Number", - "description": "IRS number assigned to the company." + "title": "Selling General And Admin Expense", + "description": "Selling, general and administrative expenses." }, - "sector": { + "other_expenses": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Sector", - "description": "Sector in which the company operates." + "title": "Other Expenses", + "description": "Other expenses." }, - "industry_category": { + "total_operating_expenses": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry Category", - "description": "Category of industry in which the company operates." + "title": "Total Operating Expenses", + "description": "Total operating expenses." }, - "industry_group": { + "cost_and_expenses": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry Group", - "description": "Group of industry in which the company operates." + "title": "Cost And Expenses", + "description": "Cost and expenses." }, - "template": { + "interest_income": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Template", - "description": "Template used to standardize the company's financial statements." + "title": "Interest Income", + "description": "Interest income." }, - "standardized_active": { + "total_interest_expense": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Standardized Active", - "description": "Whether the company is active or not." + "title": "Total Interest Expense", + "description": "Total interest expenses." }, - "first_fundamental_date": { + "depreciation_and_amortization": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "First Fundamental Date", - "description": "Date of the company's first fundamental." + "title": "Depreciation And Amortization", + "description": "Depreciation and amortization." }, - "last_fundamental_date": { + "ebitda": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Last Fundamental Date", - "description": "Date of the company's last fundamental." + "title": "Ebitda", + "description": "EBITDA." }, - "first_stock_price_date": { + "ebitda_margin": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "First Stock Price Date", - "description": "Date of the company's first stock price." + "title": "Ebitda Margin", + "description": "EBITDA margin." }, - "last_stock_price_date": { + "total_operating_income": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Last Stock Price Date", - "description": "Date of the company's last stock price." - }, - "is_etf": { - "type": "boolean", - "title": "Is Etf", - "description": "If the symbol is an ETF." - }, - "is_actively_trading": { - "type": "boolean", - "title": "Is Actively Trading", - "description": "If the company is actively trading." - }, - "is_adr": { - "type": "boolean", - "title": "Is Adr", - "description": "If the stock is an ADR." - }, - "is_fund": { - "type": "boolean", - "title": "Is Fund", - "description": "If the company is a fund." + "title": "Total Operating Income", + "description": "Total operating income." }, - "image": { + "operating_income_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Image", - "description": "Image of the company." + "title": "Operating Income Margin", + "description": "Operating income margin." }, - "currency": { + "total_other_income_expenses": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "Currency in which the stock is traded." + "title": "Total Other Income Expenses", + "description": "Total other income and expenses." }, - "market_cap": { + "total_pre_tax_income": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Market Cap", - "description": "Market capitalization of the company." + "title": "Total Pre Tax Income", + "description": "Total pre-tax income." }, - "last_price": { + "pre_tax_income_margin": { "anyOf": [ { "type": "number" @@ -27909,10 +35316,10 @@ "type": "null" } ], - "title": "Last Price", - "description": "The last traded price." + "title": "Pre Tax Income Margin", + "description": "Pre-tax income margin." }, - "year_high": { + "income_tax_expense": { "anyOf": [ { "type": "number" @@ -27921,10 +35328,10 @@ "type": "null" } ], - "title": "Year High", - "description": "The one-year high of the price." + "title": "Income Tax Expense", + "description": "Income tax expense." }, - "year_low": { + "consolidated_net_income": { "anyOf": [ { "type": "number" @@ -27933,22 +35340,22 @@ "type": "null" } ], - "title": "Year Low", - "description": "The one-year low of the price." + "title": "Consolidated Net Income", + "description": "Consolidated net income." }, - "volume_avg": { + "net_income_margin": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume Avg", - "description": "Average daily trading volume." + "title": "Net Income Margin", + "description": "Net income margin." }, - "annualized_dividend_amount": { + "basic_earnings_per_share": { "anyOf": [ { "type": "number" @@ -27957,10 +35364,10 @@ "type": "null" } ], - "title": "Annualized Dividend Amount", - "description": "The annualized dividend payment based on the most recent regular dividend payment." + "title": "Basic Earnings Per Share", + "description": "Basic earnings per share." }, - "beta": { + "diluted_earnings_per_share": { "anyOf": [ { "type": "number" @@ -27969,54 +35376,34 @@ "type": "null" } ], - "title": "Beta", - "description": "Beta of the stock relative to the market." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol", - "is_etf", - "is_actively_trading", - "is_adr", - "is_fund" - ], - "title": "FMPEquityProfile", - "description": "FMP Equity Profile Data." - }, - "FMPEquityQuote": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Diluted Earnings Per Share", + "description": "Diluted earnings per share." }, - "asset_type": { + "weighted_average_basic_shares_outstanding": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Asset Type", - "description": "Type of asset - i.e, stock, ETF, etc." + "title": "Weighted Average Basic Shares Outstanding", + "description": "Weighted average basic shares outstanding." }, - "name": { + "weighted_average_diluted_shares_outstanding": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the company or asset." + "title": "Weighted Average Diluted Shares Outstanding", + "description": "Weighted average diluted shares outstanding." }, - "exchange": { + "link": { "anyOf": [ { "type": "string" @@ -28025,34 +35412,229 @@ "type": "null" } ], - "title": "Exchange", - "description": "The name or symbol of the venue where the data is from." + "title": "Link", + "description": "Link to the filing." }, - "bid": { + "final_link": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Bid", - "description": "Price of the top bid order." - }, - "bid_size": { + "title": "Final Link", + "description": "Link to the filing document." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending" + ], + "title": "FMPIncomeStatementData", + "description": "FMP Income Statement Data." + }, + "FMPIncomeStatementGrowthData": { + "properties": { + "symbol": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Bid Size", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "bid_exchange": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "period": { + "type": "string", + "title": "Period", + "description": "Period the statement is returned for." + }, + "growth_revenue": { + "type": "number", + "title": "Growth Revenue", + "description": "Growth rate of total revenue." + }, + "growth_cost_of_revenue": { + "type": "number", + "title": "Growth Cost Of Revenue", + "description": "Growth rate of cost of goods sold." + }, + "growth_gross_profit": { + "type": "number", + "title": "Growth Gross Profit", + "description": "Growth rate of gross profit." + }, + "growth_gross_profit_ratio": { + "type": "number", + "title": "Growth Gross Profit Ratio", + "description": "Growth rate of gross profit as a percentage of revenue." + }, + "growth_research_and_development_expenses": { + "type": "number", + "title": "Growth Research And Development Expenses", + "description": "Growth rate of expenses on research and development." + }, + "growth_general_and_administrative_expenses": { + "type": "number", + "title": "Growth General And Administrative Expenses", + "description": "Growth rate of general and administrative expenses." + }, + "growth_selling_and_marketing_expenses": { + "type": "number", + "title": "Growth Selling And Marketing Expenses", + "description": "Growth rate of expenses on selling and marketing activities." + }, + "growth_other_expenses": { + "type": "number", + "title": "Growth Other Expenses", + "description": "Growth rate of other operating expenses." + }, + "growth_operating_expenses": { + "type": "number", + "title": "Growth Operating Expenses", + "description": "Growth rate of total operating expenses." + }, + "growth_cost_and_expenses": { + "type": "number", + "title": "Growth Cost And Expenses", + "description": "Growth rate of total costs and expenses." + }, + "growth_interest_expense": { + "type": "number", + "title": "Growth Interest Expense", + "description": "Growth rate of interest expenses." + }, + "growth_depreciation_and_amortization": { + "type": "number", + "title": "Growth Depreciation And Amortization", + "description": "Growth rate of depreciation and amortization expenses." + }, + "growth_ebitda": { + "type": "number", + "title": "Growth Ebitda", + "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization." + }, + "growth_ebitda_ratio": { + "type": "number", + "title": "Growth Ebitda Ratio", + "description": "Growth rate of EBITDA as a percentage of revenue." + }, + "growth_operating_income": { + "type": "number", + "title": "Growth Operating Income", + "description": "Growth rate of operating income." + }, + "growth_operating_income_ratio": { + "type": "number", + "title": "Growth Operating Income Ratio", + "description": "Growth rate of operating income as a percentage of revenue." + }, + "growth_total_other_income_expenses_net": { + "type": "number", + "title": "Growth Total Other Income Expenses Net", + "description": "Growth rate of net total other income and expenses." + }, + "growth_income_before_tax": { + "type": "number", + "title": "Growth Income Before Tax", + "description": "Growth rate of income before taxes." + }, + "growth_income_before_tax_ratio": { + "type": "number", + "title": "Growth Income Before Tax Ratio", + "description": "Growth rate of income before taxes as a percentage of revenue." + }, + "growth_income_tax_expense": { + "type": "number", + "title": "Growth Income Tax Expense", + "description": "Growth rate of income tax expenses." + }, + "growth_net_income": { + "type": "number", + "title": "Growth Net Income", + "description": "Growth rate of net income." + }, + "growth_net_income_ratio": { + "type": "number", + "title": "Growth Net Income Ratio", + "description": "Growth rate of net income as a percentage of revenue." + }, + "growth_eps": { + "type": "number", + "title": "Growth Eps", + "description": "Growth rate of Earnings Per Share (EPS)." + }, + "growth_eps_diluted": { + "type": "number", + "title": "Growth Eps Diluted", + "description": "Growth rate of diluted Earnings Per Share (EPS)." + }, + "growth_weighted_average_shs_out": { + "type": "number", + "title": "Growth Weighted Average Shs Out", + "description": "Growth rate of weighted average shares outstanding." + }, + "growth_weighted_average_shs_out_dil": { + "type": "number", + "title": "Growth Weighted Average Shs Out Dil", + "description": "Growth rate of diluted weighted average shares outstanding." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "period", + "growth_revenue", + "growth_cost_of_revenue", + "growth_gross_profit", + "growth_gross_profit_ratio", + "growth_research_and_development_expenses", + "growth_general_and_administrative_expenses", + "growth_selling_and_marketing_expenses", + "growth_other_expenses", + "growth_operating_expenses", + "growth_cost_and_expenses", + "growth_interest_expense", + "growth_depreciation_and_amortization", + "growth_ebitda", + "growth_ebitda_ratio", + "growth_operating_income", + "growth_operating_income_ratio", + "growth_total_other_income_expenses_net", + "growth_income_before_tax", + "growth_income_before_tax_ratio", + "growth_income_tax_expense", + "growth_net_income", + "growth_net_income_ratio", + "growth_eps", + "growth_eps_diluted", + "growth_weighted_average_shs_out", + "growth_weighted_average_shs_out_dil" + ], + "title": "FMPIncomeStatementGrowthData", + "description": "FMP Income Statement Growth Data." + }, + "FMPIndexConstituentsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { "anyOf": [ { "type": "string" @@ -28061,34 +35643,27 @@ "type": "null" } ], - "title": "Bid Exchange", - "description": "The specific trading venue where the purchase order was placed." + "title": "Name", + "description": "Name of the constituent company in the index." }, - "ask": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Ask", - "description": "Price of the top ask order." + "sector": { + "type": "string", + "title": "Sector", + "description": "Sector the constituent company in the index belongs to." }, - "ask_size": { + "sub_sector": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Ask Size", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." + "title": "Sub Sector", + "description": "Sub-sector the constituent company in the index belongs to." }, - "ask_exchange": { + "headquarter": { "anyOf": [ { "type": "string" @@ -28097,154 +35672,104 @@ "type": "null" } ], - "title": "Ask Exchange", - "description": "The specific trading venue where the sale order was placed." + "title": "Headquarter", + "description": "Location of the headquarter of the constituent company in the index." }, - "quote_conditions": { + "date_first_added": { "anyOf": [ { "type": "string" }, { - "type": "integer" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Quote Conditions", - "description": "Conditions or condition codes applicable to the quote." + "title": "Date First Added", + "description": "Date the constituent company was added to the index." }, - "quote_indicators": { + "cik": { "anyOf": [ - { - "type": "string" - }, { "type": "integer" }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, { "type": "null" } ], - "title": "Quote Indicators", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "sales_conditions": { + "founded": { "anyOf": [ { "type": "string" }, { - "type": "integer" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Sales Conditions", - "description": "Conditions or condition codes applicable to the sale." - }, - "sequence_number": { - "anyOf": [ - { - "type": "integer" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Sequence Number", - "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)." - }, - "market_center": { + "title": "Founded", + "description": "Founding year of the constituent company in the index." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "sector" + ], + "title": "FMPIndexConstituentsData", + "description": "FMP Index Constituents Data." + }, + "FMPIndexHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, - { - "type": "null" - } - ], - "title": "Market Center", - "description": "The ID of the UTP participant that originated the message." - }, - "participant_timestamp": { - "anyOf": [ { "type": "string", "format": "date-time" - }, - { - "type": "null" } ], - "title": "Participant Timestamp", - "description": "Timestamp for when the quote was generated by the exchange." + "title": "Date", + "description": "The date of the data." }, - "trf_timestamp": { + "open": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Trf Timestamp", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." + "title": "Open", + "description": "The open price." }, - "sip_timestamp": { + "high": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Sip Timestamp", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." + "title": "High", + "description": "The high price." }, - "last_price": { + "low": { "anyOf": [ { "type": "number" @@ -28253,22 +35778,22 @@ "type": "null" } ], - "title": "Last Price", - "description": "Price of the last trade." + "title": "Low", + "description": "The low price." }, - "last_tick": { + "close": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Last Tick", - "description": "Whether the last sale was an up or down tick." + "title": "Close", + "description": "The close price." }, - "last_size": { + "volume": { "anyOf": [ { "type": "integer" @@ -28277,23 +35802,22 @@ "type": "null" } ], - "title": "Last Size", - "description": "Size of the last trade." + "title": "Volume", + "description": "The trading volume." }, - "last_timestamp": { + "vwap": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Last Timestamp", - "description": "Date and Time when the last price was recorded." + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, - "open": { + "change": { "anyOf": [ { "type": "number" @@ -28302,10 +35826,10 @@ "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Change", + "description": "Change in the price from the previous close." }, - "high": { + "changeOverTime": { "anyOf": [ { "type": "number" @@ -28314,137 +35838,155 @@ "type": "null" } ], - "title": "High", - "description": "The high price." - }, - "low": { + "title": "Changeovertime", + "description": "Change in the price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FMPIndexHistoricalData", + "description": "FMP Index Historical Data." + }, + "FMPInsiderTradingData": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "close": { + "company_cik": { "anyOf": [ { - "type": "number" + "type": "integer" + }, + { + "type": "string" }, { "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Company Cik", + "description": "CIK number of the company." }, - "volume": { + "filing_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Filing Date", + "description": "Filing date of the trade." }, - "exchange_volume": { + "transaction_date": { "anyOf": [ { - "type": "number" - }, - { - "type": "integer" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Exchange Volume", - "description": "Volume of shares exchanged during the trading day on the specific exchange." + "title": "Transaction Date", + "description": "Date of the transaction." }, - "prev_close": { + "owner_cik": { "anyOf": [ { - "type": "number" + "type": "integer" + }, + { + "type": "string" }, { "type": "null" } ], - "title": "Prev Close", - "description": "The previous close price." + "title": "Owner Cik", + "description": "Reporting individual's CIK." }, - "change": { + "owner_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change", - "description": "Change in price from previous close." + "title": "Owner Name", + "description": "Name of the reporting individual." }, - "change_percent": { + "owner_title": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change Percent", - "description": "Change in price as a normalized percentage.", - "x-frontend_multiply": 100 + "title": "Owner Title", + "description": "The title held by the reporting individual." }, - "year_high": { + "transaction_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Year High", - "description": "The one year high (52W High)." + "title": "Transaction Type", + "description": "Type of transaction being reported." }, - "year_low": { + "acquisition_or_disposition": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Year Low", - "description": "The one year low (52W Low)." + "title": "Acquisition Or Disposition", + "description": "Acquisition or disposition of the shares." }, - "price_avg_50": { + "security_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Price Avg 50", - "description": "50 day moving average price." + "title": "Security Type", + "description": "The type of security transacted." }, - "price_avg_200": { + "securities_owned": { "anyOf": [ { "type": "number" @@ -28453,22 +35995,22 @@ "type": "null" } ], - "title": "Price Avg 200", - "description": "200 day moving average price." + "title": "Securities Owned", + "description": "Number of securities owned by the reporting individual." }, - "avg_volume": { + "securities_transacted": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Avg Volume", - "description": "Average volume over the last 10 trading days." + "title": "Securities Transacted", + "description": "Number of securities transacted by the reporting individual." }, - "market_cap": { + "transaction_price": { "anyOf": [ { "type": "number" @@ -28477,80 +36019,278 @@ "type": "null" } ], - "title": "Market Cap", - "description": "Market cap of the company." + "title": "Transaction Price", + "description": "The price of the transaction." }, - "shares_outstanding": { + "filing_url": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Shares Outstanding", - "description": "Number of shares outstanding." + "title": "Filing Url", + "description": "Link to the filing." }, - "eps": { + "form_type": { + "type": "string", + "title": "Form Type", + "description": "Form type of the insider trading." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "form_type" + ], + "title": "FMPInsiderTradingData", + "description": "FMP Insider Trading Data." + }, + "FMPInstitutionalOwnershipData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Eps", - "description": "Earnings per share." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." + }, + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "investors_holding": { + "type": "integer", + "title": "Investors Holding", + "description": "Number of investors holding the stock." + }, + "last_investors_holding": { + "type": "integer", + "title": "Last Investors Holding", + "description": "Number of investors holding the stock in the last quarter." + }, + "investors_holding_change": { + "type": "integer", + "title": "Investors Holding Change", + "description": "Change in the number of investors holding the stock." + }, + "numberOf13Fshares": { + "type": "integer", + "title": "Numberof13Fshares", + "description": "Number of 13F shares." + }, + "lastNumberOf13Fshares": { + "type": "integer", + "title": "Lastnumberof13Fshares", + "description": "Number of 13F shares in the last quarter." + }, + "numberOf13FsharesChange": { + "type": "integer", + "title": "Numberof13Fshareschange", + "description": "Change in the number of 13F shares." + }, + "total_invested": { + "type": "number", + "title": "Total Invested", + "description": "Total amount invested." + }, + "last_total_invested": { + "type": "number", + "title": "Last Total Invested", + "description": "Total amount invested in the last quarter." + }, + "total_invested_change": { + "type": "number", + "title": "Total Invested Change", + "description": "Change in the total amount invested." + }, + "ownership_percent": { + "type": "number", + "title": "Ownership Percent", + "description": "Ownership percent." + }, + "last_ownership_percent": { + "type": "number", + "title": "Last Ownership Percent", + "description": "Ownership percent in the last quarter." + }, + "ownership_percent_change": { + "type": "number", + "title": "Ownership Percent Change", + "description": "Change in the ownership percent." + }, + "new_positions": { + "type": "integer", + "title": "New Positions", + "description": "Number of new positions." + }, + "last_new_positions": { + "type": "integer", + "title": "Last New Positions", + "description": "Number of new positions in the last quarter." + }, + "new_positions_change": { + "type": "integer", + "title": "New Positions Change", + "description": "Change in the number of new positions." + }, + "increased_positions": { + "type": "integer", + "title": "Increased Positions", + "description": "Number of increased positions." + }, + "last_increased_positions": { + "type": "integer", + "title": "Last Increased Positions", + "description": "Number of increased positions in the last quarter." + }, + "increased_positions_change": { + "type": "integer", + "title": "Increased Positions Change", + "description": "Change in the number of increased positions." + }, + "closed_positions": { + "type": "integer", + "title": "Closed Positions", + "description": "Number of closed positions." + }, + "last_closed_positions": { + "type": "integer", + "title": "Last Closed Positions", + "description": "Number of closed positions in the last quarter." + }, + "closed_positions_change": { + "type": "integer", + "title": "Closed Positions Change", + "description": "Change in the number of closed positions." + }, + "reduced_positions": { + "type": "integer", + "title": "Reduced Positions", + "description": "Number of reduced positions." + }, + "last_reduced_positions": { + "type": "integer", + "title": "Last Reduced Positions", + "description": "Number of reduced positions in the last quarter." + }, + "reduced_positions_change": { + "type": "integer", + "title": "Reduced Positions Change", + "description": "Change in the number of reduced positions." + }, + "total_calls": { + "type": "integer", + "title": "Total Calls", + "description": "Total number of call options contracts traded for Apple Inc. on the specified date." + }, + "last_total_calls": { + "type": "integer", + "title": "Last Total Calls", + "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date." + }, + "total_calls_change": { + "type": "integer", + "title": "Total Calls Change", + "description": "Change in the total number of call options contracts traded between the current and previous reporting dates." + }, + "total_puts": { + "type": "integer", + "title": "Total Puts", + "description": "Total number of put options contracts traded for Apple Inc. on the specified date." + }, + "last_total_puts": { + "type": "integer", + "title": "Last Total Puts", + "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date." + }, + "total_puts_change": { + "type": "integer", + "title": "Total Puts Change", + "description": "Change in the total number of put options contracts traded between the current and previous reporting dates." + }, + "put_call_ratio": { + "type": "number", + "title": "Put Call Ratio", + "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date." }, - "pe": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Pe", - "description": "Price earnings ratio." + "last_put_call_ratio": { + "type": "number", + "title": "Last Put Call Ratio", + "description": "Put-call ratio on the previous reporting date." }, - "earnings_announcement": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Earnings Announcement", - "description": "Upcoming earnings announcement date." + "put_call_ratio_change": { + "type": "number", + "title": "Put Call Ratio Change", + "description": "Change in the put-call ratio between the current and previous reporting dates." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol" + "symbol", + "date", + "investors_holding", + "last_investors_holding", + "investors_holding_change", + "total_invested", + "last_total_invested", + "total_invested_change", + "ownership_percent", + "last_ownership_percent", + "ownership_percent_change", + "new_positions", + "last_new_positions", + "new_positions_change", + "increased_positions", + "last_increased_positions", + "increased_positions_change", + "closed_positions", + "last_closed_positions", + "closed_positions_change", + "reduced_positions", + "last_reduced_positions", + "reduced_positions_change", + "total_calls", + "last_total_calls", + "total_calls_change", + "total_puts", + "last_total_puts", + "total_puts_change", + "put_call_ratio", + "last_put_call_ratio", + "put_call_ratio_change" ], - "title": "FMPEquityQuote", - "description": "FMP Equity Quote Data." + "title": "FMPInstitutionalOwnershipData", + "description": "FMP Institutional Ownership Data." }, - "FMPEquityScreener": { + "FMPKeyExecutivesData": { "properties": { - "symbol": { + "title": { "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Title", + "description": "Designation of the key executive." }, "name": { "type": "string", "title": "Name", - "description": "Name of the company." + "description": "Name of the key executive." }, - "market_cap": { + "pay": { "anyOf": [ { "type": "integer" @@ -28559,10 +36299,10 @@ "type": "null" } ], - "title": "Market Cap", - "description": "The market cap of ticker." + "title": "Pay", + "description": "Pay of the key executive." }, - "sector": { + "currency_pay": { "anyOf": [ { "type": "string" @@ -28571,10 +36311,10 @@ "type": "null" } ], - "title": "Sector", - "description": "The sector the ticker belongs to." + "title": "Currency Pay", + "description": "Currency of the pay." }, - "industry": { + "gender": { "anyOf": [ { "type": "string" @@ -28583,46 +36323,10 @@ "type": "null" } ], - "title": "Industry", - "description": "The industry ticker belongs to." - }, - "beta": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Beta", - "description": "The beta of the ETF." - }, - "price": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Price", - "description": "The current price." - }, - "last_annual_dividend": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Last Annual Dividend", - "description": "The last annual amount dividend paid." + "title": "Gender", + "description": "Gender of the key executive." }, - "volume": { + "year_born": { "anyOf": [ { "type": "integer" @@ -28631,119 +36335,46 @@ "type": "null" } ], - "title": "Volume", - "description": "The current trading volume." - }, - "exchange": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Exchange", - "description": "The exchange code the asset trades on." - }, - "exchange_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Exchange Name", - "description": "The full name of the primary exchange." - }, - "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Country", - "description": "The two-letter country abbreviation where the head office is located." - }, - "is_etf": { - "anyOf": [ - { - "type": "boolean", - "enum": [ - true, - false - ] - }, - { - "type": "null" - } - ], - "title": "Is Etf", - "description": "Whether the ticker is an ETF." + "title": "Year Born", + "description": "Birth year of the key executive." }, - "actively_trading": { + "title_since": { "anyOf": [ { - "type": "boolean", - "enum": [ - true, - false - ] + "type": "integer" }, { "type": "null" } ], - "title": "Actively Trading", - "description": "Whether the ETF is actively trading." + "title": "Title Since", + "description": "Date the tile was held since." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", + "title", "name" ], - "title": "FMPEquityScreener", - "description": "FMP Equity Screener Data." + "title": "FMPKeyExecutivesData", + "description": "FMP Key Executives Data." }, - "FMPEquityValuationMultiples": { + "FMPKeyMetricsData": { "properties": { "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "revenue_per_share_ttm": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Revenue Per Share Ttm", - "description": "Revenue per share calculated as trailing twelve months." - }, - "net_income_per_share_ttm": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income Per Share Ttm", - "description": "Net income per share calculated as trailing twelve months." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "operating_cash_flow_per_share_ttm": { + "market_cap": { "anyOf": [ { "type": "number" @@ -28752,10 +36383,10 @@ "type": "null" } ], - "title": "Operating Cash Flow Per Share Ttm", - "description": "Operating cash flow per share calculated as trailing twelve months." + "title": "Market Cap", + "description": "Market capitalization" }, - "free_cash_flow_per_share_ttm": { + "pe_ratio": { "anyOf": [ { "type": "number" @@ -28764,46 +36395,33 @@ "type": "null" } ], - "title": "Free Cash Flow Per Share Ttm", - "description": "Free cash flow per share calculated as trailing twelve months." + "title": "Pe Ratio", + "description": "Price-to-earnings ratio (P/E ratio)" }, - "cash_per_share_ttm": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Cash Per Share Ttm", - "description": "Cash per share calculated as trailing twelve months." + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "Period ending date." }, - "book_value_per_share_ttm": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Book Value Per Share Ttm", - "description": "Book value per share calculated as trailing twelve months." + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the data." }, - "tangible_book_value_per_share_ttm": { + "fiscal_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Tangible Book Value Per Share Ttm", - "description": "Tangible book value per share calculated as trailing twelve months." + "title": "Fiscal Year", + "description": "Calendar year for the fiscal period." }, - "shareholders_equity_per_share_ttm": { + "revenue_per_share": { "anyOf": [ { "type": "number" @@ -28812,10 +36430,10 @@ "type": "null" } ], - "title": "Shareholders Equity Per Share Ttm", - "description": "Shareholders equity per share calculated as trailing twelve months." + "title": "Revenue Per Share", + "description": "Revenue per share" }, - "interest_debt_per_share_ttm": { + "capex_per_share": { "anyOf": [ { "type": "number" @@ -28824,10 +36442,10 @@ "type": "null" } ], - "title": "Interest Debt Per Share Ttm", - "description": "Interest debt per share calculated as trailing twelve months." + "title": "Capex Per Share", + "description": "Capital expenditures per share" }, - "market_cap_ttm": { + "net_income_per_share": { "anyOf": [ { "type": "number" @@ -28836,10 +36454,10 @@ "type": "null" } ], - "title": "Market Cap Ttm", - "description": "Market capitalization calculated as trailing twelve months." + "title": "Net Income Per Share", + "description": "Net income per share" }, - "enterprise_value_ttm": { + "operating_cash_flow_per_share": { "anyOf": [ { "type": "number" @@ -28848,10 +36466,10 @@ "type": "null" } ], - "title": "Enterprise Value Ttm", - "description": "Enterprise value calculated as trailing twelve months." + "title": "Operating Cash Flow Per Share", + "description": "Operating cash flow per share" }, - "pe_ratio_ttm": { + "free_cash_flow_per_share": { "anyOf": [ { "type": "number" @@ -28860,10 +36478,10 @@ "type": "null" } ], - "title": "Pe Ratio Ttm", - "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months." + "title": "Free Cash Flow Per Share", + "description": "Free cash flow per share" }, - "price_to_sales_ratio_ttm": { + "cash_per_share": { "anyOf": [ { "type": "number" @@ -28872,10 +36490,10 @@ "type": "null" } ], - "title": "Price To Sales Ratio Ttm", - "description": "Price-to-sales ratio calculated as trailing twelve months." + "title": "Cash Per Share", + "description": "Cash per share" }, - "pocf_ratio_ttm": { + "book_value_per_share": { "anyOf": [ { "type": "number" @@ -28884,10 +36502,10 @@ "type": "null" } ], - "title": "Pocf Ratio Ttm", - "description": "Price-to-operating cash flow ratio calculated as trailing twelve months." + "title": "Book Value Per Share", + "description": "Book value per share" }, - "pfcf_ratio_ttm": { + "tangible_book_value_per_share": { "anyOf": [ { "type": "number" @@ -28896,10 +36514,10 @@ "type": "null" } ], - "title": "Pfcf Ratio Ttm", - "description": "Price-to-free cash flow ratio calculated as trailing twelve months." + "title": "Tangible Book Value Per Share", + "description": "Tangible book value per share" }, - "pb_ratio_ttm": { + "shareholders_equity_per_share": { "anyOf": [ { "type": "number" @@ -28908,10 +36526,10 @@ "type": "null" } ], - "title": "Pb Ratio Ttm", - "description": "Price-to-book ratio calculated as trailing twelve months." + "title": "Shareholders Equity Per Share", + "description": "Shareholders equity per share" }, - "ptb_ratio_ttm": { + "interest_debt_per_share": { "anyOf": [ { "type": "number" @@ -28920,10 +36538,10 @@ "type": "null" } ], - "title": "Ptb Ratio Ttm", - "description": "Price-to-tangible book ratio calculated as trailing twelve months." + "title": "Interest Debt Per Share", + "description": "Interest debt per share" }, - "ev_to_sales_ttm": { + "price_to_sales": { "anyOf": [ { "type": "number" @@ -28932,10 +36550,10 @@ "type": "null" } ], - "title": "Ev To Sales Ttm", - "description": "Enterprise value-to-sales ratio calculated as trailing twelve months." + "title": "Price To Sales", + "description": "Price-to-sales ratio" }, - "enterprise_value_over_ebitda_ttm": { + "price_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -28944,10 +36562,10 @@ "type": "null" } ], - "title": "Enterprise Value Over Ebitda Ttm", - "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months." + "title": "Price To Operating Cash Flow", + "description": "Price-to-operating cash flow ratio" }, - "ev_to_operating_cash_flow_ttm": { + "price_to_free_cash_flow": { "anyOf": [ { "type": "number" @@ -28956,10 +36574,10 @@ "type": "null" } ], - "title": "Ev To Operating Cash Flow Ttm", - "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months." + "title": "Price To Free Cash Flow", + "description": "Price-to-free cash flow ratio" }, - "ev_to_free_cash_flow_ttm": { + "price_to_book": { "anyOf": [ { "type": "number" @@ -28968,10 +36586,10 @@ "type": "null" } ], - "title": "Ev To Free Cash Flow Ttm", - "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months." + "title": "Price To Book", + "description": "Price-to-book ratio" }, - "earnings_yield_ttm": { + "price_to_tangible_book": { "anyOf": [ { "type": "number" @@ -28980,10 +36598,10 @@ "type": "null" } ], - "title": "Earnings Yield Ttm", - "description": "Earnings yield calculated as trailing twelve months." + "title": "Price To Tangible Book", + "description": "Price-to-tangible book ratio" }, - "free_cash_flow_yield_ttm": { + "ev_to_sales": { "anyOf": [ { "type": "number" @@ -28992,10 +36610,10 @@ "type": "null" } ], - "title": "Free Cash Flow Yield Ttm", - "description": "Free cash flow yield calculated as trailing twelve months." + "title": "Ev To Sales", + "description": "Enterprise value-to-sales ratio" }, - "debt_to_equity_ttm": { + "ev_to_ebitda": { "anyOf": [ { "type": "number" @@ -29004,10 +36622,10 @@ "type": "null" } ], - "title": "Debt To Equity Ttm", - "description": "Debt-to-equity ratio calculated as trailing twelve months." + "title": "Ev To Ebitda", + "description": "Enterprise value-to-EBITDA ratio" }, - "debt_to_assets_ttm": { + "ev_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -29016,10 +36634,10 @@ "type": "null" } ], - "title": "Debt To Assets Ttm", - "description": "Debt-to-assets ratio calculated as trailing twelve months." + "title": "Ev To Operating Cash Flow", + "description": "Enterprise value-to-operating cash flow ratio" }, - "net_debt_to_ebitda_ttm": { + "ev_to_free_cash_flow": { "anyOf": [ { "type": "number" @@ -29028,10 +36646,10 @@ "type": "null" } ], - "title": "Net Debt To Ebitda Ttm", - "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months." + "title": "Ev To Free Cash Flow", + "description": "Enterprise value-to-free cash flow ratio" }, - "current_ratio_ttm": { + "earnings_yield": { "anyOf": [ { "type": "number" @@ -29040,10 +36658,12 @@ "type": "null" } ], - "title": "Current Ratio Ttm", - "description": "Current ratio calculated as trailing twelve months." + "title": "Earnings Yield", + "description": "Earnings yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "interest_coverage_ttm": { + "free_cash_flow_yield": { "anyOf": [ { "type": "number" @@ -29052,10 +36672,12 @@ "type": "null" } ], - "title": "Interest Coverage Ttm", - "description": "Interest coverage calculated as trailing twelve months." + "title": "Free Cash Flow Yield", + "description": "Free cash flow yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "income_quality_ttm": { + "debt_to_market_cap": { "anyOf": [ { "type": "number" @@ -29064,10 +36686,10 @@ "type": "null" } ], - "title": "Income Quality Ttm", - "description": "Income quality calculated as trailing twelve months." + "title": "Debt To Market Cap", + "description": "Debt-to-market capitalization ratio" }, - "dividend_yield_ttm": { + "debt_to_equity": { "anyOf": [ { "type": "number" @@ -29076,10 +36698,10 @@ "type": "null" } ], - "title": "Dividend Yield Ttm", - "description": "Dividend yield calculated as trailing twelve months." + "title": "Debt To Equity", + "description": "Debt-to-equity ratio" }, - "dividend_yield_percentage_ttm": { + "debt_to_assets": { "anyOf": [ { "type": "number" @@ -29088,10 +36710,10 @@ "type": "null" } ], - "title": "Dividend Yield Percentage Ttm", - "description": "Dividend yield percentage calculated as trailing twelve months." + "title": "Debt To Assets", + "description": "Debt-to-assets ratio" }, - "dividend_to_market_cap_ttm": { + "net_debt_to_ebitda": { "anyOf": [ { "type": "number" @@ -29100,10 +36722,10 @@ "type": "null" } ], - "title": "Dividend To Market Cap Ttm", - "description": "Dividend to market capitalization ratio calculated as trailing twelve months." + "title": "Net Debt To Ebitda", + "description": "Net debt-to-EBITDA ratio" }, - "dividend_per_share_ttm": { + "current_ratio": { "anyOf": [ { "type": "number" @@ -29112,10 +36734,10 @@ "type": "null" } ], - "title": "Dividend Per Share Ttm", - "description": "Dividend per share calculated as trailing twelve months." + "title": "Current Ratio", + "description": "Current ratio" }, - "payout_ratio_ttm": { + "interest_coverage": { "anyOf": [ { "type": "number" @@ -29124,10 +36746,10 @@ "type": "null" } ], - "title": "Payout Ratio Ttm", - "description": "Payout ratio calculated as trailing twelve months." + "title": "Interest Coverage", + "description": "Interest coverage" }, - "sales_general_and_administrative_to_revenue_ttm": { + "income_quality": { "anyOf": [ { "type": "number" @@ -29136,10 +36758,10 @@ "type": "null" } ], - "title": "Sales General And Administrative To Revenue Ttm", - "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months." + "title": "Income Quality", + "description": "Income quality" }, - "research_and_development_to_revenue_ttm": { + "payout_ratio": { "anyOf": [ { "type": "number" @@ -29148,10 +36770,10 @@ "type": "null" } ], - "title": "Research And Development To Revenue Ttm", - "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months." + "title": "Payout Ratio", + "description": "Payout ratio" }, - "intangibles_to_total_assets_ttm": { + "sales_general_and_administrative_to_revenue": { "anyOf": [ { "type": "number" @@ -29160,10 +36782,10 @@ "type": "null" } ], - "title": "Intangibles To Total Assets Ttm", - "description": "Intangibles-to-total assets ratio calculated as trailing twelve months." + "title": "Sales General And Administrative To Revenue", + "description": "Sales general and administrative expenses-to-revenue ratio" }, - "capex_to_operating_cash_flow_ttm": { + "research_and_development_to_revenue": { "anyOf": [ { "type": "number" @@ -29172,10 +36794,10 @@ "type": "null" } ], - "title": "Capex To Operating Cash Flow Ttm", - "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months." + "title": "Research And Development To Revenue", + "description": "Research and development expenses-to-revenue ratio" }, - "capex_to_revenue_ttm": { + "intangibles_to_total_assets": { "anyOf": [ { "type": "number" @@ -29184,10 +36806,10 @@ "type": "null" } ], - "title": "Capex To Revenue Ttm", - "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months." + "title": "Intangibles To Total Assets", + "description": "Intangibles-to-total assets ratio" }, - "capex_to_depreciation_ttm": { + "capex_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -29196,10 +36818,10 @@ "type": "null" } ], - "title": "Capex To Depreciation Ttm", - "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months." + "title": "Capex To Operating Cash Flow", + "description": "Capital expenditures-to-operating cash flow ratio" }, - "stock_based_compensation_to_revenue_ttm": { + "capex_to_revenue": { "anyOf": [ { "type": "number" @@ -29208,10 +36830,10 @@ "type": "null" } ], - "title": "Stock Based Compensation To Revenue Ttm", - "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months." + "title": "Capex To Revenue", + "description": "Capital expenditures-to-revenue ratio" }, - "graham_number_ttm": { + "capex_to_depreciation": { "anyOf": [ { "type": "number" @@ -29220,10 +36842,10 @@ "type": "null" } ], - "title": "Graham Number Ttm", - "description": "Graham number calculated as trailing twelve months." + "title": "Capex To Depreciation", + "description": "Capital expenditures-to-depreciation ratio" }, - "roic_ttm": { + "stock_based_compensation_to_revenue": { "anyOf": [ { "type": "number" @@ -29232,10 +36854,10 @@ "type": "null" } ], - "title": "Roic Ttm", - "description": "Return on invested capital calculated as trailing twelve months." + "title": "Stock Based Compensation To Revenue", + "description": "Stock-based compensation-to-revenue ratio" }, - "return_on_tangible_assets_ttm": { + "working_capital": { "anyOf": [ { "type": "number" @@ -29244,10 +36866,10 @@ "type": "null" } ], - "title": "Return On Tangible Assets Ttm", - "description": "Return on tangible assets calculated as trailing twelve months." + "title": "Working Capital", + "description": "Working capital" }, - "graham_net_net_ttm": { + "tangible_asset_value": { "anyOf": [ { "type": "number" @@ -29256,10 +36878,10 @@ "type": "null" } ], - "title": "Graham Net Net Ttm", - "description": "Graham net-net working capital calculated as trailing twelve months." + "title": "Tangible Asset Value", + "description": "Tangible asset value" }, - "working_capital_ttm": { + "net_current_asset_value": { "anyOf": [ { "type": "number" @@ -29268,10 +36890,10 @@ "type": "null" } ], - "title": "Working Capital Ttm", - "description": "Working capital calculated as trailing twelve months." + "title": "Net Current Asset Value", + "description": "Net current asset value" }, - "tangible_asset_value_ttm": { + "enterprise_value": { "anyOf": [ { "type": "number" @@ -29280,10 +36902,10 @@ "type": "null" } ], - "title": "Tangible Asset Value Ttm", - "description": "Tangible asset value calculated as trailing twelve months." + "title": "Enterprise Value", + "description": "Enterprise value" }, - "net_current_asset_value_ttm": { + "invested_capital": { "anyOf": [ { "type": "number" @@ -29292,10 +36914,10 @@ "type": "null" } ], - "title": "Net Current Asset Value Ttm", - "description": "Net current asset value calculated as trailing twelve months." + "title": "Invested Capital", + "description": "Invested capital" }, - "invested_capital_ttm": { + "average_receivables": { "anyOf": [ { "type": "number" @@ -29304,10 +36926,10 @@ "type": "null" } ], - "title": "Invested Capital Ttm", - "description": "Invested capital calculated as trailing twelve months." + "title": "Average Receivables", + "description": "Average receivables" }, - "average_receivables_ttm": { + "average_payables": { "anyOf": [ { "type": "number" @@ -29316,10 +36938,10 @@ "type": "null" } ], - "title": "Average Receivables Ttm", - "description": "Average receivables calculated as trailing twelve months." + "title": "Average Payables", + "description": "Average payables" }, - "average_payables_ttm": { + "average_inventory": { "anyOf": [ { "type": "number" @@ -29328,10 +36950,10 @@ "type": "null" } ], - "title": "Average Payables Ttm", - "description": "Average payables calculated as trailing twelve months." + "title": "Average Inventory", + "description": "Average inventory" }, - "average_inventory_ttm": { + "days_sales_outstanding": { "anyOf": [ { "type": "number" @@ -29340,10 +36962,10 @@ "type": "null" } ], - "title": "Average Inventory Ttm", - "description": "Average inventory calculated as trailing twelve months." + "title": "Days Sales Outstanding", + "description": "Days sales outstanding" }, - "days_sales_outstanding_ttm": { + "days_payables_outstanding": { "anyOf": [ { "type": "number" @@ -29352,10 +36974,10 @@ "type": "null" } ], - "title": "Days Sales Outstanding Ttm", - "description": "Days sales outstanding calculated as trailing twelve months." + "title": "Days Payables Outstanding", + "description": "Days payables outstanding" }, - "days_payables_outstanding_ttm": { + "days_of_inventory_on_hand": { "anyOf": [ { "type": "number" @@ -29364,10 +36986,10 @@ "type": "null" } ], - "title": "Days Payables Outstanding Ttm", - "description": "Days payables outstanding calculated as trailing twelve months." + "title": "Days Of Inventory On Hand", + "description": "Days of inventory on hand" }, - "days_of_inventory_on_hand_ttm": { + "receivables_turnover": { "anyOf": [ { "type": "number" @@ -29376,10 +36998,10 @@ "type": "null" } ], - "title": "Days Of Inventory On Hand Ttm", - "description": "Days of inventory on hand calculated as trailing twelve months." + "title": "Receivables Turnover", + "description": "Receivables turnover" }, - "receivables_turnover_ttm": { + "payables_turnover": { "anyOf": [ { "type": "number" @@ -29388,10 +37010,10 @@ "type": "null" } ], - "title": "Receivables Turnover Ttm", - "description": "Receivables turnover calculated as trailing twelve months." + "title": "Payables Turnover", + "description": "Payables turnover" }, - "payables_turnover_ttm": { + "inventory_turnover": { "anyOf": [ { "type": "number" @@ -29400,10 +37022,10 @@ "type": "null" } ], - "title": "Payables Turnover Ttm", - "description": "Payables turnover calculated as trailing twelve months." + "title": "Inventory Turnover", + "description": "Inventory turnover" }, - "inventory_turnover_ttm": { + "return_on_equity": { "anyOf": [ { "type": "number" @@ -29412,10 +37034,12 @@ "type": "null" } ], - "title": "Inventory Turnover Ttm", - "description": "Inventory turnover calculated as trailing twelve months." + "title": "Return On Equity", + "description": "Return on equity", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "roe_ttm": { + "return_on_invested_capital": { "anyOf": [ { "type": "number" @@ -29424,10 +37048,12 @@ "type": "null" } ], - "title": "Roe Ttm", - "description": "Return on equity calculated as trailing twelve months." + "title": "Return On Invested Capital", + "description": "Return on invested capital", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "capex_per_share_ttm": { + "return_on_tangible_assets": { "anyOf": [ { "type": "number" @@ -29436,47 +37062,12 @@ "type": "null" } ], - "title": "Capex Per Share Ttm", - "description": "Capital expenditures per share calculated as trailing twelve months." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPEquityValuationMultiples", - "description": "FMP Equity Valuation Multiples Data." - }, - "FMPEtfCountries": { - "properties": { - "country": { - "type": "string", - "title": "Country", - "description": "The country of the exposure. Corresponding values are normalized percentage points." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "country" - ], - "title": "FMPEtfCountries", - "description": "FMP ETF Countries Data." - }, - "FMPEtfEquityExposure": { - "properties": { - "equity_symbol": { - "type": "string", - "title": "Equity Symbol", - "description": "The symbol of the equity requested." - }, - "etf_symbol": { - "type": "string", - "title": "Etf Symbol", - "description": "The symbol of the ETF with exposure to the requested equity." + "title": "Return On Tangible Assets", + "description": "Return on tangible assets", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "shares": { + "dividend_yield": { "anyOf": [ { "type": "number" @@ -29485,10 +37076,12 @@ "type": "null" } ], - "title": "Shares", - "description": "The number of shares held in the ETF." + "title": "Dividend Yield", + "description": "Dividend yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "weight": { + "graham_number": { "anyOf": [ { "type": "number" @@ -29497,127 +37090,112 @@ "type": "null" } ], - "title": "Weight", - "description": "The weight of the equity in the ETF, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Graham Number", + "description": "Graham number" }, - "market_value": { + "graham_net_net": { "anyOf": [ { "type": "number" }, - { - "type": "integer" - }, { "type": "null" } ], - "title": "Market Value", - "description": "The market value of the equity position in the ETF." + "title": "Graham Net Net", + "description": "Graham net-net working capital" } }, "additionalProperties": true, "type": "object", "required": [ - "equity_symbol", - "etf_symbol" + "period_ending", + "fiscal_period" ], - "title": "FMPEtfEquityExposure", - "description": "FMP ETF Equity Exposure Data." + "title": "FMPKeyMetricsData", + "description": "FMP Key Metrics Data." }, - "FMPEtfHoldings": { + "FMPMarketSnapshotsData": { "properties": { "symbol": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "type": "string", "title": "Symbol", - "description": "Symbol representing the entity requested in the data. (ETF)" + "description": "Symbol representing the entity requested in the data." }, - "name": { + "open": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the ETF holding." + "title": "Open", + "description": "The open price." }, - "lei": { + "high": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Lei", - "description": "The LEI of the holding." + "title": "High", + "description": "The high price." }, - "title": { + "low": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Title", - "description": "The title of the holding." + "title": "Low", + "description": "The low price." }, - "cusip": { + "close": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cusip", - "description": "The CUSIP of the holding." + "title": "Close", + "description": "The close price." }, - "isin": { + "volume": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Isin", - "description": "The ISIN of the holding." + "title": "Volume", + "description": "The trading volume." }, - "balance": { + "prev_close": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Balance", - "description": "The balance of the holding, in shares or units." + "title": "Prev Close", + "description": "The previous close price." }, - "units": { + "change": { "anyOf": [ - { - "type": "string" - }, { "type": "number" }, @@ -29625,22 +37203,24 @@ "type": "null" } ], - "title": "Units", - "description": "The type of units." + "title": "Change", + "description": "The change in price from the previous close." }, - "currency": { + "change_percent": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "The currency of the holding." + "title": "Change Percent", + "description": "The change in price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "value": { + "last_price": { "anyOf": [ { "type": "number" @@ -29649,84 +37229,87 @@ "type": "null" } ], - "title": "Value", - "description": "The value of the holding, in dollars." + "title": "Last Price", + "description": "The last price of the stock." }, - "weight": { + "last_price_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" + }, + { + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Weight", - "description": "The weight of the holding, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Last Price Timestamp", + "description": "The timestamp of the last price." }, - "payoff_profile": { + "priceAvg50": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Payoff Profile", - "description": "The payoff profile of the holding." + "title": "Priceavg50", + "description": "The 50-day moving average." }, - "asset_category": { + "priceAvg200": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Asset Category", - "description": "The asset category of the holding." + "title": "Priceavg200", + "description": "The 200-day moving average." }, - "issuer_category": { + "yearHigh": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Issuer Category", - "description": "The issuer category of the holding." + "title": "Yearhigh", + "description": "The 52-week high." }, - "country": { + "yearLow": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Country", - "description": "The country of the holding." + "title": "Yearlow", + "description": "The 52-week low." }, - "is_restricted": { + "volume_avg": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Is Restricted", - "description": "Whether the holding is restricted." + "title": "Volume Avg", + "description": "Average daily trading volume." }, - "fair_value_level": { + "marketCap": { "anyOf": [ { "type": "integer" @@ -29735,46 +37318,46 @@ "type": "null" } ], - "title": "Fair Value Level", - "description": "The fair value level of the holding." + "title": "Marketcap", + "description": "Market cap of the stock." }, - "is_cash_collateral": { + "eps": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Is Cash Collateral", - "description": "Whether the holding is cash collateral." + "title": "Eps", + "description": "Earnings per share." }, - "is_non_cash_collateral": { + "pe": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Is Non Cash Collateral", - "description": "Whether the holding is non-cash collateral." + "title": "Pe", + "description": "Price to earnings ratio." }, - "is_loan_by_fund": { + "shares_outstanding": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Is Loan By Fund", - "description": "Whether the holding is loan by fund." + "title": "Shares Outstanding", + "description": "Number of shares outstanding." }, - "cik": { + "name": { "anyOf": [ { "type": "string" @@ -29783,10 +37366,10 @@ "type": "null" } ], - "title": "Cik", - "description": "The CIK of the filing." + "title": "Name", + "description": "The company name associated with the symbol." }, - "acceptance_datetime": { + "exchange": { "anyOf": [ { "type": "string" @@ -29795,10 +37378,10 @@ "type": "null" } ], - "title": "Acceptance Datetime", - "description": "The acceptance datetime of the filing." + "title": "Exchange", + "description": "The exchange of the stock." }, - "updated": { + "earningsAnnouncement": { "anyOf": [ { "type": "string", @@ -29812,33 +37395,19 @@ "type": "null" } ], - "title": "Updated", - "description": "The date the data was updated." - } - }, - "additionalProperties": true, - "type": "object", - "title": "FMPEtfHoldings", - "description": "FMP ETF Holdings Data." - }, - "FMPEtfHoldingsDate": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Earningsannouncement", + "description": "The upcoming earnings announcement date." } }, "additionalProperties": true, "type": "object", "required": [ - "date" + "symbol" ], - "title": "FMPEtfHoldingsDate", - "description": "FMP ETF Holdings Data." + "title": "FMPMarketSnapshotsData", + "description": "FMP Market Snapshots Data." }, - "FMPEtfHoldingsPerformance": { + "FMPPricePerformanceData": { "properties": { "symbol": { "type": "string", @@ -30049,241 +37618,41 @@ { "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" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPEtfHoldingsPerformance", - "description": "FMP ETF Holdings Performance Data." - }, - "FMPEtfInfo": { - "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." - }, - "issuer": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Issuer", - "description": "Company of the ETF." - }, - "cusip": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Cusip", - "description": "CUSIP of the ETF." - }, - "isin": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Isin", - "description": "ISIN of the ETF." - }, - "domicile": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Domicile", - "description": "Domicile of the ETF." - }, - "asset_class": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Asset Class", - "description": "Asset class of the ETF." - }, - "aum": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Aum", - "description": "Assets under management." - }, - "nav": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Nav", - "description": "Net asset value of the ETF." - }, - "nav_currency": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Nav Currency", - "description": "Currency of the ETF's net asset value." - }, - "expense_ratio": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Expense Ratio", - "description": "The expense ratio, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "holdings_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Holdings Count", - "description": "Number of holdings." - }, - "avg_volume": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Avg Volume", - "description": "Average daily trading volume." + ], + "title": "Ten Year", + "description": "Ten-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "website": { + "max": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Website", - "description": "Website of the issuer." + "title": "Max", + "description": "Return from the beginning of the time series.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "name", - "inception_date" + "symbol" ], - "title": "FMPEtfInfo", - "description": "FMP ETF Info Data." + "title": "FMPPricePerformanceData", + "description": "FMP Price Performance Data." }, - "FMPEtfSearch": { + "FMPPriceTargetConsensusData": { "properties": { "symbol": { "type": "string", "title": "Symbol", - "description": "Symbol representing the entity requested in the data.(ETF)" + "description": "Symbol representing the entity requested in the data." }, "name": { "anyOf": [ @@ -30295,9 +37664,9 @@ } ], "title": "Name", - "description": "Name of the ETF." + "description": "The company name" }, - "market_cap": { + "target_high": { "anyOf": [ { "type": "number" @@ -30306,34 +37675,34 @@ "type": "null" } ], - "title": "Market Cap", - "description": "The market cap of the ETF." + "title": "Target High", + "description": "High target of the price target consensus." }, - "sector": { + "target_low": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Sector", - "description": "The sector of the ETF." + "title": "Target Low", + "description": "Low target of the price target consensus." }, - "industry": { + "target_consensus": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry", - "description": "The industry of the ETF." + "title": "Target Consensus", + "description": "Consensus target of the price target consensus." }, - "beta": { + "target_median": { "anyOf": [ { "type": "number" @@ -30342,46 +37711,65 @@ "type": "null" } ], - "title": "Beta", - "description": "The beta of the ETF." - }, - "price": { + "title": "Target Median", + "description": "Median target of the price target consensus." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPPriceTargetConsensusData", + "description": "FMP Price Target Consensus Data." + }, + "FMPPriceTargetData": { + "properties": { + "published_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Price", - "description": "The current price of the ETF." + "title": "Published Date", + "description": "Published date of the price target." }, - "last_annual_dividend": { + "published_time": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "time" }, { "type": "null" } ], - "title": "Last Annual Dividend", - "description": "The last annual dividend paid." + "title": "Published Time", + "description": "Time of the original rating, UTC." }, - "volume": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The current trading volume of the ETF." + "title": "Exchange", + "description": "Exchange where the company is traded." }, - "exchange": { + "company_name": { "anyOf": [ { "type": "string" @@ -30390,10 +37778,10 @@ "type": "null" } ], - "title": "Exchange", - "description": "The exchange code the ETF trades on." + "title": "Company Name", + "description": "Name of company that is the subject of rating." }, - "exchange_name": { + "analyst_name": { "anyOf": [ { "type": "string" @@ -30402,10 +37790,10 @@ "type": "null" } ], - "title": "Exchange Name", - "description": "The full name of the exchange the ETF trades on." + "title": "Analyst Name", + "description": "Analyst name." }, - "country": { + "analyst_firm": { "anyOf": [ { "type": "string" @@ -30414,42 +37802,22 @@ "type": "null" } ], - "title": "Country", - "description": "The country the ETF is registered in." + "title": "Analyst Firm", + "description": "Name of the analyst firm that published the price target." }, - "actively_trading": { + "currency": { "anyOf": [ { - "type": "boolean", - "enum": [ - true, - false - ] + "type": "string" }, { "type": "null" } ], - "title": "Actively Trading", - "description": "Whether the ETF is actively trading." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPEtfSearch", - "description": "FMP ETF Search Data." - }, - "FMPEtfSectors": { - "properties": { - "sector": { - "type": "string", - "title": "Sector", - "description": "Sector of exposure." + "title": "Currency", + "description": "Currency the data is denominated in." }, - "weight": { + "price_target": { "anyOf": [ { "type": "number" @@ -30458,75 +37826,58 @@ "type": "null" } ], - "title": "Weight", - "description": "Exposure of the ETF to the sector in normalized percentage points." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "sector", - "weight" - ], - "title": "FMPEtfSectors", - "description": "FMP ETF Sectors Data." - }, - "FMPExecutiveCompensation": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Price Target", + "description": "The current price target." }, - "cik": { + "adj_price_target": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "title": "Adj Price Target", + "description": "Adjusted price target for splits and stock dividends." }, - "company_name": { + "price_target_previous": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Company Name", - "description": "The name of the company." + "title": "Price Target Previous", + "description": "Previous price target." }, - "industry": { + "previous_adj_price_target": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry", - "description": "The industry of the company." + "title": "Previous Adj Price Target", + "description": "Previous adjusted price target." }, - "year": { + "price_when_posted": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Year", - "description": "Year of the compensation." + "title": "Price When Posted", + "description": "Price when posted." }, - "name_and_position": { + "rating_current": { "anyOf": [ { "type": "string" @@ -30535,145 +37886,173 @@ "type": "null" } ], - "title": "Name And Position", - "description": "Name and position." + "title": "Rating Current", + "description": "The analyst's rating for the company." }, - "salary": { + "rating_previous": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "Salary", - "description": "Salary." + "title": "Rating Previous", + "description": "Previous analyst rating for the company." }, - "bonus": { + "action": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "Bonus", - "description": "Bonus payments." + "title": "Action", + "description": "Description of the change in rating from firm's last rating." }, - "stock_award": { + "news_url": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "Stock Award", - "description": "Stock awards." + "title": "News Url", + "description": "News URL of the price target." }, - "incentive_plan_compensation": { + "news_title": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "Incentive Plan Compensation", - "description": "Incentive plan compensation." + "title": "News Title", + "description": "News title of the price target." }, - "all_other_compensation": { + "news_publisher": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "All Other Compensation", - "description": "All other compensation." + "title": "News Publisher", + "description": "News publisher of the price target." }, - "total": { + "news_base_url": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "string" }, { "type": "null" } ], - "title": "Total", - "description": "Total compensation." + "title": "News Base Url", + "description": "News base URL of the price target." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "published_date", + "symbol" + ], + "title": "FMPPriceTargetData", + "description": "FMP Price Target Data." + }, + "FMPRevenueBusinessLineData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end date of the reporting period." }, - "filing_date": { + "fiscal_period": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Filing Date", - "description": "Date of the filing." + "title": "Fiscal Period", + "description": "The fiscal period of the reporting period." }, - "accepted_date": { + "fiscal_year": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "integer" }, { "type": "null" } ], - "title": "Accepted Date", - "description": "Date the filing was accepted." + "title": "Fiscal Year", + "description": "The fiscal year of the reporting period." }, - "url": { + "filing_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Url", - "description": "URL to the filing data." + "title": "Filing Date", + "description": "The filing date of the report." + }, + "business_line": { + "additionalProperties": { + "type": "integer" + }, + "type": "object", + "title": "Business Line", + "description": "Dictionary containing the revenue of the business line." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol" + "period_ending", + "business_line" ], - "title": "FMPExecutiveCompensation", - "description": "FMP Executive Compensation Data." + "title": "FMPRevenueBusinessLineData", + "description": "FMP Revenue by Business Line Data." }, - "FMPFinancialRatios": { + "FMPRevenueGeographicData": { "properties": { "period_ending": { "type": "string", + "format": "date", "title": "Period Ending", - "description": "The date of the data." + "description": "The end date of the reporting period." }, "fiscal_period": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Fiscal Period", - "description": "Period of the financial ratios." + "description": "The fiscal period of the reporting period." }, "fiscal_year": { "anyOf": [ @@ -30685,69 +38064,114 @@ } ], "title": "Fiscal Year", - "description": "Fiscal year." + "description": "The fiscal year of the reporting period." }, - "symbol": { + "filing_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Filing Date", + "description": "The filing date of the report." }, - "current_ratio": { + "geographic_segment": { + "additionalProperties": { + "type": "integer" + }, + "type": "object", + "title": "Geographic Segment", + "description": "Dictionary of the revenue by geographic segment." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "geographic_segment" + ], + "title": "FMPRevenueGeographicData", + "description": "FMP Revenue Geographic Data." + }, + "FMPRiskPremiumData": { + "properties": { + "country": { + "type": "string", + "title": "Country", + "description": "Market country." + }, + "continent": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Ratio", - "description": "Current ratio." + "title": "Continent", + "description": "Continent of the country." }, - "quick_ratio": { + "total_equity_risk_premium": { "anyOf": [ { - "type": "number" + "type": "number", + "exclusiveMinimum": 0.0 }, { "type": "null" } ], - "title": "Quick Ratio", - "description": "Quick ratio." + "title": "Total Equity Risk Premium", + "description": "Total equity risk premium for the country." }, - "cash_ratio": { + "country_risk_premium": { "anyOf": [ { - "type": "number" + "type": "number", + "minimum": 0.0 }, { "type": "null" } ], - "title": "Cash Ratio", - "description": "Cash ratio." + "title": "Country Risk Premium", + "description": "Country-specific risk premium." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "country" + ], + "title": "FMPRiskPremiumData", + "description": "FMP Risk Premium Data." + }, + "FMPShareStatisticsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "days_of_sales_outstanding": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Days Of Sales Outstanding", - "description": "Days of sales outstanding." + "title": "Date", + "description": "The date of the data." }, - "days_of_inventory_outstanding": { + "free_float": { "anyOf": [ { "type": "number" @@ -30756,10 +38180,10 @@ "type": "null" } ], - "title": "Days Of Inventory Outstanding", - "description": "Days of inventory outstanding." + "title": "Free Float", + "description": "Percentage of unrestricted shares of a publicly-traded company." }, - "operating_cycle": { + "float_shares": { "anyOf": [ { "type": "number" @@ -30768,10 +38192,10 @@ "type": "null" } ], - "title": "Operating Cycle", - "description": "Operating cycle." + "title": "Float Shares", + "description": "Number of shares available for trading by the general public." }, - "days_of_payables_outstanding": { + "outstanding_shares": { "anyOf": [ { "type": "number" @@ -30780,190 +38204,229 @@ "type": "null" } ], - "title": "Days Of Payables Outstanding", - "description": "Days of payables outstanding." + "title": "Outstanding Shares", + "description": "Total number of shares of a publicly-traded company." }, - "cash_conversion_cycle": { + "source": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Cash Conversion Cycle", - "description": "Cash conversion cycle." - }, - "gross_profit_margin": { + "title": "Source", + "description": "Source of the received data." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "FMPShareStatisticsData", + "description": "FMP Share Statistics Data." + }, + "FMPTicker": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Gross Profit Margin", - "description": "Gross profit margin." + "title": "Symbol" }, - "operating_profit_margin": { + "ticker": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Operating Profit Margin", - "description": "Operating profit margin." + "title": "Ticker" }, - "pretax_profit_margin": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Pretax Profit Margin", - "description": "Pretax profit margin." + "title": "Name" }, - "net_profit_margin": { + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Profit Margin", - "description": "Net profit margin." + "title": "Exchange" }, - "effective_tax_rate": { + "exchange_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Effective Tax Rate", - "description": "Effective tax rate." + "title": "Exchange Name" }, - "return_on_assets": { + "currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Return On Assets", - "description": "Return on assets." + "title": "Currency" }, - "return_on_equity": { + "market_cap_range": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Return On Equity", - "description": "Return on equity." + "title": "Market Cap Range" }, - "return_on_capital_employed": { + "industry": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Return On Capital Employed", - "description": "Return on capital employed." + "title": "Industry" }, - "net_income_per_ebt": { + "sector": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income Per Ebt", - "description": "Net income per EBT." + "title": "Sector" }, - "ebt_per_ebit": { + "country": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ebt Per Ebit", - "description": "EBT per EBIT." + "title": "Country" }, - "ebit_per_revenue": { + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ebit Per Revenue", - "description": "EBIT per revenue." + "title": "Cik" }, - "debt_ratio": { + "isin": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Debt Ratio", - "description": "Debt ratio." + "title": "Isin" }, - "debt_equity_ratio": { + "cusip": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Debt Equity Ratio", - "description": "Debt equity ratio." + "title": "Cusip" }, - "long_term_debt_to_capitalization": { + "type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Long Term Debt To Capitalization", - "description": "Long term debt to capitalization." + "title": "Type" + } + }, + "type": "object", + "title": "FMPTicker", + "description": "FMP Ticker." + }, + "FMPTickerResponse": { + "properties": { + "total": { + "type": "integer", + "title": "Total" }, - "total_debt_to_capitalization": { + "results": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPTicker" + }, + { + "$ref": "#/components/schemas/FredIndex" + } + ] + }, + "type": "array", + "title": "Results" + } + }, + "type": "object", + "required": [ + "total", + "results" + ], + "title": "FMPTickerResponse", + "description": "FMP Ticker Response." + }, + "FMPTreasuryRatesData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "week_4": { "anyOf": [ { "type": "number" @@ -30972,10 +38435,12 @@ "type": "null" } ], - "title": "Total Debt To Capitalization", - "description": "Total debt to capitalization." + "title": "Week 4", + "description": "4 week Treasury bills rate (secondary market).", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "interest_coverage": { + "month_1": { "anyOf": [ { "type": "number" @@ -30984,10 +38449,12 @@ "type": "null" } ], - "title": "Interest Coverage", - "description": "Interest coverage." + "title": "Month 1", + "description": "1 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "cash_flow_to_debt_ratio": { + "month_2": { "anyOf": [ { "type": "number" @@ -30996,10 +38463,12 @@ "type": "null" } ], - "title": "Cash Flow To Debt Ratio", - "description": "Cash flow to debt ratio." + "title": "Month 2", + "description": "2 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "company_equity_multiplier": { + "month_3": { "anyOf": [ { "type": "number" @@ -31008,10 +38477,12 @@ "type": "null" } ], - "title": "Company Equity Multiplier", - "description": "Company equity multiplier." + "title": "Month 3", + "description": "3 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "receivables_turnover": { + "month_6": { "anyOf": [ { "type": "number" @@ -31020,10 +38491,12 @@ "type": "null" } ], - "title": "Receivables Turnover", - "description": "Receivables turnover." + "title": "Month 6", + "description": "6 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "payables_turnover": { + "year_1": { "anyOf": [ { "type": "number" @@ -31032,10 +38505,12 @@ "type": "null" } ], - "title": "Payables Turnover", - "description": "Payables turnover." + "title": "Year 1", + "description": "1 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "inventory_turnover": { + "year_2": { "anyOf": [ { "type": "number" @@ -31044,10 +38519,12 @@ "type": "null" } ], - "title": "Inventory Turnover", - "description": "Inventory turnover." + "title": "Year 2", + "description": "2 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "fixed_asset_turnover": { + "year_3": { "anyOf": [ { "type": "number" @@ -31056,10 +38533,12 @@ "type": "null" } ], - "title": "Fixed Asset Turnover", - "description": "Fixed asset turnover." + "title": "Year 3", + "description": "3 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "asset_turnover": { + "year_5": { "anyOf": [ { "type": "number" @@ -31068,10 +38547,12 @@ "type": "null" } ], - "title": "Asset Turnover", - "description": "Asset turnover." + "title": "Year 5", + "description": "5 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "operating_cash_flow_per_share": { + "year_7": { "anyOf": [ { "type": "number" @@ -31080,10 +38561,12 @@ "type": "null" } ], - "title": "Operating Cash Flow Per Share", - "description": "Operating cash flow per share." + "title": "Year 7", + "description": "7 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "free_cash_flow_per_share": { + "year_10": { "anyOf": [ { "type": "number" @@ -31092,10 +38575,12 @@ "type": "null" } ], - "title": "Free Cash Flow Per Share", - "description": "Free cash flow per share." + "title": "Year 10", + "description": "10 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "cash_per_share": { + "year_20": { "anyOf": [ { "type": "number" @@ -31104,10 +38589,12 @@ "type": "null" } ], - "title": "Cash Per Share", - "description": "Cash per share." + "title": "Year 20", + "description": "20 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "payout_ratio": { + "year_30": { "anyOf": [ { "type": "number" @@ -31116,58 +38603,137 @@ "type": "null" } ], - "title": "Payout Ratio", - "description": "Payout ratio." + "title": "Year 30", + "description": "30 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FMPTreasuryRatesData", + "description": "FMP Treasury Rates Data." + }, + "FMPWorldNewsData": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data. The published date of the article." }, - "operating_cash_flow_sales_ratio": { + "title": { + "type": "string", + "title": "Title", + "description": "Title of the article." + }, + "images": { "anyOf": [ { - "type": "number" + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" }, { "type": "null" } ], - "title": "Operating Cash Flow Sales Ratio", - "description": "Operating cash flow sales ratio." + "title": "Images", + "description": "Images associated with the article." }, - "free_cash_flow_operating_cash_flow_ratio": { + "text": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Free Cash Flow Operating Cash Flow Ratio", - "description": "Free cash flow operating cash flow ratio." + "title": "Text", + "description": "Text/body of the article." }, - "cash_flow_coverage_ratios": { + "url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Cash Flow Coverage Ratios", - "description": "Cash flow coverage ratios." + "title": "Url", + "description": "URL to the article." }, - "short_term_coverage_ratios": { + "site": { + "type": "string", + "title": "Site", + "description": "News source." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "site" + ], + "title": "FMPWorldNewsData", + "description": "FMP World News Data." + }, + "FMPYieldCurveData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Short Term Coverage Ratios", - "description": "Short term coverage ratios." + "title": "Date", + "description": "The date of the data." }, - "capital_expenditure_coverage_ratio": { + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FMPYieldCurveData", + "description": "FMP Yield Curve Data." + }, + "FREDAMERIBORData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "rate": { "anyOf": [ { "type": "number" @@ -31176,10 +38742,28 @@ "type": "null" } ], - "title": "Capital Expenditure Coverage Ratio", - "description": "Capital expenditure coverage ratio." + "title": "Rate", + "description": "AMERIBOR rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDAMERIBORData", + "description": "FRED AMERIBOR Data." + }, + "FREDCommercialPaperData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "dividend_paid_and_capex_coverage_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31188,10 +38772,45 @@ "type": "null" } ], - "title": "Dividend Paid And Capex Coverage Ratio", - "description": "Dividend paid and capex coverage ratio." + "title": "Rate", + "description": "Commercial Paper Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDCommercialPaperData", + "description": "FRED Commercial Paper Data." + }, + "FREDConsumerPriceIndexData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FREDConsumerPriceIndexData", + "description": "FRED Consumer Price Index Data." + }, + "FREDDiscountWindowPrimaryCreditRateData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "dividend_payout_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31200,10 +38819,28 @@ "type": "null" } ], - "title": "Dividend Payout Ratio", - "description": "Dividend payout ratio." + "title": "Rate", + "description": "Discount Window Primary Credit Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDDiscountWindowPrimaryCreditRateData", + "description": "FRED Discount Window Primary Credit Rate Data." + }, + "FREDESTRData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_book_value_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31212,10 +38849,28 @@ "type": "null" } ], - "title": "Price Book Value Ratio", - "description": "Price book value ratio." + "title": "Rate", + "description": "ESTR rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDESTRData", + "description": "FRED ESTR Data." + }, + "FREDEuropeanCentralBankInterestRatesData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_to_book_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31224,10 +38879,28 @@ "type": "null" } ], - "title": "Price To Book Ratio", - "description": "Price to book ratio." + "title": "Rate", + "description": "European Central Bank Interest Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDEuropeanCentralBankInterestRatesData", + "description": "FRED European Central Bank Interest Rates Data." + }, + "FREDFEDData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_to_sales_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31236,10 +38909,28 @@ "type": "null" } ], - "title": "Price To Sales Ratio", - "description": "Price to sales ratio." + "title": "Rate", + "description": "FED rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDFEDData", + "description": "FRED FED Data." + }, + "FREDHighQualityMarketCorporateBondData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_earnings_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31248,10 +38939,50 @@ "type": "null" } ], - "title": "Price Earnings Ratio", - "description": "Price earnings ratio." + "title": "Rate", + "description": "HighQualityMarketCorporateBond Rate." }, - "price_to_free_cash_flows_ratio": { + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity." + }, + "yield_curve": { + "type": "string", + "enum": [ + "spot", + "par" + ], + "title": "Yield Curve", + "description": "The yield curve type." + }, + "series_id": { + "type": "string", + "title": "Series Id", + "description": "FRED series id." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate", + "maturity", + "yield_curve", + "series_id" + ], + "title": "FREDHighQualityMarketCorporateBondData", + "description": "FRED High Quality Market Corporate Bond Data." + }, + "FREDICEBofAData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "rate": { "anyOf": [ { "type": "number" @@ -31260,10 +38991,28 @@ "type": "null" } ], - "title": "Price To Free Cash Flows Ratio", - "description": "Price to free cash flows ratio." + "title": "Rate", + "description": "ICE BofA US Corporate Bond Indices Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDICEBofAData", + "description": "FRED ICE BofA US Corporate Bond Indices Data." + }, + "FREDIORBData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_to_operating_cash_flows_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31272,10 +39021,28 @@ "type": "null" } ], - "title": "Price To Operating Cash Flows Ratio", - "description": "Price to operating cash flows ratio." + "title": "Rate", + "description": "IORB rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDIORBData", + "description": "FRED IORB Data." + }, + "FREDMoodyCorporateBondIndexData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_cash_flow_ratio": { + "rate": { "anyOf": [ { "type": "number" @@ -31284,10 +39051,28 @@ "type": "null" } ], - "title": "Price Cash Flow Ratio", - "description": "Price cash flow ratio." + "title": "Rate", + "description": "Moody Corporate Bond Index Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDMoodyCorporateBondIndexData", + "description": "FRED Moody Corporate Bond Index Data." + }, + "FREDPROJECTIONData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "price_earnings_to_growth_ratio": { + "range_high": { "anyOf": [ { "type": "number" @@ -31296,10 +39081,10 @@ "type": "null" } ], - "title": "Price Earnings To Growth Ratio", - "description": "Price earnings to growth ratio." + "title": "Range High", + "description": "High projection of rates." }, - "price_sales_ratio": { + "central_tendency_high": { "anyOf": [ { "type": "number" @@ -31308,10 +39093,10 @@ "type": "null" } ], - "title": "Price Sales Ratio", - "description": "Price sales ratio." + "title": "Central Tendency High", + "description": "Central tendency of high projection of rates." }, - "dividend_yield": { + "median": { "anyOf": [ { "type": "number" @@ -31320,10 +39105,10 @@ "type": "null" } ], - "title": "Dividend Yield", - "description": "Dividend yield." + "title": "Median", + "description": "Median projection of rates." }, - "dividend_yield_percentage": { + "range_midpoint": { "anyOf": [ { "type": "number" @@ -31332,10 +39117,10 @@ "type": "null" } ], - "title": "Dividend Yield Percentage", - "description": "Dividend yield percentage." + "title": "Range Midpoint", + "description": "Midpoint projection of rates." }, - "dividend_per_share": { + "central_tendency_midpoint": { "anyOf": [ { "type": "number" @@ -31344,10 +39129,10 @@ "type": "null" } ], - "title": "Dividend Per Share", - "description": "Dividend per share." + "title": "Central Tendency Midpoint", + "description": "Central tendency of midpoint projection of rates." }, - "enterprise_value_multiple": { + "range_low": { "anyOf": [ { "type": "number" @@ -31356,10 +39141,10 @@ "type": "null" } ], - "title": "Enterprise Value Multiple", - "description": "Enterprise value multiple." + "title": "Range Low", + "description": "Low projection of rates." }, - "price_fair_value": { + "central_tendency_low": { "anyOf": [ { "type": "number" @@ -31368,161 +39153,146 @@ "type": "null" } ], - "title": "Price Fair Value", - "description": "Price fair value." + "title": "Central Tendency Low", + "description": "Central tendency of low projection of rates." } }, "additionalProperties": true, "type": "object", "required": [ - "period_ending", - "fiscal_period" + "date", + "range_high", + "central_tendency_high", + "median", + "range_midpoint", + "central_tendency_midpoint", + "range_low", + "central_tendency_low" ], - "title": "FMPFinancialRatios", - "description": "FMP Financial Ratios Data." + "title": "FREDPROJECTIONData", + "description": "FRED PROJECTION Data." }, - "FMPHistoricalDividends": { + "FREDSOFRData": { "properties": { - "ex_dividend_date": { + "date": { "type": "string", "format": "date", - "title": "Ex Dividend Date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." - }, - "amount": { - "type": "number", - "title": "Amount", - "description": "The dividend amount per share." - }, - "label": { - "type": "string", - "title": "Label", - "description": "Label of the historical dividends." - }, - "adj_dividend": { - "type": "number", - "title": "Adj Dividend", - "description": "Adjusted dividend of the historical dividends." + "title": "Date", + "description": "The date of the data." }, - "record_date": { + "rate": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Record Date", - "description": "Record date of the historical dividends." + "title": "Rate", + "description": "SOFR rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDSOFRData", + "description": "FRED SOFR Data." + }, + "FREDSONIAData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "payment_date": { + "rate": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Payment Date", - "description": "Payment date of the historical dividends." + "title": "Rate", + "description": "SONIA rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDSONIAData", + "description": "FRED SONIA Data." + }, + "FREDSelectedTreasuryBillData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "declaration_date": { + "rate": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Declaration Date", - "description": "Declaration date of the historical dividends." + "title": "Rate", + "description": "SelectedTreasuryBill Rate." } }, "additionalProperties": true, "type": "object", "required": [ - "ex_dividend_date", - "amount", - "label", - "adj_dividend" + "date", + "rate" ], - "title": "FMPHistoricalDividends", - "description": "FMP Historical Dividends Data." + "title": "FREDSelectedTreasuryBillData", + "description": "FRED Selected Treasury Bill Data." }, - "FMPHistoricalEmployees": { + "FREDSelectedTreasuryConstantMaturityData": { "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "cik": { - "type": "integer", - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." - }, - "acceptance_time": { - "type": "string", - "format": "date-time", - "title": "Acceptance Time", - "description": "Time of acceptance of the company employee." - }, - "period_of_report": { - "type": "string", - "format": "date", - "title": "Period Of Report", - "description": "Date of reporting of the company employee." - }, - "company_name": { - "type": "string", - "title": "Company Name", - "description": "Registered name of the company to retrieve the historical employees of." - }, - "form_type": { - "type": "string", - "title": "Form Type", - "description": "Form type of the company employee." - }, - "filing_date": { + "date": { "type": "string", "format": "date", - "title": "Filing Date", - "description": "Filing date of the company employee" - }, - "employee_count": { - "type": "integer", - "title": "Employee Count", - "description": "Count of employees of the company." + "title": "Date", + "description": "The date of the data." }, - "source": { - "type": "string", - "title": "Source", - "description": "Source URL which retrieves this data for the company." + "rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Rate", + "description": "Selected Treasury Constant Maturity Rate." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "cik", - "acceptance_time", - "period_of_report", - "company_name", - "form_type", - "filing_date", - "employee_count", - "source" + "date", + "rate" ], - "title": "FMPHistoricalEmployees", - "description": "FMP Historical Employees Data." + "title": "FREDSelectedTreasuryConstantMaturityData", + "description": "FRED Selected Treasury Constant Maturity Data." }, - "FMPHistoricalEps": { + "FREDSpotRateData": { "properties": { "date": { "type": "string", @@ -31530,24 +39300,37 @@ "title": "Date", "description": "The date of the data." }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "announce_time": { + "rate": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Announce Time", - "description": "Timing of the earnings announcement." + "title": "Rate", + "description": "Spot Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDSpotRateData", + "description": "FRED Spot Rate Data." + }, + "FREDTreasuryConstantMaturityData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "eps_actual": { + "rate": { "anyOf": [ { "type": "number" @@ -31556,10 +39339,28 @@ "type": "null" } ], - "title": "Eps Actual", - "description": "Actual EPS from the earnings date." + "title": "Rate", + "description": "TreasuryConstantMaturity Rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FREDTreasuryConstantMaturityData", + "description": "FRED Treasury Constant Maturity Data." + }, + "FederalReserveFEDData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "eps_estimated": { + "rate": { "anyOf": [ { "type": "number" @@ -31568,10 +39369,38 @@ "type": "null" } ], - "title": "Eps Estimated", - "description": "Estimated EPS for the earnings date." + "title": "Rate", + "description": "FED rate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "rate" + ], + "title": "FederalReserveFEDData", + "description": "FederalReserve FED Data." + }, + "FederalReserveMoneyMeasuresData": { + "properties": { + "month": { + "type": "string", + "format": "date", + "title": "Month", + "description": "The date of the data." + }, + "m1": { + "type": "number", + "title": "M1", + "description": "Value of the M1 money supply in billions." + }, + "m2": { + "type": "number", + "title": "M2", + "description": "Value of the M2 money supply in billions." }, - "revenue_estimated": { + "currency": { "anyOf": [ { "type": "number" @@ -31580,10 +39409,10 @@ "type": "null" } ], - "title": "Revenue Estimated", - "description": "Estimated consensus revenue for the reporting period." + "title": "Currency", + "description": "Value of currency in circulation in billions." }, - "revenue_actual": { + "demand_deposits": { "anyOf": [ { "type": "number" @@ -31592,57 +39421,57 @@ "type": "null" } ], - "title": "Revenue Actual", - "description": "The actual reported revenue." + "title": "Demand Deposits", + "description": "Value of demand deposits in billions." }, - "reporting_time": { + "retail_money_market_funds": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Reporting Time", - "description": "The reporting time - e.g. after market close." + "title": "Retail Money Market Funds", + "description": "Value of retail money market funds in billions." }, - "updated_at": { + "other_liquid_deposits": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Updated At", - "description": "The date when the data was last updated." + "title": "Other Liquid Deposits", + "description": "Value of other liquid deposits in billions." }, - "period_ending": { + "small_denomination_time_deposits": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Period Ending", - "description": "The fiscal period end date." + "title": "Small Denomination Time Deposits", + "description": "Value of small denomination time deposits in billions." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol" + "month", + "m1", + "m2" ], - "title": "FMPHistoricalEps", - "description": "FMP Historical EPS Data." + "title": "FederalReserveMoneyMeasuresData", + "description": "FederalReserve Money Measures Data." }, - "FMPHistoricalSplits": { + "FederalReserveTreasuryRatesData": { "properties": { "date": { "type": "string", @@ -31650,7 +39479,7 @@ "title": "Date", "description": "The date of the data." }, - "numerator": { + "week_4": { "anyOf": [ { "type": "number" @@ -31659,10 +39488,12 @@ "type": "null" } ], - "title": "Numerator", - "description": "Numerator of the split." + "title": "Week 4", + "description": "4 week Treasury bills rate (secondary market).", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "denominator": { + "month_1": { "anyOf": [ { "type": "number" @@ -31671,101 +39502,96 @@ "type": "null" } ], - "title": "Denominator", - "description": "Denominator of the split." + "title": "Month 1", + "description": "1 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "split_ratio": { + "month_2": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Split Ratio", - "description": "Split ratio." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FMPHistoricalSplits", - "description": "FMP Historical Splits Data." - }, - "FMPIncomeStatement": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "title": "Month 2", + "description": "2 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "fiscal_period": { + "month_3": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the report." + "title": "Month 3", + "description": "3 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "fiscal_year": { + "month_6": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." + "title": "Month 6", + "description": "6 month Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "filing_date": { + "year_1": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Filing Date", - "description": "The date when the filing was made." + "title": "Year 1", + "description": "1 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "accepted_date": { + "year_2": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Accepted Date", - "description": "The date and time when the filing was accepted." + "title": "Year 2", + "description": "2 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "reported_currency": { + "year_3": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Reported Currency", - "description": "The currency in which the balance sheet was reported." + "title": "Year 3", + "description": "3 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "revenue": { + "year_5": { "anyOf": [ { "type": "number" @@ -31774,10 +39600,12 @@ "type": "null" } ], - "title": "Revenue", - "description": "Total revenue." + "title": "Year 5", + "description": "5 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "cost_of_revenue": { + "year_7": { "anyOf": [ { "type": "number" @@ -31786,10 +39614,12 @@ "type": "null" } ], - "title": "Cost Of Revenue", - "description": "Cost of revenue." + "title": "Year 7", + "description": "7 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "gross_profit": { + "year_10": { "anyOf": [ { "type": "number" @@ -31798,10 +39628,12 @@ "type": "null" } ], - "title": "Gross Profit", - "description": "Gross profit." + "title": "Year 10", + "description": "10 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "gross_profit_margin": { + "year_20": { "anyOf": [ { "type": "number" @@ -31810,10 +39642,12 @@ "type": "null" } ], - "title": "Gross Profit Margin", - "description": "Gross profit margin." + "title": "Year 20", + "description": "20 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "general_and_admin_expense": { + "year_30": { "anyOf": [ { "type": "number" @@ -31822,10 +39656,79 @@ "type": "null" } ], - "title": "General And Admin Expense", - "description": "General and administrative expenses." + "title": "Year 30", + "description": "30 year Treasury rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "FederalReserveTreasuryRatesData", + "description": "FederalReserve Treasury Rates Data." + }, + "FederalReserveYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." }, - "research_and_development_expense": { + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FederalReserveYieldCurveData", + "description": "FederalReserve Yield Curve Data." + }, + "FilterTypes": { + "type": "string", + "enum": [ + "stock", + "etf", + "index", + "indices", + "economic", + "all" + ], + "title": "FilterTypes", + "description": "Filter Types." + }, + "FredBalanceOfPaymentsData": { + "properties": { + "period": { + "type": "string", + "format": "date", + "title": "Period", + "description": "The date representing the beginning of the reporting period." + }, + "balance_percent_of_gdp": { "anyOf": [ { "type": "number" @@ -31834,10 +39737,12 @@ "type": "null" } ], - "title": "Research And Development Expense", - "description": "Research and development expenses." + "title": "Balance Percent Of Gdp", + "description": "Current Account Balance as Percent of GDP", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "selling_and_marketing_expense": { + "balance_total": { "anyOf": [ { "type": "number" @@ -31846,10 +39751,10 @@ "type": "null" } ], - "title": "Selling And Marketing Expense", - "description": "Selling and marketing expenses." + "title": "Balance Total", + "description": "Current Account Total Balance (USD)" }, - "selling_general_and_admin_expense": { + "balance_total_services": { "anyOf": [ { "type": "number" @@ -31858,10 +39763,10 @@ "type": "null" } ], - "title": "Selling General And Admin Expense", - "description": "Selling, general and administrative expenses." + "title": "Balance Total Services", + "description": "Current Account Total Services Balance (USD)" }, - "other_expenses": { + "balance_total_secondary_income": { "anyOf": [ { "type": "number" @@ -31870,10 +39775,10 @@ "type": "null" } ], - "title": "Other Expenses", - "description": "Other expenses." + "title": "Balance Total Secondary Income", + "description": "Current Account Total Secondary Income Balance (USD)" }, - "total_operating_expenses": { + "balance_total_goods": { "anyOf": [ { "type": "number" @@ -31882,10 +39787,10 @@ "type": "null" } ], - "title": "Total Operating Expenses", - "description": "Total operating expenses." + "title": "Balance Total Goods", + "description": "Current Account Total Goods Balance (USD)" }, - "cost_and_expenses": { + "balance_total_primary_income": { "anyOf": [ { "type": "number" @@ -31894,10 +39799,10 @@ "type": "null" } ], - "title": "Cost And Expenses", - "description": "Cost and expenses." + "title": "Balance Total Primary Income", + "description": "Current Account Total Primary Income Balance (USD)" }, - "interest_income": { + "credits_services_percent_of_goods_and_services": { "anyOf": [ { "type": "number" @@ -31906,10 +39811,12 @@ "type": "null" } ], - "title": "Interest Income", - "description": "Interest income." + "title": "Credits Services Percent Of Goods And Services", + "description": "Current Account Credits Services as Percent of Goods and Services", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "total_interest_expense": { + "credits_services_percent_of_current_account": { "anyOf": [ { "type": "number" @@ -31918,10 +39825,12 @@ "type": "null" } ], - "title": "Total Interest Expense", - "description": "Total interest expenses." + "title": "Credits Services Percent Of Current Account", + "description": "Current Account Credits Services as Percent of Current Account", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "depreciation_and_amortization": { + "credits_total_services": { "anyOf": [ { "type": "number" @@ -31930,10 +39839,10 @@ "type": "null" } ], - "title": "Depreciation And Amortization", - "description": "Depreciation and amortization." + "title": "Credits Total Services", + "description": "Current Account Credits Total Services (USD)" }, - "ebitda": { + "credits_total_goods": { "anyOf": [ { "type": "number" @@ -31942,10 +39851,10 @@ "type": "null" } ], - "title": "Ebitda", - "description": "EBITDA." + "title": "Credits Total Goods", + "description": "Current Account Credits Total Goods (USD)" }, - "ebitda_margin": { + "credits_total_primary_income": { "anyOf": [ { "type": "number" @@ -31954,10 +39863,10 @@ "type": "null" } ], - "title": "Ebitda Margin", - "description": "EBITDA margin." + "title": "Credits Total Primary Income", + "description": "Current Account Credits Total Primary Income (USD)" }, - "total_operating_income": { + "credits_total_secondary_income": { "anyOf": [ { "type": "number" @@ -31966,10 +39875,10 @@ "type": "null" } ], - "title": "Total Operating Income", - "description": "Total operating income." + "title": "Credits Total Secondary Income", + "description": "Current Account Credits Total Secondary Income (USD)" }, - "operating_income_margin": { + "credits_total": { "anyOf": [ { "type": "number" @@ -31978,10 +39887,10 @@ "type": "null" } ], - "title": "Operating Income Margin", - "description": "Operating income margin." + "title": "Credits Total", + "description": "Current Account Credits Total (USD)" }, - "total_other_income_expenses": { + "debits_services_percent_of_goods_and_services": { "anyOf": [ { "type": "number" @@ -31990,10 +39899,12 @@ "type": "null" } ], - "title": "Total Other Income Expenses", - "description": "Total other income and expenses." + "title": "Debits Services Percent Of Goods And Services", + "description": "Current Account Debits Services as Percent of Goods and Services", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "total_pre_tax_income": { + "debits_services_percent_of_current_account": { "anyOf": [ { "type": "number" @@ -32002,10 +39913,12 @@ "type": "null" } ], - "title": "Total Pre Tax Income", - "description": "Total pre-tax income." + "title": "Debits Services Percent Of Current Account", + "description": "Current Account Debits Services as Percent of Current Account", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "pre_tax_income_margin": { + "debits_total_services": { "anyOf": [ { "type": "number" @@ -32014,10 +39927,10 @@ "type": "null" } ], - "title": "Pre Tax Income Margin", - "description": "Pre-tax income margin." + "title": "Debits Total Services", + "description": "Current Account Debits Total Services (USD)" }, - "income_tax_expense": { + "debits_total_goods": { "anyOf": [ { "type": "number" @@ -32026,10 +39939,10 @@ "type": "null" } ], - "title": "Income Tax Expense", - "description": "Income tax expense." + "title": "Debits Total Goods", + "description": "Current Account Debits Total Goods (USD)" }, - "consolidated_net_income": { + "debits_total_primary_income": { "anyOf": [ { "type": "number" @@ -32038,10 +39951,10 @@ "type": "null" } ], - "title": "Consolidated Net Income", - "description": "Consolidated net income." + "title": "Debits Total Primary Income", + "description": "Current Account Debits Total Primary Income (USD)" }, - "net_income_margin": { + "debits_total": { "anyOf": [ { "type": "number" @@ -32050,10 +39963,10 @@ "type": "null" } ], - "title": "Net Income Margin", - "description": "Net income margin." + "title": "Debits Total", + "description": "Current Account Debits Total (USD)" }, - "basic_earnings_per_share": { + "debits_total_secondary_income": { "anyOf": [ { "type": "number" @@ -32062,46 +39975,51 @@ "type": "null" } ], - "title": "Basic Earnings Per Share", - "description": "Basic earnings per share." - }, - "diluted_earnings_per_share": { + "title": "Debits Total Secondary Income", + "description": "Current Account Debits Total Secondary Income (USD)" + } + }, + "additionalProperties": true, + "type": "object", + "title": "FredBalanceOfPaymentsData", + "description": "FRED Balance Of Payments Data." + }, + "FredIndex": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Diluted Earnings Per Share", - "description": "Diluted earnings per share." + "title": "Symbol" }, - "weighted_average_basic_shares_outstanding": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Weighted Average Basic Shares Outstanding", - "description": "Weighted average basic shares outstanding." + "title": "Name" }, - "weighted_average_diluted_shares_outstanding": { + "continent": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Weighted Average Diluted Shares Outstanding", - "description": "Weighted average diluted shares outstanding." + "title": "Continent" }, - "link": { + "country": { "anyOf": [ { "type": "string" @@ -32110,10 +40028,9 @@ "type": "null" } ], - "title": "Link", - "description": "Link to the filing." + "title": "Country" }, - "final_link": { + "update_frequency": { "anyOf": [ { "type": "string" @@ -32122,21 +40039,9 @@ "type": "null" } ], - "title": "Final Link", - "description": "Link to the filing document." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending" - ], - "title": "FMPIncomeStatement", - "description": "FMP Income Statement Data." - }, - "FMPIncomeStatementGrowth": { - "properties": { - "symbol": { + "title": "Update Frequency" + }, + "frequency_short": { "anyOf": [ { "type": "string" @@ -32145,194 +40050,9 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "period": { - "type": "string", - "title": "Period", - "description": "Period the statement is returned for." - }, - "growth_revenue": { - "type": "number", - "title": "Growth Revenue", - "description": "Growth rate of total revenue." - }, - "growth_cost_of_revenue": { - "type": "number", - "title": "Growth Cost Of Revenue", - "description": "Growth rate of cost of goods sold." - }, - "growth_gross_profit": { - "type": "number", - "title": "Growth Gross Profit", - "description": "Growth rate of gross profit." - }, - "growth_gross_profit_ratio": { - "type": "number", - "title": "Growth Gross Profit Ratio", - "description": "Growth rate of gross profit as a percentage of revenue." - }, - "growth_research_and_development_expenses": { - "type": "number", - "title": "Growth Research And Development Expenses", - "description": "Growth rate of expenses on research and development." - }, - "growth_general_and_administrative_expenses": { - "type": "number", - "title": "Growth General And Administrative Expenses", - "description": "Growth rate of general and administrative expenses." - }, - "growth_selling_and_marketing_expenses": { - "type": "number", - "title": "Growth Selling And Marketing Expenses", - "description": "Growth rate of expenses on selling and marketing activities." - }, - "growth_other_expenses": { - "type": "number", - "title": "Growth Other Expenses", - "description": "Growth rate of other operating expenses." - }, - "growth_operating_expenses": { - "type": "number", - "title": "Growth Operating Expenses", - "description": "Growth rate of total operating expenses." - }, - "growth_cost_and_expenses": { - "type": "number", - "title": "Growth Cost And Expenses", - "description": "Growth rate of total costs and expenses." - }, - "growth_interest_expense": { - "type": "number", - "title": "Growth Interest Expense", - "description": "Growth rate of interest expenses." - }, - "growth_depreciation_and_amortization": { - "type": "number", - "title": "Growth Depreciation And Amortization", - "description": "Growth rate of depreciation and amortization expenses." - }, - "growth_ebitda": { - "type": "number", - "title": "Growth Ebitda", - "description": "Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization." - }, - "growth_ebitda_ratio": { - "type": "number", - "title": "Growth Ebitda Ratio", - "description": "Growth rate of EBITDA as a percentage of revenue." - }, - "growth_operating_income": { - "type": "number", - "title": "Growth Operating Income", - "description": "Growth rate of operating income." - }, - "growth_operating_income_ratio": { - "type": "number", - "title": "Growth Operating Income Ratio", - "description": "Growth rate of operating income as a percentage of revenue." - }, - "growth_total_other_income_expenses_net": { - "type": "number", - "title": "Growth Total Other Income Expenses Net", - "description": "Growth rate of net total other income and expenses." - }, - "growth_income_before_tax": { - "type": "number", - "title": "Growth Income Before Tax", - "description": "Growth rate of income before taxes." - }, - "growth_income_before_tax_ratio": { - "type": "number", - "title": "Growth Income Before Tax Ratio", - "description": "Growth rate of income before taxes as a percentage of revenue." - }, - "growth_income_tax_expense": { - "type": "number", - "title": "Growth Income Tax Expense", - "description": "Growth rate of income tax expenses." - }, - "growth_net_income": { - "type": "number", - "title": "Growth Net Income", - "description": "Growth rate of net income." - }, - "growth_net_income_ratio": { - "type": "number", - "title": "Growth Net Income Ratio", - "description": "Growth rate of net income as a percentage of revenue." - }, - "growth_eps": { - "type": "number", - "title": "Growth Eps", - "description": "Growth rate of Earnings Per Share (EPS)." - }, - "growth_eps_diluted": { - "type": "number", - "title": "Growth Eps Diluted", - "description": "Growth rate of diluted Earnings Per Share (EPS)." - }, - "growth_weighted_average_shs_out": { - "type": "number", - "title": "Growth Weighted Average Shs Out", - "description": "Growth rate of weighted average shares outstanding." - }, - "growth_weighted_average_shs_out_dil": { - "type": "number", - "title": "Growth Weighted Average Shs Out Dil", - "description": "Growth rate of diluted weighted average shares outstanding." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "period", - "growth_revenue", - "growth_cost_of_revenue", - "growth_gross_profit", - "growth_gross_profit_ratio", - "growth_research_and_development_expenses", - "growth_general_and_administrative_expenses", - "growth_selling_and_marketing_expenses", - "growth_other_expenses", - "growth_operating_expenses", - "growth_cost_and_expenses", - "growth_interest_expense", - "growth_depreciation_and_amortization", - "growth_ebitda", - "growth_ebitda_ratio", - "growth_operating_income", - "growth_operating_income_ratio", - "growth_total_other_income_expenses_net", - "growth_income_before_tax", - "growth_income_before_tax_ratio", - "growth_income_tax_expense", - "growth_net_income", - "growth_net_income_ratio", - "growth_eps", - "growth_eps_diluted", - "growth_weighted_average_shs_out", - "growth_weighted_average_shs_out_dil" - ], - "title": "FMPIncomeStatementGrowth", - "description": "FMP Income Statement Growth Data." - }, - "FMPIndexConstituents": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Frequency Short" }, - "name": { + "observation_start": { "anyOf": [ { "type": "string" @@ -32341,15 +40061,9 @@ "type": "null" } ], - "title": "Name", - "description": "Name of the constituent company in the index." - }, - "sector": { - "type": "string", - "title": "Sector", - "description": "Sector the constituent company in the index belongs to." + "title": "Observation Start" }, - "sub_sector": { + "observation_end": { "anyOf": [ { "type": "string" @@ -32358,10 +40072,9 @@ "type": "null" } ], - "title": "Sub Sector", - "description": "Sub-sector the constituent company in the index belongs to." + "title": "Observation End" }, - "headquarter": { + "units": { "anyOf": [ { "type": "string" @@ -32370,189 +40083,161 @@ "type": "null" } ], - "title": "Headquarter", - "description": "Location of the headquarter of the constituent company in the index." + "title": "Units" }, - "date_first_added": { + "units_short": { "anyOf": [ { "type": "string" }, - { - "type": "string", - "format": "date" - }, { "type": "null" } ], - "title": "Date First Added", - "description": "Date the constituent company was added to the index." + "title": "Units Short" + } + }, + "type": "object", + "title": "FredIndex", + "description": "Fred Index Model." + }, + "FredRegionalData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "cik": { + "region": { + "type": "string", + "title": "Region", + "description": "The name of the region." + }, + "code": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "null" + "type": "integer" } ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "title": "Code", + "description": "The code of the region." }, - "founded": { + "value": { "anyOf": [ { - "type": "string" + "type": "integer" }, { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Founded", - "description": "Founding year of the constituent company in the index." + "title": "Value", + "description": "The observation value. The units are defined in the search results by series ID." + }, + "series_id": { + "type": "string", + "title": "Series Id", + "description": "The individual series ID for the region." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "sector" + "date", + "region", + "code", + "series_id" ], - "title": "FMPIndexConstituents", - "description": "FMP Index Constituents Data." + "title": "FredRegionalData", + "description": "FRED Regional Data." }, - "FMPIndexHistorical": { + "FredSearchData": { "properties": { - "date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" - } - ], - "title": "Date", - "description": "The date of the data." - }, - "open": { + "release_id": { "anyOf": [ { - "type": "number" + "type": "string" }, { - "type": "null" - } - ], - "title": "Open", - "description": "The open price." - }, - "high": { - "anyOf": [ - { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Release Id", + "description": "The release ID for queries." }, - "low": { + "series_id": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Series Id", + "description": "The series ID for the item in the release." }, - "close": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Name", + "description": "The name of the release." }, - "volume": { + "title": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Title", + "description": "The title of the series." }, - "vwap": { + "observation_start": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." + "title": "Observation Start", + "description": "The date of the first observation in the series." }, - "change": { + "observation_end": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Change", - "description": "Change in the price from the previous close." + "title": "Observation End", + "description": "The date of the last observation in the series." }, - "change_percent": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Change Percent", - "description": "Change in the price from the previous close, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FMPIndexHistorical", - "description": "FMP Index Historical Data." - }, - "FMPInsiderTrading": { - "properties": { - "symbol": { + "frequency": { "anyOf": [ { "type": "string" @@ -32561,14 +40246,11 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Frequency", + "description": "The frequency of the data." }, - "company_cik": { + "frequency_short": { "anyOf": [ - { - "type": "integer" - }, { "type": "string" }, @@ -32576,44 +40258,35 @@ "type": "null" } ], - "title": "Company Cik", - "description": "CIK number of the company." + "title": "Frequency Short", + "description": "Short form of the data frequency." }, - "filing_date": { + "units": { "anyOf": [ { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Filing Date", - "description": "Filing date of the trade." + "title": "Units", + "description": "The units of the data." }, - "transaction_date": { + "units_short": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Transaction Date", - "description": "Date of the transaction." + "title": "Units Short", + "description": "Short form of the data units." }, - "owner_cik": { + "seasonal_adjustment": { "anyOf": [ - { - "type": "integer" - }, { "type": "string" }, @@ -32621,10 +40294,10 @@ "type": "null" } ], - "title": "Owner Cik", - "description": "Reporting individual's CIK." + "title": "Seasonal Adjustment", + "description": "The seasonal adjustment of the data." }, - "owner_name": { + "seasonal_adjustment_short": { "anyOf": [ { "type": "string" @@ -32633,22 +40306,23 @@ "type": "null" } ], - "title": "Owner Name", - "description": "Name of the reporting individual." + "title": "Seasonal Adjustment Short", + "description": "Short form of the data seasonal adjustment." }, - "owner_title": { + "last_updated": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Owner Title", - "description": "The title held by the reporting individual." + "title": "Last Updated", + "description": "The datetime of the last update to the data." }, - "transaction_type": { + "notes": { "anyOf": [ { "type": "string" @@ -32657,22 +40331,22 @@ "type": "null" } ], - "title": "Transaction Type", - "description": "Type of transaction being reported." + "title": "Notes", + "description": "Description of the release." }, - "acquisition_or_disposition": { + "press_release": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Acquisition Or Disposition", - "description": "Acquisition or disposition of the shares." + "title": "Press Release", + "description": "If the release is a press release." }, - "security_type": { + "url": { "anyOf": [ { "type": "string" @@ -32681,384 +40355,222 @@ "type": "null" } ], - "title": "Security Type", - "description": "The type of security transacted." + "title": "Url", + "description": "URL to the release." }, - "securities_owned": { + "popularity": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Securities Owned", - "description": "Number of securities owned by the reporting individual." + "title": "Popularity", + "description": "Popularity of the series" }, - "securities_transacted": { + "group_popularity": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Securities Transacted", - "description": "Number of securities transacted by the reporting individual." + "title": "Group Popularity", + "description": "Group popularity of the release" }, - "transaction_price": { + "region_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Transaction Price", - "description": "The price of the transaction." + "title": "Region Type", + "description": "The region type of the series." }, - "filing_url": { + "series_group": { "anyOf": [ { "type": "string" }, + { + "type": "integer" + }, { "type": "null" } ], - "title": "Filing Url", - "description": "Link to the filing." - }, - "form_type": { - "type": "string", - "title": "Form Type", - "description": "Form type of the insider trading." + "title": "Series Group", + "description": "The series group ID of the series. This value is used to query for regional data." } }, "additionalProperties": true, "type": "object", - "required": [ - "form_type" - ], - "title": "FMPInsiderTrading", - "description": "FMP Insider Trading Data." + "title": "FredSearchData", + "description": "FRED Search Data." }, - "FMPInstitutionalOwnership": { + "FredSeriesData": { "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." - }, - "investors_holding": { - "type": "integer", - "title": "Investors Holding", - "description": "Number of investors holding the stock." - }, - "last_investors_holding": { - "type": "integer", - "title": "Last Investors Holding", - "description": "Number of investors holding the stock in the last quarter." - }, - "investors_holding_change": { - "type": "integer", - "title": "Investors Holding Change", - "description": "Change in the number of investors holding the stock." - }, - "number_of_13f_shares": { - "type": "integer", - "title": "Number Of 13F Shares", - "description": "Number of 13F shares." - }, - "last_number_of_13f_shares": { - "type": "integer", - "title": "Last Number Of 13F Shares", - "description": "Number of 13F shares in the last quarter." - }, - "number_of_13f_shares_change": { - "type": "integer", - "title": "Number Of 13F Shares Change", - "description": "Change in the number of 13F shares." - }, - "total_invested": { - "type": "number", - "title": "Total Invested", - "description": "Total amount invested." - }, - "last_total_invested": { - "type": "number", - "title": "Last Total Invested", - "description": "Total amount invested in the last quarter." - }, - "total_invested_change": { - "type": "number", - "title": "Total Invested Change", - "description": "Change in the total amount invested." - }, - "ownership_percent": { - "type": "number", - "title": "Ownership Percent", - "description": "Ownership percent." - }, - "last_ownership_percent": { - "type": "number", - "title": "Last Ownership Percent", - "description": "Ownership percent in the last quarter." - }, - "ownership_percent_change": { - "type": "number", - "title": "Ownership Percent Change", - "description": "Change in the ownership percent." - }, - "new_positions": { - "type": "integer", - "title": "New Positions", - "description": "Number of new positions." - }, - "last_new_positions": { - "type": "integer", - "title": "Last New Positions", - "description": "Number of new positions in the last quarter." - }, - "new_positions_change": { - "type": "integer", - "title": "New Positions Change", - "description": "Change in the number of new positions." - }, - "increased_positions": { - "type": "integer", - "title": "Increased Positions", - "description": "Number of increased positions." - }, - "last_increased_positions": { - "type": "integer", - "title": "Last Increased Positions", - "description": "Number of increased positions in the last quarter." - }, - "increased_positions_change": { - "type": "integer", - "title": "Increased Positions Change", - "description": "Change in the number of increased positions." - }, - "closed_positions": { - "type": "integer", - "title": "Closed Positions", - "description": "Number of closed positions." - }, - "last_closed_positions": { - "type": "integer", - "title": "Last Closed Positions", - "description": "Number of closed positions in the last quarter." - }, - "closed_positions_change": { - "type": "integer", - "title": "Closed Positions Change", - "description": "Change in the number of closed positions." - }, - "reduced_positions": { - "type": "integer", - "title": "Reduced Positions", - "description": "Number of reduced positions." - }, - "last_reduced_positions": { - "type": "integer", - "title": "Last Reduced Positions", - "description": "Number of reduced positions in the last quarter." - }, - "reduced_positions_change": { - "type": "integer", - "title": "Reduced Positions Change", - "description": "Change in the number of reduced positions." - }, - "total_calls": { - "type": "integer", - "title": "Total Calls", - "description": "Total number of call options contracts traded for Apple Inc. on the specified date." - }, - "last_total_calls": { - "type": "integer", - "title": "Last Total Calls", - "description": "Total number of call options contracts traded for Apple Inc. on the previous reporting date." - }, - "total_calls_change": { - "type": "integer", - "title": "Total Calls Change", - "description": "Change in the total number of call options contracts traded between the current and previous reporting dates." - }, - "total_puts": { - "type": "integer", - "title": "Total Puts", - "description": "Total number of put options contracts traded for Apple Inc. on the specified date." - }, - "last_total_puts": { - "type": "integer", - "title": "Last Total Puts", - "description": "Total number of put options contracts traded for Apple Inc. on the previous reporting date." - }, - "total_puts_change": { - "type": "integer", - "title": "Total Puts Change", - "description": "Change in the total number of put options contracts traded between the current and previous reporting dates." - }, - "put_call_ratio": { - "type": "number", - "title": "Put Call Ratio", - "description": "Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date." - }, - "last_put_call_ratio": { - "type": "number", - "title": "Last Put Call Ratio", - "description": "Put-call ratio on the previous reporting date." - }, - "put_call_ratio_change": { - "type": "number", - "title": "Put Call Ratio Change", - "description": "Change in the put-call ratio between the current and previous reporting dates." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "date", - "investors_holding", - "last_investors_holding", - "investors_holding_change", - "total_invested", - "last_total_invested", - "total_invested_change", - "ownership_percent", - "last_ownership_percent", - "ownership_percent_change", - "new_positions", - "last_new_positions", - "new_positions_change", - "increased_positions", - "last_increased_positions", - "increased_positions_change", - "closed_positions", - "last_closed_positions", - "closed_positions_change", - "reduced_positions", - "last_reduced_positions", - "reduced_positions_change", - "total_calls", - "last_total_calls", - "total_calls_change", - "total_puts", - "last_total_puts", - "total_puts_change", - "put_call_ratio", - "last_put_call_ratio", - "put_call_ratio_change" + "date" ], - "title": "FMPInstitutionalOwnership", - "description": "FMP Institutional Ownership Data." + "title": "FredSeriesData", + "description": "FRED Series Data." }, - "FMPKeyExecutives": { + "GroupedComparisons": { "properties": { - "title": { - "type": "string", - "title": "Title", - "description": "Designation of the key executive." - }, - "name": { - "type": "string", - "title": "Name", - "description": "Name of the key executive." + "financial_ratios": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/GroupedRatios" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Financial Ratios", + "description": "Ratios data." }, - "pay": { + "valuation_multiples": { "anyOf": [ { - "type": "integer" + "items": { + "$ref": "#/components/schemas/GroupedMetrics" + }, + "type": "array" }, { "type": "null" } ], - "title": "Pay", - "description": "Pay of the key executive." + "title": "Valuation Multiples", + "description": "Metrics data." }, - "currency_pay": { + "available": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/AvailableComparisonData" }, { "type": "null" } ], - "title": "Currency Pay", - "description": "Currency of the pay." + "description": "Available financial data." }, - "gender": { + "tickers": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/FMPTicker" + }, + "type": "array" }, { "type": "null" } ], - "title": "Gender", - "description": "Gender of the key executive." + "title": "Tickers", + "description": "Ticker objects with information about the stocks in the comparison." + } + }, + "additionalProperties": true, + "type": "object", + "title": "GroupedComparisons", + "description": "Grouped Comparisons Data." + }, + "GroupedFinancials": { + "properties": { + "balance_sheet": { + "anyOf": [ + { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPBalanceSheetData" + }, + { + "$ref": "#/components/schemas/IntrinioBalanceSheetData" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Balance Sheet", + "description": "Balance sheet data." }, - "year_born": { + "cash_flow_statement": { "anyOf": [ { - "type": "integer" + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPCashFlowStatementData" + }, + { + "$ref": "#/components/schemas/IntrinioCashFlowStatementData" + } + ] + }, + "type": "array" }, { "type": "null" } ], - "title": "Year Born", - "description": "Birth year of the key executive." + "title": "Cash Flow Statement", + "description": "Cash flow statement data." }, - "title_since": { + "income_statement": { "anyOf": [ { - "type": "integer" + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPIncomeStatementData" + }, + { + "$ref": "#/components/schemas/IntrinioIncomeStatementData" + } + ] + }, + "type": "array" }, { "type": "null" } ], - "title": "Title Since", - "description": "Date the tile was held since." + "title": "Income Statement", + "description": "Income statement data." } }, "additionalProperties": true, "type": "object", - "required": [ - "title", - "name" - ], - "title": "FMPKeyExecutives", - "description": "FMP Key Executives Data." + "title": "GroupedFinancials", + "description": "Grouped Financials Data." }, - "FMPKeyMetrics": { + "GroupedMetrics": { "properties": { "symbol": { "anyOf": [ @@ -33070,7 +40582,7 @@ } ], "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "description": "Stock symbol." }, "market_cap": { "anyOf": [ @@ -33096,18 +40608,18 @@ "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, - "date": { + "period_ending": { "type": "string", "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Period Ending", + "description": "Period ending date." }, - "period": { + "fiscal_period": { "type": "string", - "title": "Period", + "title": "Fiscal Period", "description": "Period of the data." }, - "calendar_year": { + "fiscal_year": { "anyOf": [ { "type": "integer" @@ -33116,8 +40628,8 @@ "type": "null" } ], - "title": "Calendar Year", - "description": "Calendar year." + "title": "Fiscal Year", + "description": "Calendar year for the fiscal period." }, "revenue_per_share": { "anyOf": [ @@ -33131,6 +40643,18 @@ "title": "Revenue Per Share", "description": "Revenue per share" }, + "capex_per_share": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Capex Per Share", + "description": "Capital expenditures per share" + }, "net_income_per_share": { "anyOf": [ { @@ -33227,19 +40751,7 @@ "title": "Interest Debt Per Share", "description": "Interest debt per share" }, - "enterprise_value": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Enterprise Value", - "description": "Enterprise value" - }, - "price_to_sales_ratio": { + "price_to_sales": { "anyOf": [ { "type": "number" @@ -33248,10 +40760,10 @@ "type": "null" } ], - "title": "Price To Sales Ratio", + "title": "Price To Sales", "description": "Price-to-sales ratio" }, - "pocf_ratio": { + "price_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -33260,10 +40772,10 @@ "type": "null" } ], - "title": "Pocf Ratio", + "title": "Price To Operating Cash Flow", "description": "Price-to-operating cash flow ratio" }, - "pfcf_ratio": { + "price_to_free_cash_flow": { "anyOf": [ { "type": "number" @@ -33272,10 +40784,10 @@ "type": "null" } ], - "title": "Pfcf Ratio", + "title": "Price To Free Cash Flow", "description": "Price-to-free cash flow ratio" }, - "pb_ratio": { + "price_to_book": { "anyOf": [ { "type": "number" @@ -33284,10 +40796,10 @@ "type": "null" } ], - "title": "Pb Ratio", + "title": "Price To Book", "description": "Price-to-book ratio" }, - "ptb_ratio": { + "price_to_tangible_book": { "anyOf": [ { "type": "number" @@ -33296,7 +40808,7 @@ "type": "null" } ], - "title": "Ptb Ratio", + "title": "Price To Tangible Book", "description": "Price-to-tangible book ratio" }, "ev_to_sales": { @@ -33311,7 +40823,7 @@ "title": "Ev To Sales", "description": "Enterprise value-to-sales ratio" }, - "enterprise_value_over_ebitda": { + "ev_to_ebitda": { "anyOf": [ { "type": "number" @@ -33320,7 +40832,7 @@ "type": "null" } ], - "title": "Enterprise Value Over Ebitda", + "title": "Ev To Ebitda", "description": "Enterprise value-to-EBITDA ratio" }, "ev_to_operating_cash_flow": { @@ -33357,7 +40869,9 @@ } ], "title": "Earnings Yield", - "description": "Earnings yield" + "description": "Earnings yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "free_cash_flow_yield": { "anyOf": [ @@ -33369,7 +40883,21 @@ } ], "title": "Free Cash Flow Yield", - "description": "Free cash flow yield" + "description": "Free cash flow yield", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "debt_to_market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Debt To Market Cap", + "description": "Debt-to-market capitalization ratio" }, "debt_to_equity": { "anyOf": [ @@ -33443,20 +40971,6 @@ "title": "Income Quality", "description": "Income quality" }, - "dividend_yield": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Dividend Yield", - "description": "Dividend yield, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, "payout_ratio": { "anyOf": [ { @@ -33502,58 +41016,10 @@ "type": "null" } ], - "title": "Intangibles To Total Assets", - "description": "Intangibles-to-total assets ratio" - }, - "capex_to_operating_cash_flow": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Capex To Operating Cash Flow", - "description": "Capital expenditures-to-operating cash flow ratio" - }, - "capex_to_revenue": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Capex To Revenue", - "description": "Capital expenditures-to-revenue ratio" - }, - "capex_to_depreciation": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Capex To Depreciation", - "description": "Capital expenditures-to-depreciation ratio" - }, - "stock_based_compensation_to_revenue": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Stock Based Compensation To Revenue", - "description": "Stock-based compensation-to-revenue ratio" + "title": "Intangibles To Total Assets", + "description": "Intangibles-to-total assets ratio" }, - "graham_number": { + "capex_to_operating_cash_flow": { "anyOf": [ { "type": "number" @@ -33562,10 +41028,10 @@ "type": "null" } ], - "title": "Graham Number", - "description": "Graham number" + "title": "Capex To Operating Cash Flow", + "description": "Capital expenditures-to-operating cash flow ratio" }, - "roic": { + "capex_to_revenue": { "anyOf": [ { "type": "number" @@ -33574,10 +41040,10 @@ "type": "null" } ], - "title": "Roic", - "description": "Return on invested capital" + "title": "Capex To Revenue", + "description": "Capital expenditures-to-revenue ratio" }, - "return_on_tangible_assets": { + "capex_to_depreciation": { "anyOf": [ { "type": "number" @@ -33586,10 +41052,10 @@ "type": "null" } ], - "title": "Return On Tangible Assets", - "description": "Return on tangible assets" + "title": "Capex To Depreciation", + "description": "Capital expenditures-to-depreciation ratio" }, - "graham_net_net": { + "stock_based_compensation_to_revenue": { "anyOf": [ { "type": "number" @@ -33598,8 +41064,8 @@ "type": "null" } ], - "title": "Graham Net Net", - "description": "Graham net-net working capital" + "title": "Stock Based Compensation To Revenue", + "description": "Stock-based compensation-to-revenue ratio" }, "working_capital": { "anyOf": [ @@ -33637,6 +41103,18 @@ "title": "Net Current Asset Value", "description": "Net current asset value" }, + "enterprise_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Enterprise Value", + "description": "Enterprise value" + }, "invested_capital": { "anyOf": [ { @@ -33757,7 +41235,7 @@ "title": "Inventory Turnover", "description": "Inventory turnover" }, - "roe": { + "return_on_equity": { "anyOf": [ { "type": "number" @@ -33766,10 +41244,12 @@ "type": "null" } ], - "title": "Roe", - "description": "Return on equity" + "title": "Return On Equity", + "description": "Return on equity", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "capex_per_share": { + "return_on_invested_capital": { "anyOf": [ { "type": "number" @@ -33778,27 +41258,12 @@ "type": "null" } ], - "title": "Capex Per Share", - "description": "Capital expenditures per share" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "period" - ], - "title": "FMPKeyMetrics", - "description": "FMP Key Metrics Data." - }, - "FMPMarketSnapshots": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Return On Invested Capital", + "description": "Return on invested capital", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "open": { + "return_on_tangible_assets": { "anyOf": [ { "type": "number" @@ -33807,10 +41272,12 @@ "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Return On Tangible Assets", + "description": "Return on tangible assets", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "high": { + "dividend_yield": { "anyOf": [ { "type": "number" @@ -33819,10 +41286,12 @@ "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Dividend Yield", + "description": "Dividend yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "low": { + "graham_number": { "anyOf": [ { "type": "number" @@ -33831,10 +41300,10 @@ "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Graham Number", + "description": "Graham number" }, - "close": { + "graham_net_net": { "anyOf": [ { "type": "number" @@ -33843,60 +41312,68 @@ "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Graham Net Net", + "description": "Graham net-net working capital" }, - "volume": { + "name": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Name", + "description": "Stock name." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "fiscal_period" + ], + "title": "GroupedMetrics", + "description": "Grouped Metrics Data." + }, + "GroupedRatios": { + "properties": { + "period_ending": { + "type": "string", + "title": "Period Ending", + "description": "The date of the data." }, - "prev_close": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Prev Close", - "description": "The previous close price." + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the financial ratios." }, - "change": { + "fiscal_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Change", - "description": "The change in price from the previous close." + "title": "Fiscal Year", + "description": "Fiscal year." }, - "change_percent": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "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" + "title": "Symbol", + "description": "Stock symbol." }, - "last_price": { + "current_ratio": { "anyOf": [ { "type": "number" @@ -33905,27 +41382,22 @@ "type": "null" } ], - "title": "Last Price", - "description": "The last price of the stock." + "title": "Current Ratio", + "description": "Current ratio." }, - "last_price_timestamp": { + "quick_ratio": { "anyOf": [ { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Last Price Timestamp", - "description": "The timestamp of the last price." + "title": "Quick Ratio", + "description": "Quick ratio." }, - "ma50": { + "cash_ratio": { "anyOf": [ { "type": "number" @@ -33934,10 +41406,10 @@ "type": "null" } ], - "title": "Ma50", - "description": "The 50-day moving average." + "title": "Cash Ratio", + "description": "Cash ratio." }, - "ma200": { + "days_of_sales_outstanding": { "anyOf": [ { "type": "number" @@ -33946,10 +41418,10 @@ "type": "null" } ], - "title": "Ma200", - "description": "The 200-day moving average." + "title": "Days Of Sales Outstanding", + "description": "Days of sales outstanding." }, - "year_high": { + "days_of_inventory_outstanding": { "anyOf": [ { "type": "number" @@ -33958,10 +41430,10 @@ "type": "null" } ], - "title": "Year High", - "description": "The 52-week high." + "title": "Days Of Inventory Outstanding", + "description": "Days of inventory outstanding." }, - "year_low": { + "operating_cycle": { "anyOf": [ { "type": "number" @@ -33970,34 +41442,34 @@ "type": "null" } ], - "title": "Year Low", - "description": "The 52-week low." + "title": "Operating Cycle", + "description": "Operating cycle." }, - "volume_avg": { + "days_of_payables_outstanding": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume Avg", - "description": "Average daily trading volume." + "title": "Days Of Payables Outstanding", + "description": "Days of payables outstanding." }, - "market_cap": { + "cash_conversion_cycle": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Market Cap", - "description": "Market cap of the stock." + "title": "Cash Conversion Cycle", + "description": "Cash conversion cycle." }, - "eps": { + "gross_profit_margin": { "anyOf": [ { "type": "number" @@ -34006,10 +41478,12 @@ "type": "null" } ], - "title": "Eps", - "description": "Earnings per share." + "title": "Gross Profit Margin", + "description": "Gross profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "pe": { + "operating_profit_margin": { "anyOf": [ { "type": "number" @@ -34018,79 +41492,68 @@ "type": "null" } ], - "title": "Pe", - "description": "Price to earnings ratio." + "title": "Operating Profit Margin", + "description": "Operating profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "shares_outstanding": { + "pretax_profit_margin": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Shares Outstanding", - "description": "Number of shares outstanding." + "title": "Pretax Profit Margin", + "description": "Pretax profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "name": { + "net_profit_margin": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "The company name associated with the symbol." + "title": "Net Profit Margin", + "description": "Net profit margin.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "exchange": { + "effective_tax_rate": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange", - "description": "The exchange of the stock." + "title": "Effective Tax Rate", + "description": "Effective tax rate.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "earnings_date": { + "return_on_assets": { "anyOf": [ { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Earnings Date", - "description": "The upcoming earnings announcement date." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPMarketSnapshots", - "description": "FMP Market Snapshots Data." - }, - "FMPPricePerformance": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "The ticker symbol." + "title": "Return On Assets", + "description": "Return on assets.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "one_day": { + "return_on_equity": { "anyOf": [ { "type": "number" @@ -34099,12 +41562,12 @@ "type": "null" } ], - "title": "One Day", - "description": "One-day return.", + "title": "Return On Equity", + "description": "Return on equity.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "wtd": { + "return_on_capital_employed": { "anyOf": [ { "type": "number" @@ -34113,12 +41576,12 @@ "type": "null" } ], - "title": "Wtd", - "description": "Week to date return.", + "title": "Return On Capital Employed", + "description": "Return on capital employed.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, - "one_week": { + "net_income_per_ebt": { "anyOf": [ { "type": "number" @@ -34127,12 +41590,10 @@ "type": "null" } ], - "title": "One Week", - "description": "One-week return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Net Income Per Ebt", + "description": "Net income per EBT." }, - "mtd": { + "ebt_per_ebit": { "anyOf": [ { "type": "number" @@ -34141,12 +41602,10 @@ "type": "null" } ], - "title": "Mtd", - "description": "Month to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Ebt Per Ebit", + "description": "EBT per EBIT." }, - "one_month": { + "ebit_per_revenue": { "anyOf": [ { "type": "number" @@ -34155,12 +41614,10 @@ "type": "null" } ], - "title": "One Month", - "description": "One-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Ebit Per Revenue", + "description": "EBIT per revenue." }, - "qtd": { + "debt_ratio": { "anyOf": [ { "type": "number" @@ -34169,12 +41626,10 @@ "type": "null" } ], - "title": "Qtd", - "description": "Quarter to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Debt Ratio", + "description": "Debt ratio." }, - "three_month": { + "debt_equity_ratio": { "anyOf": [ { "type": "number" @@ -34183,12 +41638,10 @@ "type": "null" } ], - "title": "Three Month", - "description": "Three-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Debt Equity Ratio", + "description": "Debt equity ratio." }, - "six_month": { + "long_term_debt_to_capitalization": { "anyOf": [ { "type": "number" @@ -34197,12 +41650,10 @@ "type": "null" } ], - "title": "Six Month", - "description": "Six-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Long Term Debt To Capitalization", + "description": "Long term debt to capitalization." }, - "ytd": { + "total_debt_to_capitalization": { "anyOf": [ { "type": "number" @@ -34211,12 +41662,10 @@ "type": "null" } ], - "title": "Ytd", - "description": "Year to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Total Debt To Capitalization", + "description": "Total debt to capitalization." }, - "one_year": { + "interest_coverage_ratio": { "anyOf": [ { "type": "number" @@ -34225,12 +41674,10 @@ "type": "null" } ], - "title": "One Year", - "description": "One-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Interest Coverage Ratio", + "description": "Interest coverage." }, - "two_year": { + "cash_flow_to_debt": { "anyOf": [ { "type": "number" @@ -34239,12 +41686,10 @@ "type": "null" } ], - "title": "Two Year", - "description": "Two-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Cash Flow To Debt", + "description": "Cash flow to debt ratio." }, - "three_year": { + "company_equity_multiplier": { "anyOf": [ { "type": "number" @@ -34253,12 +41698,10 @@ "type": "null" } ], - "title": "Three Year", - "description": "Three-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Company Equity Multiplier", + "description": "Company equity multiplier." }, - "four_year": { + "receivables_turnover": { "anyOf": [ { "type": "number" @@ -34267,12 +41710,10 @@ "type": "null" } ], - "title": "Four Year", - "description": "Four-year", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Receivables Turnover", + "description": "Receivables turnover." }, - "five_year": { + "payables_turnover": { "anyOf": [ { "type": "number" @@ -34281,12 +41722,10 @@ "type": "null" } ], - "title": "Five Year", - "description": "Five-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Payables Turnover", + "description": "Payables turnover." }, - "ten_year": { + "inventory_turnover": { "anyOf": [ { "type": "number" @@ -34295,12 +41734,10 @@ "type": "null" } ], - "title": "Ten Year", - "description": "Ten-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Inventory Turnover", + "description": "Inventory turnover." }, - "max": { + "fixed_asset_turnover": { "anyOf": [ { "type": "number" @@ -34309,115 +41746,94 @@ "type": "null" } ], - "title": "Max", - "description": "Return from the beginning of the time series.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPPricePerformance", - "description": "FMP Price Performance Data." - }, - "FMPPriceTarget": { - "properties": { - "published_date": { + "title": "Fixed Asset Turnover", + "description": "Fixed asset turnover." + }, + "asset_turnover": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { - "type": "string", - "format": "date-time" + "type": "null" } ], - "title": "Published Date", - "description": "Published date of the price target." + "title": "Asset Turnover", + "description": "Asset turnover." }, - "published_time": { + "operating_cash_flow_per_share": { "anyOf": [ { - "type": "string", - "format": "time" + "type": "number" }, { "type": "null" } ], - "title": "Published Time", - "description": "Time of the original rating, UTC." - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Operating Cash Flow Per Share", + "description": "Operating cash flow per share." }, - "exchange": { + "free_cash_flow_per_share": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange", - "description": "Exchange where the company is traded." + "title": "Free Cash Flow Per Share", + "description": "Free cash flow per share." }, - "company_name": { + "cash_per_share": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Company Name", - "description": "Name of company that is the subject of rating." + "title": "Cash Per Share", + "description": "Cash per share." }, - "analyst_name": { + "payout_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Analyst Name", - "description": "Analyst name." + "title": "Payout Ratio", + "description": "Payout ratio." }, - "analyst_firm": { + "operating_cash_flow_sales_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Analyst Firm", - "description": "Name of the analyst firm that published the price target." + "title": "Operating Cash Flow Sales Ratio", + "description": "Operating cash flow sales ratio." }, - "currency": { + "free_cash_flow_operating_cash_flow_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "Currency the data is denominated in." + "title": "Free Cash Flow Operating Cash Flow Ratio", + "description": "Free cash flow operating cash flow ratio." }, - "price_target": { + "cash_flow_coverage_ratio": { "anyOf": [ { "type": "number" @@ -34426,10 +41842,10 @@ "type": "null" } ], - "title": "Price Target", - "description": "The current price target." + "title": "Cash Flow Coverage Ratio", + "description": "Cash flow coverage ratio." }, - "adj_price_target": { + "short_term_coverage_ratio": { "anyOf": [ { "type": "number" @@ -34438,10 +41854,10 @@ "type": "null" } ], - "title": "Adj Price Target", - "description": "Adjusted price target for splits and stock dividends." + "title": "Short Term Coverage Ratio", + "description": "Short term coverage ratio." }, - "price_target_previous": { + "capital_expenditure_coverage_ratio": { "anyOf": [ { "type": "number" @@ -34450,10 +41866,10 @@ "type": "null" } ], - "title": "Price Target Previous", - "description": "Previous price target." + "title": "Capital Expenditure Coverage Ratio", + "description": "Capital expenditure coverage ratio." }, - "previous_adj_price_target": { + "price_book_value_ratio": { "anyOf": [ { "type": "number" @@ -34462,10 +41878,10 @@ "type": "null" } ], - "title": "Previous Adj Price Target", - "description": "Previous adjusted price target." + "title": "Price Book Value Ratio", + "description": "Price book value ratio." }, - "price_when_posted": { + "price_to_book_ratio": { "anyOf": [ { "type": "number" @@ -34474,111 +41890,94 @@ "type": "null" } ], - "title": "Price When Posted", - "description": "Price when posted." + "title": "Price To Book Ratio", + "description": "Price to book ratio." }, - "rating_current": { + "price_to_sales_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Rating Current", - "description": "The analyst's rating for the company." + "title": "Price To Sales Ratio", + "description": "Price to sales ratio." }, - "rating_previous": { + "price_earnings_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Rating Previous", - "description": "Previous analyst rating for the company." + "title": "Price Earnings Ratio", + "description": "Price earnings ratio." }, - "action": { + "price_to_free_cash_flows_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Action", - "description": "Description of the change in rating from firm's last rating." + "title": "Price To Free Cash Flows Ratio", + "description": "Price to free cash flows ratio." }, - "news_url": { + "price_to_operating_cash_flows_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "News Url", - "description": "News URL of the price target." + "title": "Price To Operating Cash Flows Ratio", + "description": "Price to operating cash flows ratio." }, - "news_title": { + "price_cash_flow_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "News Title", - "description": "News title of the price target." + "title": "Price Cash Flow Ratio", + "description": "Price cash flow ratio." }, - "news_publisher": { + "price_earnings_to_growth_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "News Publisher", - "description": "News publisher of the price target." + "title": "Price Earnings To Growth Ratio", + "description": "Price earnings to growth ratio." }, - "news_base_url": { + "price_sales_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "News Base Url", - "description": "News base URL of the price target." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "published_date", - "symbol" - ], - "title": "FMPPriceTarget", - "description": "FMP Price Target Data." - }, - "FMPPriceTargetConsensus": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Price Sales Ratio", + "description": "Price sales ratio." }, - "target_high": { + "dividend_paid_and_capex_coverage_ratio": { "anyOf": [ { "type": "number" @@ -34587,10 +41986,10 @@ "type": "null" } ], - "title": "Target High", - "description": "High target of the price target consensus." + "title": "Dividend Paid And Capex Coverage Ratio", + "description": "Dividend paid and capex coverage ratio." }, - "target_low": { + "dividend_payout_ratio": { "anyOf": [ { "type": "number" @@ -34599,10 +41998,10 @@ "type": "null" } ], - "title": "Target Low", - "description": "Low target of the price target consensus." + "title": "Dividend Payout Ratio", + "description": "Dividend payout ratio." }, - "target_consensus": { + "dividend_yield": { "anyOf": [ { "type": "number" @@ -34611,10 +42010,12 @@ "type": "null" } ], - "title": "Target Consensus", - "description": "Consensus target of the price target consensus." + "title": "Dividend Yield", + "description": "Dividend yield.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "target_median": { + "dividend_per_share": { "anyOf": [ { "type": "number" @@ -34623,82 +42024,81 @@ "type": "null" } ], - "title": "Target Median", - "description": "Median target of the price target consensus." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPPriceTargetConsensus", - "description": "FMP Price Target Consensus Data." - }, - "FMPRevenueBusinessLine": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "title": "Dividend Per Share", + "description": "Dividend per share." }, - "fiscal_period": { + "enterprise_value_multiple": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the reporting period." + "title": "Enterprise Value Multiple", + "description": "Enterprise value multiple." }, - "fiscal_year": { + "price_fair_value": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the reporting period." + "title": "Price Fair Value", + "description": "Price fair value." }, - "filing_date": { + "name": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Filing Date", - "description": "The filing date of the report." - }, - "business_line": { - "additionalProperties": { - "type": "integer" - }, - "type": "object", - "title": "Business Line", - "description": "Dictionary containing the revenue of the business line." + "title": "Name", + "description": "Stock name." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", - "business_line" + "fiscal_period" ], - "title": "FMPRevenueBusinessLine", - "description": "FMP Revenue by Business Line Data." + "title": "GroupedRatios", + "description": "Grouped Ratios Data." + }, + "HTTPValidationError": { + "properties": { + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" + } + }, + "type": "object", + "title": "HTTPValidationError" + }, + "IgnoreTypes": { + "type": "string", + "enum": [ + "stock", + "etf", + "index", + "indices", + "economic" + ], + "title": "IgnoreTypes", + "description": "Ignore Types." }, - "FMPRevenueGeographic": { + "IntrinioBalanceSheetData": { "properties": { "period_ending": { "type": "string", @@ -34716,7 +42116,7 @@ } ], "title": "Fiscal Period", - "description": "The fiscal period of the reporting period." + "description": "The fiscal period of the report." }, "fiscal_year": { "anyOf": [ @@ -34728,47 +42128,9 @@ } ], "title": "Fiscal Year", - "description": "The fiscal year of the reporting period." - }, - "filing_date": { - "anyOf": [ - { - "type": "string", - "format": "date" - }, - { - "type": "null" - } - ], - "title": "Filing Date", - "description": "The filing date of the report." - }, - "geographic_segment": { - "additionalProperties": { - "type": "integer" - }, - "type": "object", - "title": "Geographic Segment", - "description": "Dictionary of the revenue by geographic segment." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending", - "geographic_segment" - ], - "title": "FMPRevenueGeographic", - "description": "FMP Revenue Geographic Data." - }, - "FMPRiskPremium": { - "properties": { - "country": { - "type": "string", - "title": "Country", - "description": "Market country." + "description": "The fiscal year of the fiscal period." }, - "continent": { + "reported_currency": { "anyOf": [ { "type": "string" @@ -34777,65 +42139,46 @@ "type": "null" } ], - "title": "Continent", - "description": "Continent of the country." + "title": "Reported Currency", + "description": "The currency in which the balance sheet is reported." }, - "total_equity_risk_premium": { + "cash_and_cash_equivalents": { "anyOf": [ { - "type": "number", - "exclusiveMinimum": 0.0 + "type": "number" }, { "type": "null" } ], - "title": "Total Equity Risk Premium", - "description": "Total equity risk premium for the country." + "title": "Cash And Cash Equivalents", + "description": "Cash and cash equivalents." }, - "country_risk_premium": { + "cash_and_due_from_banks": { "anyOf": [ { - "type": "number", - "minimum": 0.0 + "type": "number" }, { "type": "null" } ], - "title": "Country Risk Premium", - "description": "Country-specific risk premium." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "country" - ], - "title": "FMPRiskPremium", - "description": "FMP Risk Premium Data." - }, - "FMPShareStatistics": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Cash And Due From Banks", + "description": "Cash and due from banks." }, - "date": { + "restricted_cash": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Date", - "description": "The date of the data." + "title": "Restricted Cash", + "description": "Restricted cash." }, - "free_float": { + "short_term_investments": { "anyOf": [ { "type": "number" @@ -34844,10 +42187,10 @@ "type": "null" } ], - "title": "Free Float", - "description": "Percentage of unrestricted shares of a publicly-traded company." + "title": "Short Term Investments", + "description": "Short term investments." }, - "float_shares": { + "federal_funds_sold": { "anyOf": [ { "type": "number" @@ -34856,10 +42199,10 @@ "type": "null" } ], - "title": "Float Shares", - "description": "Number of shares available for trading by the general public." + "title": "Federal Funds Sold", + "description": "Federal funds sold." }, - "outstanding_shares": { + "accounts_receivable": { "anyOf": [ { "type": "number" @@ -34868,196 +42211,154 @@ "type": "null" } ], - "title": "Outstanding Shares", - "description": "Total number of shares of a publicly-traded company." + "title": "Accounts Receivable", + "description": "Accounts receivable." }, - "source": { + "note_and_lease_receivable": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Source", - "description": "Source of the received data." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "FMPShareStatistics", - "description": "FMP Share Statistics Data." - }, - "FMPTicker": { - "properties": { - "symbol": { + "title": "Note And Lease Receivable", + "description": "Note and lease receivable. (Vendor non-trade receivables)" + }, + "inventories": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol" + "title": "Inventories", + "description": "Net Inventories." }, - "name": { + "customer_and_other_receivables": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name" + "title": "Customer And Other Receivables", + "description": "Customer and other receivables." }, - "exchange": { + "interest_bearing_deposits_at_other_banks": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange" + "title": "Interest Bearing Deposits At Other Banks", + "description": "Interest bearing deposits at other banks." }, - "currency": { + "time_deposits_placed_and_other_short_term_investments": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency" + "title": "Time Deposits Placed And Other Short Term Investments", + "description": "Time deposits placed and other short term investments." }, - "industry": { + "trading_account_securities": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Industry" + "title": "Trading Account Securities", + "description": "Trading account securities." }, - "sector": { + "loans_and_leases": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Sector" + "title": "Loans And Leases", + "description": "Loans and leases." }, - "country": { + "allowance_for_loan_and_lease_losses": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Country" + "title": "Allowance For Loan And Lease Losses", + "description": "Allowance for loan and lease losses." }, - "cik": { + "current_deferred_refundable_income_taxes": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cik" + "title": "Current Deferred Refundable Income Taxes", + "description": "Current deferred refundable income taxes." }, - "isin": { + "other_current_assets": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Isin" + "title": "Other Current Assets", + "description": "Other current assets." }, - "cusip": { + "loans_and_leases_net_of_allowance": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Cusip" + "title": "Loans And Leases Net Of Allowance", + "description": "Loans and leases net of allowance." }, - "type": { + "accrued_investment_income": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Type" - } - }, - "type": "object", - "title": "FMPTicker", - "description": "FMP Ticker." - }, - "FMPTickerResponse": { - "properties": { - "total": { - "type": "integer", - "title": "Total" - }, - "results": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/FMPTicker" - }, - { - "$ref": "#/components/schemas/FredIndex" - } - ] - }, - "type": "array", - "title": "Results" - } - }, - "type": "object", - "required": [ - "total", - "results" - ], - "title": "FMPTickerResponse", - "description": "FMP Ticker Response." - }, - "FMPTreasuryRates": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Accrued Investment Income", + "description": "Accrued investment income." }, - "week_4": { + "other_current_non_operating_assets": { "anyOf": [ { "type": "number" @@ -35066,12 +42367,10 @@ "type": "null" } ], - "title": "Week 4", - "description": "4 week Treasury bills rate (secondary market).", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Current Non Operating Assets", + "description": "Other current non-operating assets." }, - "month_1": { + "loans_held_for_sale": { "anyOf": [ { "type": "number" @@ -35080,12 +42379,10 @@ "type": "null" } ], - "title": "Month 1", - "description": "1 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Loans Held For Sale", + "description": "Loans held for sale." }, - "month_2": { + "prepaid_expenses": { "anyOf": [ { "type": "number" @@ -35094,12 +42391,10 @@ "type": "null" } ], - "title": "Month 2", - "description": "2 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Prepaid Expenses", + "description": "Prepaid expenses." }, - "month_3": { + "total_current_assets": { "anyOf": [ { "type": "number" @@ -35108,12 +42403,10 @@ "type": "null" } ], - "title": "Month 3", - "description": "3 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Total Current Assets", + "description": "Total current assets." }, - "month_6": { + "plant_property_equipment_gross": { "anyOf": [ { "type": "number" @@ -35122,12 +42415,10 @@ "type": "null" } ], - "title": "Month 6", - "description": "6 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Plant Property Equipment Gross", + "description": "Plant property equipment gross." }, - "year_1": { + "accumulated_depreciation": { "anyOf": [ { "type": "number" @@ -35136,12 +42427,10 @@ "type": "null" } ], - "title": "Year 1", - "description": "1 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Accumulated Depreciation", + "description": "Accumulated depreciation." }, - "year_2": { + "premises_and_equipment_net": { "anyOf": [ { "type": "number" @@ -35150,12 +42439,10 @@ "type": "null" } ], - "title": "Year 2", - "description": "2 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Premises And Equipment Net", + "description": "Net premises and equipment." }, - "year_3": { + "plant_property_equipment_net": { "anyOf": [ { "type": "number" @@ -35164,12 +42451,10 @@ "type": "null" } ], - "title": "Year 3", - "description": "3 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Plant Property Equipment Net", + "description": "Net plant property equipment." }, - "year_5": { + "long_term_investments": { "anyOf": [ { "type": "number" @@ -35178,12 +42463,10 @@ "type": "null" } ], - "title": "Year 5", - "description": "5 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Long Term Investments", + "description": "Long term investments." }, - "year_7": { + "mortgage_servicing_rights": { "anyOf": [ { "type": "number" @@ -35192,12 +42475,10 @@ "type": "null" } ], - "title": "Year 7", - "description": "7 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Mortgage Servicing Rights", + "description": "Mortgage servicing rights." }, - "year_10": { + "unearned_premiums_asset": { "anyOf": [ { "type": "number" @@ -35206,12 +42487,10 @@ "type": "null" } ], - "title": "Year 10", - "description": "10 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Unearned Premiums Asset", + "description": "Unearned premiums asset." }, - "year_20": { + "non_current_note_lease_receivables": { "anyOf": [ { "type": "number" @@ -35220,12 +42499,10 @@ "type": "null" } ], - "title": "Year 20", - "description": "20 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Non Current Note Lease Receivables", + "description": "Non-current note lease receivables." }, - "year_30": { + "deferred_acquisition_cost": { "anyOf": [ { "type": "number" @@ -35234,100 +42511,46 @@ "type": "null" } ], - "title": "Year 30", - "description": "30 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FMPTreasuryRates", - "description": "FMP Treasury Rates Data." - }, - "FMPWorldNews": { - "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." + "title": "Deferred Acquisition Cost", + "description": "Deferred acquisition cost." }, - "images": { + "goodwill": { "anyOf": [ { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" + "type": "number" }, { "type": "null" } ], - "title": "Images", - "description": "Images associated with the article." + "title": "Goodwill", + "description": "Goodwill." }, - "text": { + "separate_account_business_assets": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Separate Account Business Assets", + "description": "Separate account business assets." }, - "url": { + "non_current_deferred_refundable_income_taxes": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Url", - "description": "URL to the article." - }, - "site": { - "type": "string", - "title": "Site", - "description": "News source." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "title", - "site" - ], - "title": "FMPWorldNews", - "description": "FMP World News Data." - }, - "FREDAMERIBOR": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Non Current Deferred Refundable Income Taxes", + "description": "Noncurrent deferred refundable income taxes." }, - "rate": { + "intangible_assets": { "anyOf": [ { "type": "number" @@ -35336,28 +42559,10 @@ "type": "null" } ], - "title": "Rate", - "description": "AMERIBOR rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDAMERIBOR", - "description": "FRED AMERIBOR Data." - }, - "FREDCommercialPaper": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Intangible Assets", + "description": "Intangible assets." }, - "rate": { + "employee_benefit_assets": { "anyOf": [ { "type": "number" @@ -35366,45 +42571,10 @@ "type": "null" } ], - "title": "Rate", - "description": "Commercial Paper Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDCommercialPaper", - "description": "FRED Commercial Paper Data." - }, - "FREDConsumerPriceIndex": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FREDConsumerPriceIndex", - "description": "FRED Consumer Price Index Data." - }, - "FREDDiscountWindowPrimaryCreditRate": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Employee Benefit Assets", + "description": "Employee benefit assets." }, - "rate": { + "other_assets": { "anyOf": [ { "type": "number" @@ -35413,28 +42583,10 @@ "type": "null" } ], - "title": "Rate", - "description": "Discount Window Primary Credit Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDDiscountWindowPrimaryCreditRate", - "description": "FRED Discount Window Primary Credit Rate Data." - }, - "FREDESTR": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Other Assets", + "description": "Other assets." }, - "rate": { + "other_non_current_operating_assets": { "anyOf": [ { "type": "number" @@ -35443,28 +42595,10 @@ "type": "null" } ], - "title": "Rate", - "description": "ESTR rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDESTR", - "description": "FRED ESTR Data." - }, - "FREDEuropeanCentralBankInterestRates": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Other Non Current Operating Assets", + "description": "Other noncurrent operating assets." }, - "rate": { + "other_non_current_non_operating_assets": { "anyOf": [ { "type": "number" @@ -35473,28 +42607,10 @@ "type": "null" } ], - "title": "Rate", - "description": "European Central Bank Interest Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDEuropeanCentralBankInterestRates", - "description": "FRED European Central Bank Interest Rates Data." - }, - "FREDFED": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Other Non Current Non Operating Assets", + "description": "Other noncurrent non-operating assets." }, - "rate": { + "interest_bearing_deposits": { "anyOf": [ { "type": "number" @@ -35503,28 +42619,10 @@ "type": "null" } ], - "title": "Rate", - "description": "FED rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDFED", - "description": "FRED FED Data." - }, - "FREDHighQualityMarketCorporateBond": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Interest Bearing Deposits", + "description": "Interest bearing deposits." }, - "rate": { + "total_non_current_assets": { "anyOf": [ { "type": "number" @@ -35533,50 +42631,10 @@ "type": "null" } ], - "title": "Rate", - "description": "HighQualityMarketCorporateBond Rate." - }, - "maturity": { - "type": "string", - "title": "Maturity", - "description": "Maturity." - }, - "yield_curve": { - "type": "string", - "enum": [ - "spot", - "par" - ], - "title": "Yield Curve", - "description": "The yield curve type." - }, - "series_id": { - "type": "string", - "title": "Series Id", - "description": "FRED series id." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate", - "maturity", - "yield_curve", - "series_id" - ], - "title": "FREDHighQualityMarketCorporateBond", - "description": "FRED High Quality Market Corporate Bond Data." - }, - "FREDICEBofA": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Total Non Current Assets", + "description": "Total noncurrent assets." }, - "rate": { + "total_assets": { "anyOf": [ { "type": "number" @@ -35585,28 +42643,10 @@ "type": "null" } ], - "title": "Rate", - "description": "ICE BofA US Corporate Bond Indices Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDICEBofA", - "description": "FRED ICE BofA US Corporate Bond Indices Data." - }, - "FREDIORB": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Total Assets", + "description": "Total assets." }, - "rate": { + "non_interest_bearing_deposits": { "anyOf": [ { "type": "number" @@ -35615,28 +42655,10 @@ "type": "null" } ], - "title": "Rate", - "description": "IORB rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDIORB", - "description": "FRED IORB Data." - }, - "FREDMoodyCorporateBondIndex": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Non Interest Bearing Deposits", + "description": "Non interest bearing deposits." }, - "rate": { + "federal_funds_purchased_and_securities_sold": { "anyOf": [ { "type": "number" @@ -35645,28 +42667,10 @@ "type": "null" } ], - "title": "Rate", - "description": "Moody Corporate Bond Index Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDMoodyCorporateBondIndex", - "description": "FRED Moody Corporate Bond Index Data." - }, - "FREDPROJECTION": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Federal Funds Purchased And Securities Sold", + "description": "Federal funds purchased and securities sold." }, - "range_high": { + "bankers_acceptance_outstanding": { "anyOf": [ { "type": "number" @@ -35675,10 +42679,10 @@ "type": "null" } ], - "title": "Range High", - "description": "High projection of rates." + "title": "Bankers Acceptance Outstanding", + "description": "Bankers acceptance outstanding." }, - "central_tendency_high": { + "short_term_debt": { "anyOf": [ { "type": "number" @@ -35687,10 +42691,10 @@ "type": "null" } ], - "title": "Central Tendency High", - "description": "Central tendency of high projection of rates." + "title": "Short Term Debt", + "description": "Short term debt." }, - "median": { + "accounts_payable": { "anyOf": [ { "type": "number" @@ -35699,10 +42703,10 @@ "type": "null" } ], - "title": "Median", - "description": "Median projection of rates." + "title": "Accounts Payable", + "description": "Accounts payable." }, - "range_midpoint": { + "current_deferred_revenue": { "anyOf": [ { "type": "number" @@ -35711,10 +42715,10 @@ "type": "null" } ], - "title": "Range Midpoint", - "description": "Midpoint projection of rates." + "title": "Current Deferred Revenue", + "description": "Current deferred revenue." }, - "central_tendency_midpoint": { + "current_deferred_payable_income_tax_liabilities": { "anyOf": [ { "type": "number" @@ -35723,10 +42727,10 @@ "type": "null" } ], - "title": "Central Tendency Midpoint", - "description": "Central tendency of midpoint projection of rates." + "title": "Current Deferred Payable Income Tax Liabilities", + "description": "Current deferred payable income tax liabilities." }, - "range_low": { + "accrued_interest_payable": { "anyOf": [ { "type": "number" @@ -35735,10 +42739,10 @@ "type": "null" } ], - "title": "Range Low", - "description": "Low projection of rates." + "title": "Accrued Interest Payable", + "description": "Accrued interest payable." }, - "central_tendency_low": { + "accrued_expenses": { "anyOf": [ { "type": "number" @@ -35747,34 +42751,10 @@ "type": "null" } ], - "title": "Central Tendency Low", - "description": "Central tendency of low projection of rates." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "range_high", - "central_tendency_high", - "median", - "range_midpoint", - "central_tendency_midpoint", - "range_low", - "central_tendency_low" - ], - "title": "FREDPROJECTION", - "description": "FRED PROJECTION Data." - }, - "FREDSOFR": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Accrued Expenses", + "description": "Accrued expenses." }, - "rate": { + "other_short_term_payables": { "anyOf": [ { "type": "number" @@ -35783,28 +42763,10 @@ "type": "null" } ], - "title": "Rate", - "description": "SOFR rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDSOFR", - "description": "FRED SOFR Data." - }, - "FREDSONIA": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Other Short Term Payables", + "description": "Other short term payables." }, - "rate": { + "customer_deposits": { "anyOf": [ { "type": "number" @@ -35813,28 +42775,10 @@ "type": "null" } ], - "title": "Rate", - "description": "SONIA rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDSONIA", - "description": "FRED SONIA Data." - }, - "FREDSelectedTreasuryBill": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Customer Deposits", + "description": "Customer deposits." }, - "rate": { + "dividends_payable": { "anyOf": [ { "type": "number" @@ -35843,28 +42787,10 @@ "type": "null" } ], - "title": "Rate", - "description": "SelectedTreasuryBill Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDSelectedTreasuryBill", - "description": "FRED Selected Treasury Bill Data." - }, - "FREDSelectedTreasuryConstantMaturity": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Dividends Payable", + "description": "Dividends payable." }, - "rate": { + "claims_and_claim_expense": { "anyOf": [ { "type": "number" @@ -35873,28 +42799,10 @@ "type": "null" } ], - "title": "Rate", - "description": "Selected Treasury Constant Maturity Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDSelectedTreasuryConstantMaturity", - "description": "FRED Selected Treasury Constant Maturity Data." - }, - "FREDSpotRate": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Claims And Claim Expense", + "description": "Claims and claim expense." }, - "rate": { + "future_policy_benefits": { "anyOf": [ { "type": "number" @@ -35903,28 +42811,10 @@ "type": "null" } ], - "title": "Rate", - "description": "Spot Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDSpotRate", - "description": "FRED Spot Rate Data." - }, - "FREDTreasuryConstantMaturity": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Future Policy Benefits", + "description": "Future policy benefits." }, - "rate": { + "current_employee_benefit_liabilities": { "anyOf": [ { "type": "number" @@ -35933,50 +42823,10 @@ "type": "null" } ], - "title": "Rate", - "description": "TreasuryConstantMaturity Rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FREDTreasuryConstantMaturity", - "description": "FRED Treasury Constant Maturity Data." - }, - "FREDYieldCurve": { - "properties": { - "maturity": { - "type": "number", - "title": "Maturity", - "description": "Maturity of the treasury rate in years." - }, - "rate": { - "type": "number", - "title": "Rate", - "description": "Associated rate given in decimal form (0.05 is 5%)" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "maturity", - "rate" - ], - "title": "FREDYieldCurve", - "description": "FRED US Yield Curve Data." - }, - "FederalReserveFED": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Current Employee Benefit Liabilities", + "description": "Current employee benefit liabilities." }, - "rate": { + "unearned_premiums_liability": { "anyOf": [ { "type": "number" @@ -35985,38 +42835,10 @@ "type": "null" } ], - "title": "Rate", - "description": "FED rate." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "rate" - ], - "title": "FederalReserveFED", - "description": "FederalReserve FED Data." - }, - "FederalReserveMoneyMeasures": { - "properties": { - "month": { - "type": "string", - "format": "date", - "title": "Month", - "description": "The date of the data." - }, - "m1": { - "type": "number", - "title": "M1", - "description": "Value of the M1 money supply in billions." - }, - "m2": { - "type": "number", - "title": "M2", - "description": "Value of the M2 money supply in billions." + "title": "Unearned Premiums Liability", + "description": "Unearned premiums liability." }, - "currency": { + "other_taxes_payable": { "anyOf": [ { "type": "number" @@ -36025,10 +42847,10 @@ "type": "null" } ], - "title": "Currency", - "description": "Value of currency in circulation in billions." + "title": "Other Taxes Payable", + "description": "Other taxes payable." }, - "demand_deposits": { + "policy_holder_funds": { "anyOf": [ { "type": "number" @@ -36037,10 +42859,10 @@ "type": "null" } ], - "title": "Demand Deposits", - "description": "Value of demand deposits in billions." + "title": "Policy Holder Funds", + "description": "Policy holder funds." }, - "retail_money_market_funds": { + "other_current_liabilities": { "anyOf": [ { "type": "number" @@ -36049,10 +42871,10 @@ "type": "null" } ], - "title": "Retail Money Market Funds", - "description": "Value of retail money market funds in billions." + "title": "Other Current Liabilities", + "description": "Other current liabilities." }, - "other_liquid_deposits": { + "other_current_non_operating_liabilities": { "anyOf": [ { "type": "number" @@ -36061,10 +42883,10 @@ "type": "null" } ], - "title": "Other Liquid Deposits", - "description": "Value of other liquid deposits in billions." + "title": "Other Current Non Operating Liabilities", + "description": "Other current non-operating liabilities." }, - "small_denomination_time_deposits": { + "separate_account_business_liabilities": { "anyOf": [ { "type": "number" @@ -36073,29 +42895,10 @@ "type": "null" } ], - "title": "Small Denomination Time Deposits", - "description": "Value of small denomination time deposits in billions." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "month", - "m1", - "m2" - ], - "title": "FederalReserveMoneyMeasures", - "description": "FederalReserve Money Measures Data." - }, - "FederalReserveTreasuryRates": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Separate Account Business Liabilities", + "description": "Separate account business liabilities." }, - "week_4": { + "total_current_liabilities": { "anyOf": [ { "type": "number" @@ -36104,12 +42907,10 @@ "type": "null" } ], - "title": "Week 4", - "description": "4 week Treasury bills rate (secondary market).", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Total Current Liabilities", + "description": "Total current liabilities." }, - "month_1": { + "long_term_debt": { "anyOf": [ { "type": "number" @@ -36118,12 +42919,10 @@ "type": "null" } ], - "title": "Month 1", - "description": "1 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Long Term Debt", + "description": "Long term debt." }, - "month_2": { + "other_long_term_liabilities": { "anyOf": [ { "type": "number" @@ -36132,12 +42931,10 @@ "type": "null" } ], - "title": "Month 2", - "description": "2 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Long Term Liabilities", + "description": "Other long term liabilities." }, - "month_3": { + "non_current_deferred_revenue": { "anyOf": [ { "type": "number" @@ -36146,12 +42943,10 @@ "type": "null" } ], - "title": "Month 3", - "description": "3 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Non Current Deferred Revenue", + "description": "Non-current deferred revenue." }, - "month_6": { + "non_current_deferred_payable_income_tax_liabilities": { "anyOf": [ { "type": "number" @@ -36160,12 +42955,10 @@ "type": "null" } ], - "title": "Month 6", - "description": "6 month Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Non Current Deferred Payable Income Tax Liabilities", + "description": "Non-current deferred payable income tax liabilities." }, - "year_1": { + "non_current_employee_benefit_liabilities": { "anyOf": [ { "type": "number" @@ -36174,12 +42967,10 @@ "type": "null" } ], - "title": "Year 1", - "description": "1 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Non Current Employee Benefit Liabilities", + "description": "Non-current employee benefit liabilities." }, - "year_2": { + "other_non_current_operating_liabilities": { "anyOf": [ { "type": "number" @@ -36188,12 +42979,10 @@ "type": "null" } ], - "title": "Year 2", - "description": "2 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Non Current Operating Liabilities", + "description": "Other non-current operating liabilities." }, - "year_3": { + "other_non_current_non_operating_liabilities": { "anyOf": [ { "type": "number" @@ -36202,12 +42991,10 @@ "type": "null" } ], - "title": "Year 3", - "description": "3 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Non Current Non Operating Liabilities", + "description": "Other non-current, non-operating liabilities." }, - "year_5": { + "total_non_current_liabilities": { "anyOf": [ { "type": "number" @@ -36216,12 +43003,10 @@ "type": "null" } ], - "title": "Year 5", - "description": "5 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Total Non Current Liabilities", + "description": "Total non-current liabilities." }, - "year_7": { + "capital_lease_obligations": { "anyOf": [ { "type": "number" @@ -36230,12 +43015,10 @@ "type": "null" } ], - "title": "Year 7", - "description": "7 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Capital Lease Obligations", + "description": "Capital lease obligations." }, - "year_10": { + "asset_retirement_reserve_litigation_obligation": { "anyOf": [ { "type": "number" @@ -36244,12 +43027,10 @@ "type": "null" } ], - "title": "Year 10", - "description": "10 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Asset Retirement Reserve Litigation Obligation", + "description": "Asset retirement reserve litigation obligation." }, - "year_20": { + "total_liabilities": { "anyOf": [ { "type": "number" @@ -36258,12 +43039,10 @@ "type": "null" } ], - "title": "Year 20", - "description": "20 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Total Liabilities", + "description": "Total liabilities." }, - "year_30": { + "commitments_contingencies": { "anyOf": [ { "type": "number" @@ -36272,224 +43051,219 @@ "type": "null" } ], - "title": "Year 30", - "description": "30 year Treasury rate.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "FederalReserveTreasuryRates", - "description": "FederalReserve Treasury Rates Data." - }, - "FredIndex": { - "properties": { - "symbol": { + "title": "Commitments Contingencies", + "description": "Commitments contingencies." + }, + "redeemable_non_controlling_interest": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol" + "title": "Redeemable Non Controlling Interest", + "description": "Redeemable non-controlling interest." }, - "name": { + "preferred_stock": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name" + "title": "Preferred Stock", + "description": "Preferred stock." }, - "continent": { + "common_stock": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Continent" + "title": "Common Stock", + "description": "Common stock." }, - "country": { + "retained_earnings": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Country" + "title": "Retained Earnings", + "description": "Retained earnings." }, - "update_frequency": { + "treasury_stock": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Update Frequency" + "title": "Treasury Stock", + "description": "Treasury stock." }, - "frequency_short": { + "accumulated_other_comprehensive_income": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Frequency Short" + "title": "Accumulated Other Comprehensive Income", + "description": "Accumulated other comprehensive income." }, - "observation_start": { + "participating_policy_holder_equity": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Observation Start" + "title": "Participating Policy Holder Equity", + "description": "Participating policy holder equity." }, - "observation_end": { + "other_equity_adjustments": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Observation End" + "title": "Other Equity Adjustments", + "description": "Other equity adjustments." }, - "units": { + "total_common_equity": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Units" + "title": "Total Common Equity", + "description": "Total common equity." }, - "units_short": { + "total_preferred_common_equity": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Units Short" - } - }, - "type": "object", - "title": "FredIndex", - "description": "Fred Index Model." - }, - "FredRegional": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "region": { - "type": "string", - "title": "Region", - "description": "The name of the region." + "title": "Total Preferred Common Equity", + "description": "Total preferred common equity." }, - "code": { + "non_controlling_interest": { "anyOf": [ { - "type": "string" + "type": "number" }, { - "type": "integer" + "type": "null" } ], - "title": "Code", - "description": "The code of the region." + "title": "Non Controlling Interest", + "description": "Non-controlling interest." }, - "value": { + "total_equity_non_controlling_interests": { "anyOf": [ { "type": "number" }, { - "type": "integer" + "type": "null" + } + ], + "title": "Total Equity Non Controlling Interests", + "description": "Total equity non-controlling interests." + }, + "total_liabilities_shareholders_equity": { + "anyOf": [ + { + "type": "number" }, { "type": "null" } ], - "title": "Value", - "description": "The observation value. The units are defined in the search results by series ID." - }, - "series_id": { - "type": "string", - "title": "Series Id", - "description": "The individual series ID for the region." + "title": "Total Liabilities Shareholders Equity", + "description": "Total liabilities and shareholders equity." } }, "additionalProperties": true, "type": "object", "required": [ - "date", - "region", - "code", - "series_id" + "period_ending" ], - "title": "FredRegional", - "description": "FRED Regional Data." + "title": "IntrinioBalanceSheetData", + "description": "Intrinio Balance Sheet Data." }, - "FredSearch": { + "IntrinioCalendarIpoData": { "properties": { - "release_id": { + "symbol": { "anyOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "ipo_date": { + "anyOf": [ + { + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Release Id", - "description": "The release ID for queries." + "title": "Ipo Date", + "description": "The date of the IPO, when the stock first trades on a major exchange." }, - "series_id": { + "status": { "anyOf": [ { - "type": "string" + "type": "string", + "enum": [ + "upcoming", + "priced", + "withdrawn" + ] }, { "type": "null" } ], - "title": "Series Id", - "description": "The series ID for the item in the release." + "title": "Status", + "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." }, - "name": { + "exchange": { "anyOf": [ { "type": "string" @@ -36498,96 +43272,94 @@ "type": "null" } ], - "title": "Name", - "description": "The name of the release." + "title": "Exchange", + "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ." }, - "title": { + "offer_amount": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Title", - "description": "The title of the series." + "title": "Offer Amount", + "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count" }, - "observation_start": { + "share_price": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Observation Start", - "description": "The date of the first observation in the series." + "title": "Share Price", + "description": "The price per share at which the IPO was offered." }, - "observation_end": { + "share_price_lowest": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Observation End", - "description": "The date of the last observation in the series." + "title": "Share Price Lowest", + "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)." }, - "frequency": { + "share_price_highest": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Frequency", - "description": "The frequency of the data." + "title": "Share Price Highest", + "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)." }, - "frequency_short": { + "share_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Frequency Short", - "description": "Short form of the data frequency." + "title": "Share Count", + "description": "The number of shares offered in the IPO." }, - "units": { + "share_count_lowest": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Units", - "description": "The units of the data." + "title": "Share Count Lowest", + "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)." }, - "units_short": { + "share_count_highest": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Units Short", - "description": "Short form of the data units." + "title": "Share Count Highest", + "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)." }, - "seasonal_adjustment": { + "announcement_url": { "anyOf": [ { "type": "string" @@ -36596,10 +43368,10 @@ "type": "null" } ], - "title": "Seasonal Adjustment", - "description": "The seasonal adjustment of the data." + "title": "Announcement Url", + "description": "The URL to the company's announcement of the IPO" }, - "seasonal_adjustment_short": { + "sec_report_url": { "anyOf": [ { "type": "string" @@ -36608,83 +43380,82 @@ "type": "null" } ], - "title": "Seasonal Adjustment Short", - "description": "Short form of the data seasonal adjustment." + "title": "Sec Report Url", + "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." }, - "last_updated": { + "open_price": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Last Updated", - "description": "The datetime of the last update to the data." + "title": "Open Price", + "description": "The opening price at the beginning of the first trading day (only available for priced IPOs)." }, - "notes": { + "close_price": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Notes", - "description": "Description of the release." + "title": "Close Price", + "description": "The closing price at the end of the first trading day (only available for priced IPOs)." }, - "press_release": { + "volume": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Press Release", - "description": "If the release is a press release." + "title": "Volume", + "description": "The volume at the end of the first trading day (only available for priced IPOs)." }, - "url": { + "day_change": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Url", - "description": "URL to the release." + "title": "Day Change", + "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs)." }, - "popularity": { + "week_change": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Popularity", - "description": "Popularity of the series" + "title": "Week Change", + "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)." }, - "group_popularity": { + "month_change": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Group Popularity", - "description": "Group popularity of the release" + "title": "Month Change", + "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)." }, - "region_type": { + "id": { "anyOf": [ { "type": "string" @@ -36693,61 +43464,38 @@ "type": "null" } ], - "title": "Region Type", - "description": "The region type of the series." + "title": "Id", + "description": "The Intrinio ID of the IPO." }, - "series_group": { + "company": { "anyOf": [ { - "type": "integer" - }, - { - "type": "string" + "$ref": "#/components/schemas/IntrinioCompany" }, { "type": "null" } ], - "title": "Series Group", - "description": "The series group ID of the series. This value is used to query for regional data." - } - }, - "additionalProperties": true, - "type": "object", - "title": "FredSearch", - "description": "FRED Search Data." - }, - "FredSeries": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "description": "The company that is going public via the IPO." + }, + "security": { + "anyOf": [ + { + "$ref": "#/components/schemas/IntrinioSecurity" + }, + { + "type": "null" + } + ], + "description": "The primary Security for the Company that is going public via the IPO" } }, "additionalProperties": true, "type": "object", - "required": [ - "date" - ], - "title": "FredSeries", - "description": "FRED Series Data." - }, - "HTTPValidationError": { - "properties": { - "detail": { - "items": { - "$ref": "#/components/schemas/ValidationError" - }, - "type": "array", - "title": "Detail" - } - }, - "type": "object", - "title": "HTTPValidationError" + "title": "IntrinioCalendarIpoData", + "description": "Intrinio IPO Calendar Data." }, - "IntrinioBalanceSheet": { + "IntrinioCashFlowStatementData": { "properties": { "period_ending": { "type": "string", @@ -36791,7 +43539,7 @@ "title": "Reported Currency", "description": "The currency in which the balance sheet is reported." }, - "cash_and_cash_equivalents": { + "net_income_continuing_operations": { "anyOf": [ { "type": "number" @@ -36800,10 +43548,10 @@ "type": "null" } ], - "title": "Cash And Cash Equivalents", - "description": "Cash and cash equivalents." + "title": "Net Income Continuing Operations", + "description": "Net Income (Continuing Operations)" }, - "cash_and_due_from_banks": { + "net_income_discontinued_operations": { "anyOf": [ { "type": "number" @@ -36812,10 +43560,10 @@ "type": "null" } ], - "title": "Cash And Due From Banks", - "description": "Cash and due from banks." + "title": "Net Income Discontinued Operations", + "description": "Net Income (Discontinued Operations)" }, - "restricted_cash": { + "net_income": { "anyOf": [ { "type": "number" @@ -36824,10 +43572,10 @@ "type": "null" } ], - "title": "Restricted Cash", - "description": "Restricted cash." + "title": "Net Income", + "description": "Consolidated Net Income." }, - "short_term_investments": { + "provision_for_loan_losses": { "anyOf": [ { "type": "number" @@ -36836,10 +43584,10 @@ "type": "null" } ], - "title": "Short Term Investments", - "description": "Short term investments." + "title": "Provision For Loan Losses", + "description": "Provision for Loan Losses" }, - "federal_funds_sold": { + "provision_for_credit_losses": { "anyOf": [ { "type": "number" @@ -36848,10 +43596,10 @@ "type": "null" } ], - "title": "Federal Funds Sold", - "description": "Federal funds sold." + "title": "Provision For Credit Losses", + "description": "Provision for credit losses" }, - "accounts_receivable": { + "depreciation_expense": { "anyOf": [ { "type": "number" @@ -36860,10 +43608,10 @@ "type": "null" } ], - "title": "Accounts Receivable", - "description": "Accounts receivable." + "title": "Depreciation Expense", + "description": "Depreciation Expense." }, - "note_and_lease_receivable": { + "amortization_expense": { "anyOf": [ { "type": "number" @@ -36872,10 +43620,10 @@ "type": "null" } ], - "title": "Note And Lease Receivable", - "description": "Note and lease receivable. (Vendor non-trade receivables)" + "title": "Amortization Expense", + "description": "Amortization Expense." }, - "inventories": { + "share_based_compensation": { "anyOf": [ { "type": "number" @@ -36884,10 +43632,10 @@ "type": "null" } ], - "title": "Inventories", - "description": "Net Inventories." + "title": "Share Based Compensation", + "description": "Share-based compensation." }, - "customer_and_other_receivables": { + "non_cash_adjustments_to_reconcile_net_income": { "anyOf": [ { "type": "number" @@ -36896,10 +43644,10 @@ "type": "null" } ], - "title": "Customer And Other Receivables", - "description": "Customer and other receivables." + "title": "Non Cash Adjustments To Reconcile Net Income", + "description": "Non-Cash Adjustments to Reconcile Net Income." }, - "interest_bearing_deposits_at_other_banks": { + "changes_in_operating_assets_and_liabilities": { "anyOf": [ { "type": "number" @@ -36908,10 +43656,10 @@ "type": "null" } ], - "title": "Interest Bearing Deposits At Other Banks", - "description": "Interest bearing deposits at other banks." + "title": "Changes In Operating Assets And Liabilities", + "description": "Changes in Operating Assets and Liabilities (Net)" }, - "time_deposits_placed_and_other_short_term_investments": { + "net_cash_from_continuing_operating_activities": { "anyOf": [ { "type": "number" @@ -36920,10 +43668,10 @@ "type": "null" } ], - "title": "Time Deposits Placed And Other Short Term Investments", - "description": "Time deposits placed and other short term investments." + "title": "Net Cash From Continuing Operating Activities", + "description": "Net Cash from Continuing Operating Activities" }, - "trading_account_securities": { + "net_cash_from_discontinued_operating_activities": { "anyOf": [ { "type": "number" @@ -36932,10 +43680,10 @@ "type": "null" } ], - "title": "Trading Account Securities", - "description": "Trading account securities." + "title": "Net Cash From Discontinued Operating Activities", + "description": "Net Cash from Discontinued Operating Activities" }, - "loans_and_leases": { + "net_cash_from_operating_activities": { "anyOf": [ { "type": "number" @@ -36944,10 +43692,10 @@ "type": "null" } ], - "title": "Loans And Leases", - "description": "Loans and leases." + "title": "Net Cash From Operating Activities", + "description": "Net Cash from Operating Activities" }, - "allowance_for_loan_and_lease_losses": { + "divestitures": { "anyOf": [ { "type": "number" @@ -36956,10 +43704,10 @@ "type": "null" } ], - "title": "Allowance For Loan And Lease Losses", - "description": "Allowance for loan and lease losses." + "title": "Divestitures", + "description": "Divestitures" }, - "current_deferred_refundable_income_taxes": { + "sale_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" @@ -36968,10 +43716,10 @@ "type": "null" } ], - "title": "Current Deferred Refundable Income Taxes", - "description": "Current deferred refundable income taxes." + "title": "Sale Of Property Plant And Equipment", + "description": "Sale of Property, Plant, and Equipment" }, - "other_current_assets": { + "acquisitions": { "anyOf": [ { "type": "number" @@ -36980,10 +43728,10 @@ "type": "null" } ], - "title": "Other Current Assets", - "description": "Other current assets." + "title": "Acquisitions", + "description": "Acquisitions" }, - "loans_and_leases_net_of_allowance": { + "purchase_of_investments": { "anyOf": [ { "type": "number" @@ -36992,10 +43740,10 @@ "type": "null" } ], - "title": "Loans And Leases Net Of Allowance", - "description": "Loans and leases net of allowance." + "title": "Purchase Of Investments", + "description": "Purchase of Investments" }, - "accrued_investment_income": { + "purchase_of_investment_securities": { "anyOf": [ { "type": "number" @@ -37004,10 +43752,10 @@ "type": "null" } ], - "title": "Accrued Investment Income", - "description": "Accrued investment income." + "title": "Purchase Of Investment Securities", + "description": "Purchase of Investment Securities" }, - "other_current_non_operating_assets": { + "sale_and_maturity_of_investments": { "anyOf": [ { "type": "number" @@ -37016,8 +43764,8 @@ "type": "null" } ], - "title": "Other Current Non Operating Assets", - "description": "Other current non-operating assets." + "title": "Sale And Maturity Of Investments", + "description": "Sale and Maturity of Investments" }, "loans_held_for_sale": { "anyOf": [ @@ -37029,9 +43777,9 @@ } ], "title": "Loans Held For Sale", - "description": "Loans held for sale." + "description": "Loans Held for Sale (Net)" }, - "prepaid_expenses": { + "purchase_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" @@ -37040,10 +43788,10 @@ "type": "null" } ], - "title": "Prepaid Expenses", - "description": "Prepaid expenses." + "title": "Purchase Of Property Plant And Equipment", + "description": "Purchase of Property, Plant, and Equipment" }, - "total_current_assets": { + "other_investing_activities": { "anyOf": [ { "type": "number" @@ -37052,10 +43800,10 @@ "type": "null" } ], - "title": "Total Current Assets", - "description": "Total current assets." + "title": "Other Investing Activities", + "description": "Other Investing Activities (Net)" }, - "plant_property_equipment_gross": { + "net_cash_from_continuing_investing_activities": { "anyOf": [ { "type": "number" @@ -37064,10 +43812,10 @@ "type": "null" } ], - "title": "Plant Property Equipment Gross", - "description": "Plant property equipment gross." + "title": "Net Cash From Continuing Investing Activities", + "description": "Net Cash from Continuing Investing Activities" }, - "accumulated_depreciation": { + "net_cash_from_discontinued_investing_activities": { "anyOf": [ { "type": "number" @@ -37076,10 +43824,10 @@ "type": "null" } ], - "title": "Accumulated Depreciation", - "description": "Accumulated depreciation." + "title": "Net Cash From Discontinued Investing Activities", + "description": "Net Cash from Discontinued Investing Activities" }, - "premises_and_equipment_net": { + "net_cash_from_investing_activities": { "anyOf": [ { "type": "number" @@ -37088,10 +43836,10 @@ "type": "null" } ], - "title": "Premises And Equipment Net", - "description": "Net premises and equipment." + "title": "Net Cash From Investing Activities", + "description": "Net Cash from Investing Activities" }, - "plant_property_equipment_net": { + "payment_of_dividends": { "anyOf": [ { "type": "number" @@ -37100,10 +43848,10 @@ "type": "null" } ], - "title": "Plant Property Equipment Net", - "description": "Net plant property equipment." + "title": "Payment Of Dividends", + "description": "Payment of Dividends" }, - "long_term_investments": { + "repurchase_of_common_equity": { "anyOf": [ { "type": "number" @@ -37112,10 +43860,10 @@ "type": "null" } ], - "title": "Long Term Investments", - "description": "Long term investments." + "title": "Repurchase Of Common Equity", + "description": "Repurchase of Common Equity" }, - "mortgage_servicing_rights": { + "repurchase_of_preferred_equity": { "anyOf": [ { "type": "number" @@ -37124,10 +43872,10 @@ "type": "null" } ], - "title": "Mortgage Servicing Rights", - "description": "Mortgage servicing rights." + "title": "Repurchase Of Preferred Equity", + "description": "Repurchase of Preferred Equity" }, - "unearned_premiums_asset": { + "issuance_of_common_equity": { "anyOf": [ { "type": "number" @@ -37136,10 +43884,10 @@ "type": "null" } ], - "title": "Unearned Premiums Asset", - "description": "Unearned premiums asset." + "title": "Issuance Of Common Equity", + "description": "Issuance of Common Equity" }, - "non_current_note_lease_receivables": { + "issuance_of_preferred_equity": { "anyOf": [ { "type": "number" @@ -37148,10 +43896,10 @@ "type": "null" } ], - "title": "Non Current Note Lease Receivables", - "description": "Non-current note lease receivables." + "title": "Issuance Of Preferred Equity", + "description": "Issuance of Preferred Equity" }, - "deferred_acquisition_cost": { + "issuance_of_debt": { "anyOf": [ { "type": "number" @@ -37160,10 +43908,10 @@ "type": "null" } ], - "title": "Deferred Acquisition Cost", - "description": "Deferred acquisition cost." + "title": "Issuance Of Debt", + "description": "Issuance of Debt" }, - "goodwill": { + "repayment_of_debt": { "anyOf": [ { "type": "number" @@ -37172,10 +43920,10 @@ "type": "null" } ], - "title": "Goodwill", - "description": "Goodwill." + "title": "Repayment Of Debt", + "description": "Repayment of Debt" }, - "separate_account_business_assets": { + "other_financing_activities": { "anyOf": [ { "type": "number" @@ -37184,10 +43932,10 @@ "type": "null" } ], - "title": "Separate Account Business Assets", - "description": "Separate account business assets." + "title": "Other Financing Activities", + "description": "Other Financing Activities (Net)" }, - "non_current_deferred_refundable_income_taxes": { + "cash_interest_received": { "anyOf": [ { "type": "number" @@ -37196,10 +43944,10 @@ "type": "null" } ], - "title": "Non Current Deferred Refundable Income Taxes", - "description": "Noncurrent deferred refundable income taxes." + "title": "Cash Interest Received", + "description": "Cash Interest Received" }, - "intangible_assets": { + "net_change_in_deposits": { "anyOf": [ { "type": "number" @@ -37208,10 +43956,10 @@ "type": "null" } ], - "title": "Intangible Assets", - "description": "Intangible assets." + "title": "Net Change In Deposits", + "description": "Net Change in Deposits" }, - "employee_benefit_assets": { + "net_increase_in_fed_funds_sold": { "anyOf": [ { "type": "number" @@ -37220,10 +43968,10 @@ "type": "null" } ], - "title": "Employee Benefit Assets", - "description": "Employee benefit assets." + "title": "Net Increase In Fed Funds Sold", + "description": "Net Increase in Fed Funds Sold" }, - "other_assets": { + "net_cash_from_continuing_financing_activities": { "anyOf": [ { "type": "number" @@ -37232,10 +43980,10 @@ "type": "null" } ], - "title": "Other Assets", - "description": "Other assets." + "title": "Net Cash From Continuing Financing Activities", + "description": "Net Cash from Continuing Financing Activities" }, - "other_non_current_operating_assets": { + "net_cash_from_discontinued_financing_activities": { "anyOf": [ { "type": "number" @@ -37244,10 +43992,10 @@ "type": "null" } ], - "title": "Other Non Current Operating Assets", - "description": "Other noncurrent operating assets." + "title": "Net Cash From Discontinued Financing Activities", + "description": "Net Cash from Discontinued Financing Activities" }, - "other_non_current_non_operating_assets": { + "net_cash_from_financing_activities": { "anyOf": [ { "type": "number" @@ -37256,10 +44004,10 @@ "type": "null" } ], - "title": "Other Non Current Non Operating Assets", - "description": "Other noncurrent non-operating assets." + "title": "Net Cash From Financing Activities", + "description": "Net Cash from Financing Activities" }, - "interest_bearing_deposits": { + "effect_of_exchange_rate_changes": { "anyOf": [ { "type": "number" @@ -37268,10 +44016,10 @@ "type": "null" } ], - "title": "Interest Bearing Deposits", - "description": "Interest bearing deposits." + "title": "Effect Of Exchange Rate Changes", + "description": "Effect of Exchange Rate Changes" }, - "total_non_current_assets": { + "other_net_changes_in_cash": { "anyOf": [ { "type": "number" @@ -37280,10 +44028,10 @@ "type": "null" } ], - "title": "Total Non Current Assets", - "description": "Total noncurrent assets." + "title": "Other Net Changes In Cash", + "description": "Other Net Changes in Cash" }, - "total_assets": { + "net_change_in_cash_and_equivalents": { "anyOf": [ { "type": "number" @@ -37292,10 +44040,10 @@ "type": "null" } ], - "title": "Total Assets", - "description": "Total assets." + "title": "Net Change In Cash And Equivalents", + "description": "Net Change in Cash and Equivalents" }, - "non_interest_bearing_deposits": { + "cash_income_taxes_paid": { "anyOf": [ { "type": "number" @@ -37304,10 +44052,10 @@ "type": "null" } ], - "title": "Non Interest Bearing Deposits", - "description": "Non interest bearing deposits." + "title": "Cash Income Taxes Paid", + "description": "Cash Income Taxes Paid" }, - "federal_funds_purchased_and_securities_sold": { + "cash_interest_paid": { "anyOf": [ { "type": "number" @@ -37316,226 +44064,325 @@ "type": "null" } ], - "title": "Federal Funds Purchased And Securities Sold", - "description": "Federal funds purchased and securities sold." + "title": "Cash Interest Paid", + "description": "Cash Interest Paid" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending" + ], + "title": "IntrinioCashFlowStatementData", + "description": "Intrinio Cash Flow Statement Data." + }, + "IntrinioCompany": { + "properties": { + "id": { + "type": "string", + "title": "Id", + "description": "The Intrinio ID of the Company." }, - "bankers_acceptance_outstanding": { + "ticker": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Bankers Acceptance Outstanding", - "description": "Bankers acceptance outstanding." + "title": "Ticker", + "description": "The stock market ticker symbol associated with the company's common stock securities" }, - "short_term_debt": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Short Term Debt", - "description": "Short term debt." + "title": "Name", + "description": "The company's common name." }, - "accounts_payable": { + "lei": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Accounts Payable", - "description": "Accounts payable." + "title": "Lei", + "description": "The Legal Entity Identifier (LEI) of the company." }, - "current_deferred_revenue": { + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Deferred Revenue", - "description": "Current deferred revenue." + "title": "Cik", + "description": "The Central Index Key (CIK) of the company." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "id", + "cik" + ], + "title": "IntrinioCompany", + "description": "Intrinio Company Data." + }, + "IntrinioCompanyFilingsData": { + "properties": { + "filing_date": { + "type": "string", + "format": "date", + "title": "Filing Date", + "description": "The date of the filing." }, - "current_deferred_payable_income_tax_liabilities": { + "accepted_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Current Deferred Payable Income Tax Liabilities", - "description": "Current deferred payable income tax liabilities." + "title": "Accepted Date", + "description": "Accepted date of the filing." }, - "accrued_interest_payable": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Accrued Interest Payable", - "description": "Accrued interest payable." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "accrued_expenses": { + "cik": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Accrued Expenses", - "description": "Accrued expenses." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "other_short_term_payables": { + "report_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Short Term Payables", - "description": "Other short term payables." + "title": "Report Type", + "description": "Type of filing." }, - "customer_deposits": { + "filing_url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Customer Deposits", - "description": "Customer deposits." + "title": "Filing Url", + "description": "URL to the filing page." }, - "dividends_payable": { + "report_url": { + "type": "string", + "title": "Report Url", + "description": "URL to the actual report." + }, + "id": { + "type": "string", + "title": "Id", + "description": "Intrinio ID of the filing." + }, + "period_end_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Dividends Payable", - "description": "Dividends payable." + "title": "Period End Date", + "description": "Ending date of the fiscal period for the filing." }, - "claims_and_claim_expense": { + "sec_unique_id": { + "type": "string", + "title": "Sec Unique Id", + "description": "SEC unique ID of the filing." + }, + "instance_url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Claims And Claim Expense", - "description": "Claims and claim expense." + "title": "Instance Url", + "description": "URL for the XBRL filing for the report." }, - "future_policy_benefits": { + "industry_group": { + "type": "string", + "title": "Industry Group", + "description": "Industry group of the company." + }, + "industry_category": { + "type": "string", + "title": "Industry Category", + "description": "Industry category of the company." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "filing_date", + "report_url", + "id", + "sec_unique_id", + "industry_group", + "industry_category" + ], + "title": "IntrinioCompanyFilingsData", + "description": "Intrinio Company Filings Data." + }, + "IntrinioCompanyNewsData": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data. Here it is the published date of the article." + }, + "title": { + "type": "string", + "title": "Title", + "description": "Title of the article." + }, + "text": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Future Policy Benefits", - "description": "Future policy benefits." + "title": "Text", + "description": "Text/body of the article." }, - "current_employee_benefit_liabilities": { + "images": { "anyOf": [ { - "type": "number" + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" }, { "type": "null" } ], - "title": "Current Employee Benefit Liabilities", - "description": "Current employee benefit liabilities." + "title": "Images", + "description": "Images associated with the article." }, - "unearned_premiums_liability": { + "url": { + "type": "string", + "title": "Url", + "description": "URL to the article." + }, + "symbols": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Unearned Premiums Liability", - "description": "Unearned premiums liability." + "title": "Symbols", + "description": "Symbols associated with the article." }, - "other_taxes_payable": { + "source": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Taxes Payable", - "description": "Other taxes payable." + "title": "Source", + "description": "The source of the news article." }, - "policy_holder_funds": { + "summary": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Policy Holder Funds", - "description": "Policy holder funds." + "title": "Summary", + "description": "The summary of the news article." }, - "other_current_liabilities": { + "topics": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Current Liabilities", - "description": "Other current liabilities." + "title": "Topics", + "description": "The topics related to the news article." }, - "other_current_non_operating_liabilities": { + "word_count": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Other Current Non Operating Liabilities", - "description": "Other current non-operating liabilities." + "title": "Word Count", + "description": "The word count of the news article." }, - "separate_account_business_liabilities": { + "business_relevance": { "anyOf": [ { "type": "number" @@ -37544,22 +44391,22 @@ "type": "null" } ], - "title": "Separate Account Business Liabilities", - "description": "Separate account business liabilities." + "title": "Business Relevance", + "description": " \tHow strongly correlated the news article is to the business" }, - "total_current_liabilities": { + "sentiment": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Total Current Liabilities", - "description": "Total current liabilities." + "title": "Sentiment", + "description": "The sentiment of the news article - i.e, negative, positive." }, - "long_term_debt": { + "sentiment_confidence": { "anyOf": [ { "type": "number" @@ -37568,94 +44415,165 @@ "type": "null" } ], - "title": "Long Term Debt", - "description": "Long term debt." + "title": "Sentiment Confidence", + "description": "The confidence score of the sentiment rating." }, - "other_long_term_liabilities": { + "language": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Long Term Liabilities", - "description": "Other long term liabilities." + "title": "Language", + "description": "The language of the news article." }, - "non_current_deferred_revenue": { + "spam": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Non Current Deferred Revenue", - "description": "Non-current deferred revenue." + "title": "Spam", + "description": "Whether the news article is spam." }, - "non_current_deferred_payable_income_tax_liabilities": { + "copyright": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Non Current Deferred Payable Income Tax Liabilities", - "description": "Non-current deferred payable income tax liabilities." + "title": "Copyright", + "description": "The copyright notice of the news article." }, - "non_current_employee_benefit_liabilities": { + "id": { + "type": "string", + "title": "Id", + "description": "Article ID." + }, + "security": { "anyOf": [ { - "type": "number" + "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], - "title": "Non Current Employee Benefit Liabilities", - "description": "Non-current employee benefit liabilities." + "description": "The Intrinio Security object. Contains the security details related to the news article." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "url", + "id" + ], + "title": "IntrinioCompanyNewsData", + "description": "Intrinio Company News Data." + }, + "IntrinioCurrencyPairsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "other_non_current_operating_liabilities": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Non Current Operating Liabilities", - "description": "Other non-current operating liabilities." + "title": "Name", + "description": "Name of the currency pair." }, - "other_non_current_non_operating_liabilities": { + "base_currency": { + "type": "string", + "title": "Base Currency", + "description": "ISO 4217 currency code of the base currency." + }, + "quote_currency": { + "type": "string", + "title": "Quote Currency", + "description": "ISO 4217 currency code of the quote currency." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "base_currency", + "quote_currency" + ], + "title": "IntrinioCurrencyPairsData", + "description": "Intrinio Currency Available Pairs Data." + }, + "IntrinioEquityHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Other Non Current Non Operating Liabilities", - "description": "Other non-current, non-operating liabilities." + "title": "Date", + "description": "The date of the data." }, - "total_non_current_liabilities": { + "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": "Total Non Current Liabilities", - "description": "Total non-current liabilities." + "title": "Volume", + "description": "The trading volume." }, - "capital_lease_obligations": { + "vwap": { "anyOf": [ { "type": "number" @@ -37664,10 +44582,10 @@ "type": "null" } ], - "title": "Capital Lease Obligations", - "description": "Capital lease obligations." + "title": "Vwap", + "description": "Volume Weighted Average Price over the period." }, - "asset_retirement_reserve_litigation_obligation": { + "average": { "anyOf": [ { "type": "number" @@ -37676,10 +44594,10 @@ "type": "null" } ], - "title": "Asset Retirement Reserve Litigation Obligation", - "description": "Asset retirement reserve litigation obligation." + "title": "Average", + "description": "Average trade price of an individual equity during the interval." }, - "total_liabilities": { + "change": { "anyOf": [ { "type": "number" @@ -37688,10 +44606,10 @@ "type": "null" } ], - "title": "Total Liabilities", - "description": "Total liabilities." + "title": "Change", + "description": "Change in the price of the symbol from the previous day." }, - "commitments_contingencies": { + "percent_change": { "anyOf": [ { "type": "number" @@ -37700,10 +44618,12 @@ "type": "null" } ], - "title": "Commitments Contingencies", - "description": "Commitments contingencies." + "title": "Percent Change", + "description": "Percent change in the price of the symbol from the previous day.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "redeemable_non_controlling_interest": { + "adj_open": { "anyOf": [ { "type": "number" @@ -37712,10 +44632,10 @@ "type": "null" } ], - "title": "Redeemable Non Controlling Interest", - "description": "Redeemable non-controlling interest." + "title": "Adj Open", + "description": "The adjusted open price." }, - "preferred_stock": { + "adj_high": { "anyOf": [ { "type": "number" @@ -37724,10 +44644,10 @@ "type": "null" } ], - "title": "Preferred Stock", - "description": "Preferred stock." + "title": "Adj High", + "description": "The adjusted high price." }, - "common_stock": { + "adj_low": { "anyOf": [ { "type": "number" @@ -37736,10 +44656,10 @@ "type": "null" } ], - "title": "Common Stock", - "description": "Common stock." + "title": "Adj Low", + "description": "The adjusted low price." }, - "retained_earnings": { + "adj_close": { "anyOf": [ { "type": "number" @@ -37748,10 +44668,10 @@ "type": "null" } ], - "title": "Retained Earnings", - "description": "Retained earnings." + "title": "Adj Close", + "description": "The adjusted close price." }, - "treasury_stock": { + "adj_volume": { "anyOf": [ { "type": "number" @@ -37760,10 +44680,10 @@ "type": "null" } ], - "title": "Treasury Stock", - "description": "Treasury stock." + "title": "Adj Volume", + "description": "The adjusted volume." }, - "accumulated_other_comprehensive_income": { + "fifty_two_week_high": { "anyOf": [ { "type": "number" @@ -37772,10 +44692,10 @@ "type": "null" } ], - "title": "Accumulated Other Comprehensive Income", - "description": "Accumulated other comprehensive income." + "title": "Fifty Two Week High", + "description": "52 week high price for the symbol." }, - "participating_policy_holder_equity": { + "fifty_two_week_low": { "anyOf": [ { "type": "number" @@ -37784,10 +44704,10 @@ "type": "null" } ], - "title": "Participating Policy Holder Equity", - "description": "Participating policy holder equity." + "title": "Fifty Two Week Low", + "description": "52 week low price for the symbol." }, - "other_equity_adjustments": { + "factor": { "anyOf": [ { "type": "number" @@ -37796,10 +44716,10 @@ "type": "null" } ], - "title": "Other Equity Adjustments", - "description": "Other equity adjustments." + "title": "Factor", + "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices." }, - "total_common_equity": { + "split_ratio": { "anyOf": [ { "type": "number" @@ -37808,10 +44728,10 @@ "type": "null" } ], - "title": "Total Common Equity", - "description": "Total common equity." + "title": "Split Ratio", + "description": "Ratio of the equity split, if a split occurred." }, - "total_preferred_common_equity": { + "dividend": { "anyOf": [ { "type": "number" @@ -37820,57 +44740,67 @@ "type": "null" } ], - "title": "Total Preferred Common Equity", - "description": "Total preferred common equity." + "title": "Dividend", + "description": "Dividend amount, if a dividend was paid." }, - "non_controlling_interest": { + "close_time": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Non Controlling Interest", - "description": "Non-controlling interest." + "title": "Close Time", + "description": "The timestamp that represents the end of the interval span." }, - "total_equity_non_controlling_interests": { + "frequency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Total Equity Non Controlling Interests", - "description": "Total equity non-controlling interests." + "title": "Frequency", + "description": "The data time frequency." }, - "total_liabilities_shareholders_equity": { + "intraperiod": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Total Liabilities Shareholders Equity", - "description": "Total liabilities and shareholders equity." + "title": "Intraperiod", + "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" } }, "additionalProperties": true, "type": "object", "required": [ - "period_ending" + "date", + "open", + "high", + "low", + "close" ], - "title": "IntrinioBalanceSheet", - "description": "Intrinio Balance Sheet Data." + "title": "IntrinioEquityHistoricalData", + "description": "Intrinio Equity Historical Price Data." }, - "IntrinioCalendarIpo": { + "IntrinioEquityInfoData": { "properties": { "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { "anyOf": [ { "type": "string" @@ -37879,40 +44809,34 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Name", + "description": "Common name of the company." }, - "ipo_date": { + "cik": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Ipo Date", - "description": "The date of the IPO, when the stock first trades on a major exchange." + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." }, - "status": { + "cusip": { "anyOf": [ { - "type": "string", - "enum": [ - "upcoming", - "priced", - "withdrawn" - ] + "type": "string" }, { "type": "null" } ], - "title": "Status", - "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." + "title": "Cusip", + "description": "CUSIP identifier for the company." }, - "exchange": { + "isin": { "anyOf": [ { "type": "string" @@ -37921,94 +44845,94 @@ "type": "null" } ], - "title": "Exchange", - "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ." + "title": "Isin", + "description": "International Securities Identification Number." }, - "offer_amount": { + "lei": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Offer Amount", - "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count" + "title": "Lei", + "description": "Legal Entity Identifier assigned to the company." }, - "share_price": { + "legal_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Share Price", - "description": "The price per share at which the IPO was offered." + "title": "Legal Name", + "description": "Official legal name of the company." }, - "share_price_lowest": { + "stock_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Share Price Lowest", - "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)." + "title": "Stock Exchange", + "description": "Stock exchange where the company is traded." }, - "share_price_highest": { + "sic": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Share Price Highest", - "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)." + "title": "Sic", + "description": "Standard Industrial Classification code for the company." }, - "share_count": { + "short_description": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Share Count", - "description": "The number of shares offered in the IPO." + "title": "Short Description", + "description": "Short description of the company." }, - "share_count_lowest": { + "long_description": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Share Count Lowest", - "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)." + "title": "Long Description", + "description": "Long description of the company." }, - "share_count_highest": { + "ceo": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Share Count Highest", - "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)." + "title": "Ceo", + "description": "Chief Executive Officer of the company." }, - "announcement_url": { + "company_url": { "anyOf": [ { "type": "string" @@ -38017,10 +44941,10 @@ "type": "null" } ], - "title": "Announcement Url", - "description": "The URL to the company's announcement of the IPO" + "title": "Company Url", + "description": "URL of the company's website." }, - "sec_report_url": { + "business_address": { "anyOf": [ { "type": "string" @@ -38029,82 +44953,82 @@ "type": "null" } ], - "title": "Sec Report Url", - "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." + "title": "Business Address", + "description": "Address of the company's headquarters." }, - "open_price": { + "mailing_address": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Open Price", - "description": "The opening price at the beginning of the first trading day (only available for priced IPOs)." + "title": "Mailing Address", + "description": "Mailing address of the company." }, - "close_price": { + "business_phone_no": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Close Price", - "description": "The closing price at the end of the first trading day (only available for priced IPOs)." + "title": "Business Phone No", + "description": "Phone number of the company's headquarters." }, - "volume": { + "hq_address_1": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The volume at the end of the first trading day (only available for priced IPOs)." + "title": "Hq Address 1", + "description": "Address of the company's headquarters." }, - "day_change": { + "hq_address_2": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Day Change", - "description": "The percentage change between the open price and the close price on the first trading day (only available for priced IPOs)." + "title": "Hq Address 2", + "description": "Address of the company's headquarters." }, - "week_change": { + "hq_address_city": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Week Change", - "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)." + "title": "Hq Address City", + "description": "City of the company's headquarters." }, - "month_change": { + "hq_address_postal_code": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Month Change", - "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)." + "title": "Hq Address Postal Code", + "description": "Zip code of the company's headquarters." }, - "id": { + "hq_state": { "anyOf": [ { "type": "string" @@ -38113,46 +45037,34 @@ "type": "null" } ], - "title": "Id", - "description": "The Intrinio ID of the IPO." + "title": "Hq State", + "description": "State of the company's headquarters." }, - "company": { + "hq_country": { "anyOf": [ { - "$ref": "#/components/schemas/IntrinioCompany" + "type": "string" }, { "type": "null" } ], - "description": "The company that is going public via the IPO." + "title": "Hq Country", + "description": "Country of the company's headquarters." }, - "security": { + "inc_state": { "anyOf": [ { - "$ref": "#/components/schemas/IntrinioSecurity" + "type": "string" }, { "type": "null" } ], - "description": "The primary Security for the Company that is going public via the IPO" - } - }, - "additionalProperties": true, - "type": "object", - "title": "IntrinioCalendarIpo", - "description": "Intrinio IPO Calendar Data." - }, - "IntrinioCashFlowStatement": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "title": "Inc State", + "description": "State in which the company is incorporated." }, - "fiscal_period": { + "inc_country": { "anyOf": [ { "type": "string" @@ -38161,10 +45073,10 @@ "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the report." + "title": "Inc Country", + "description": "Country in which the company is incorporated." }, - "fiscal_year": { + "employees": { "anyOf": [ { "type": "integer" @@ -38173,10 +45085,10 @@ "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." + "title": "Employees", + "description": "Number of employees working for the company." }, - "reported_currency": { + "entity_legal_form": { "anyOf": [ { "type": "string" @@ -38185,202 +45097,228 @@ "type": "null" } ], - "title": "Reported Currency", - "description": "The currency in which the balance sheet is reported." + "title": "Entity Legal Form", + "description": "Legal form of the company." }, - "net_income_continuing_operations": { + "entity_status": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income Continuing Operations", - "description": "Net Income (Continuing Operations)" + "title": "Entity Status", + "description": "Status of the company." }, - "net_income_discontinued_operations": { + "latest_filing_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Net Income Discontinued Operations", - "description": "Net Income (Discontinued Operations)" + "title": "Latest Filing Date", + "description": "Date of the company's latest filing." }, - "net_income": { + "irs_number": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income", - "description": "Consolidated Net Income." + "title": "Irs Number", + "description": "IRS number assigned to the company." }, - "provision_for_loan_losses": { + "sector": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Provision For Loan Losses", - "description": "Provision for Loan Losses" + "title": "Sector", + "description": "Sector in which the company operates." }, - "provision_for_credit_losses": { + "industry_category": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Provision For Credit Losses", - "description": "Provision for credit losses" + "title": "Industry Category", + "description": "Category of industry in which the company operates." }, - "depreciation_expense": { + "industry_group": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Depreciation Expense", - "description": "Depreciation Expense." + "title": "Industry Group", + "description": "Group of industry in which the company operates." }, - "amortization_expense": { + "template": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Amortization Expense", - "description": "Amortization Expense." + "title": "Template", + "description": "Template used to standardize the company's financial statements." }, - "share_based_compensation": { + "standardized_active": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Share Based Compensation", - "description": "Share-based compensation." + "title": "Standardized Active", + "description": "Whether the company is active or not." }, - "non_cash_adjustments_to_reconcile_net_income": { + "first_fundamental_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Non Cash Adjustments To Reconcile Net Income", - "description": "Non-Cash Adjustments to Reconcile Net Income." + "title": "First Fundamental Date", + "description": "Date of the company's first fundamental." }, - "changes_in_operating_assets_and_liabilities": { + "last_fundamental_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Changes In Operating Assets And Liabilities", - "description": "Changes in Operating Assets and Liabilities (Net)" + "title": "Last Fundamental Date", + "description": "Date of the company's last fundamental." }, - "net_cash_from_continuing_operating_activities": { + "first_stock_price_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Net Cash From Continuing Operating Activities", - "description": "Net Cash from Continuing Operating Activities" + "title": "First Stock Price Date", + "description": "Date of the company's first stock price." }, - "net_cash_from_discontinued_operating_activities": { + "last_stock_price_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Net Cash From Discontinued Operating Activities", - "description": "Net Cash from Discontinued Operating Activities" + "title": "Last Stock Price Date", + "description": "Date of the company's last stock price." }, - "net_cash_from_operating_activities": { + "id": { + "type": "string", + "title": "Id", + "description": "Intrinio ID for the company." + }, + "thea_enabled": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Net Cash From Operating Activities", - "description": "Net Cash from Operating Activities" + "title": "Thea Enabled", + "description": "Whether the company has been enabled for Thea." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioEquityInfoData", + "description": "Intrinio Equity Info Data." + }, + "IntrinioEquityQuoteData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "divestitures": { + "asset_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Divestitures", - "description": "Divestitures" + "title": "Asset Type", + "description": "Type of asset - i.e, stock, ETF, etc." }, - "sale_of_property_plant_and_equipment": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Sale Of Property Plant And Equipment", - "description": "Sale of Property, Plant, and Equipment" + "title": "Name", + "description": "Name of the company or asset." }, - "acquisitions": { + "exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Acquisitions", - "description": "Acquisitions" + "title": "Exchange", + "description": "The name or symbol of the venue where the data is from." }, - "purchase_of_investments": { + "bid": { "anyOf": [ { "type": "number" @@ -38389,34 +45327,34 @@ "type": "null" } ], - "title": "Purchase Of Investments", - "description": "Purchase of Investments" + "title": "Bid", + "description": "Price of the top bid order." }, - "purchase_of_investment_securities": { + "bid_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Purchase Of Investment Securities", - "description": "Purchase of Investment Securities" + "title": "Bid Size", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." }, - "sale_and_maturity_of_investments": { + "bid_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Sale And Maturity Of Investments", - "description": "Sale and Maturity of Investments" + "title": "Bid Exchange", + "description": "The specific trading venue where the purchase order was placed." }, - "loans_held_for_sale": { + "ask": { "anyOf": [ { "type": "number" @@ -38425,130 +45363,178 @@ "type": "null" } ], - "title": "Loans Held For Sale", - "description": "Loans Held for Sale (Net)" + "title": "Ask", + "description": "Price of the top ask order." }, - "purchase_of_property_plant_and_equipment": { + "ask_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Purchase Of Property Plant And Equipment", - "description": "Purchase of Property, Plant, and Equipment" + "title": "Ask Size", + "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." }, - "other_investing_activities": { + "ask_exchange": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Investing Activities", - "description": "Other Investing Activities (Net)" + "title": "Ask Exchange", + "description": "The specific trading venue where the sale order was placed." }, - "net_cash_from_continuing_investing_activities": { + "quote_conditions": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Net Cash From Continuing Investing Activities", - "description": "Net Cash from Continuing Investing Activities" + "title": "Quote Conditions", + "description": "Conditions or condition codes applicable to the quote." }, - "net_cash_from_discontinued_investing_activities": { + "quote_indicators": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Net Cash From Discontinued Investing Activities", - "description": "Net Cash from Discontinued Investing Activities" + "title": "Quote Indicators", + "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO." }, - "net_cash_from_investing_activities": { + "sales_conditions": { "anyOf": [ { - "type": "number" + "type": "string" + }, + { + "type": "integer" + }, + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Net Cash From Investing Activities", - "description": "Net Cash from Investing Activities" + "title": "Sales Conditions", + "description": "Conditions or condition codes applicable to the sale." }, - "payment_of_dividends": { + "sequence_number": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Payment Of Dividends", - "description": "Payment of Dividends" + "title": "Sequence Number", + "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)." }, - "repurchase_of_common_equity": { + "market_center": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Repurchase Of Common Equity", - "description": "Repurchase of Common Equity" + "title": "Market Center", + "description": "The ID of the UTP participant that originated the message." }, - "repurchase_of_preferred_equity": { + "participant_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Repurchase Of Preferred Equity", - "description": "Repurchase of Preferred Equity" + "title": "Participant Timestamp", + "description": "Timestamp for when the quote was generated by the exchange." }, - "issuance_of_common_equity": { + "trf_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Issuance Of Common Equity", - "description": "Issuance of Common Equity" + "title": "Trf Timestamp", + "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." }, - "issuance_of_preferred_equity": { + "sip_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Issuance Of Preferred Equity", - "description": "Issuance of Preferred Equity" + "title": "Sip Timestamp", + "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." }, - "issuance_of_debt": { + "last_price": { "anyOf": [ { "type": "number" @@ -38557,46 +45543,47 @@ "type": "null" } ], - "title": "Issuance Of Debt", - "description": "Issuance of Debt" + "title": "Last Price", + "description": "Price of the last trade." }, - "repayment_of_debt": { + "last_tick": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Repayment Of Debt", - "description": "Repayment of Debt" + "title": "Last Tick", + "description": "Whether the last sale was an up or down tick." }, - "other_financing_activities": { + "last_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Other Financing Activities", - "description": "Other Financing Activities (Net)" + "title": "Last Size", + "description": "Size of the last trade." }, - "cash_interest_received": { + "last_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Cash Interest Received", - "description": "Cash Interest Received" + "title": "Last Timestamp", + "description": "Date and Time when the last price was recorded." }, - "net_change_in_deposits": { + "open": { "anyOf": [ { "type": "number" @@ -38605,10 +45592,10 @@ "type": "null" } ], - "title": "Net Change In Deposits", - "description": "Net Change in Deposits" + "title": "Open", + "description": "The open price." }, - "net_increase_in_fed_funds_sold": { + "high": { "anyOf": [ { "type": "number" @@ -38617,10 +45604,10 @@ "type": "null" } ], - "title": "Net Increase In Fed Funds Sold", - "description": "Net Increase in Fed Funds Sold" + "title": "High", + "description": "The high price." }, - "net_cash_from_continuing_financing_activities": { + "low": { "anyOf": [ { "type": "number" @@ -38629,10 +45616,10 @@ "type": "null" } ], - "title": "Net Cash From Continuing Financing Activities", - "description": "Net Cash from Continuing Financing Activities" + "title": "Low", + "description": "The low price." }, - "net_cash_from_discontinued_financing_activities": { + "close": { "anyOf": [ { "type": "number" @@ -38641,34 +45628,40 @@ "type": "null" } ], - "title": "Net Cash From Discontinued Financing Activities", - "description": "Net Cash from Discontinued Financing Activities" + "title": "Close", + "description": "The close price." }, - "net_cash_from_financing_activities": { + "volume": { "anyOf": [ { "type": "number" }, + { + "type": "integer" + }, { "type": "null" } ], - "title": "Net Cash From Financing Activities", - "description": "Net Cash from Financing Activities" + "title": "Volume", + "description": "The trading volume." }, - "effect_of_exchange_rate_changes": { + "exchange_volume": { "anyOf": [ { "type": "number" }, + { + "type": "integer" + }, { "type": "null" } ], - "title": "Effect Of Exchange Rate Changes", - "description": "Effect of Exchange Rate Changes" + "title": "Exchange Volume", + "description": "Volume of shares exchanged during the trading day on the specific exchange." }, - "other_net_changes_in_cash": { + "prev_close": { "anyOf": [ { "type": "number" @@ -38677,10 +45670,10 @@ "type": "null" } ], - "title": "Other Net Changes In Cash", - "description": "Other Net Changes in Cash" + "title": "Prev Close", + "description": "The previous close price." }, - "net_change_in_cash_and_equivalents": { + "change": { "anyOf": [ { "type": "number" @@ -38689,10 +45682,10 @@ "type": "null" } ], - "title": "Net Change In Cash And Equivalents", - "description": "Net Change in Cash and Equivalents" + "title": "Change", + "description": "Change in price from previous close." }, - "cash_income_taxes_paid": { + "change_percent": { "anyOf": [ { "type": "number" @@ -38701,10 +45694,11 @@ "type": "null" } ], - "title": "Cash Income Taxes Paid", - "description": "Cash Income Taxes Paid" + "title": "Change Percent", + "description": "Change in price as a normalized percentage.", + "x-frontendmultiply": 100 }, - "cash_interest_paid": { + "year_high": { "anyOf": [ { "type": "number" @@ -38713,50 +45707,34 @@ "type": "null" } ], - "title": "Cash Interest Paid", - "description": "Cash Interest Paid" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending" - ], - "title": "IntrinioCashFlowStatement", - "description": "Intrinio Cash Flow Statement Data." - }, - "IntrinioCompany": { - "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The Intrinio ID of the Company." + "title": "Year High", + "description": "The one year high (52W High)." }, - "ticker": { + "year_low": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Ticker", - "description": "The stock market ticker symbol associated with the company's common stock securities" + "title": "Year Low", + "description": "The one year low (52W Low)." }, - "name": { + "is_darkpool": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Name", - "description": "The company's common name." + "title": "Is Darkpool", + "description": "Whether or not the current trade is from a darkpool." }, - "lei": { + "source": { "anyOf": [ { "type": "string" @@ -38765,53 +45743,51 @@ "type": "null" } ], - "title": "Lei", - "description": "The Legal Entity Identifier (LEI) of the company." + "title": "Source", + "description": "Source of the Intrinio data." }, - "cik": { + "updated_on": { + "type": "string", + "format": "date-time", + "title": "Updated On", + "description": "Date and Time when the data was last updated." + }, + "security": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], - "title": "Cik", - "description": "The Central Index Key (CIK) of the company." + "description": "Security details related to the quote." } }, "additionalProperties": true, "type": "object", "required": [ - "id", - "cik" + "symbol", + "updated_on" ], - "title": "IntrinioCompany", - "description": "Intrinio Company Data." + "title": "IntrinioEquityQuoteData", + "description": "Intrinio Equity Quote Data." }, - "IntrinioCompanyFilings": { + "IntrinioEquitySearchData": { "properties": { - "filing_date": { - "type": "string", - "format": "date", - "title": "Filing Date", - "description": "The date of the filing." - }, - "accepted_date": { + "symbol": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Accepted Date", - "description": "Accepted date of the filing." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "symbol": { + "name": { "anyOf": [ { "type": "string" @@ -38820,8 +45796,8 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Name", + "description": "Name of the company." }, "cik": { "anyOf": [ @@ -38833,9 +45809,9 @@ } ], "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "description": "" }, - "report_type": { + "lei": { "anyOf": [ { "type": "string" @@ -38844,10 +45820,28 @@ "type": "null" } ], - "title": "Report Type", - "description": "Type of filing." + "title": "Lei", + "description": "The Legal Entity Identifier (LEI) of the company." }, - "filing_url": { + "intrinio_id": { + "type": "string", + "title": "Intrinio Id", + "description": "The Intrinio ID of the company." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "cik", + "lei", + "intrinio_id" + ], + "title": "IntrinioEquitySearchData", + "description": "Intrinio Equity Search Data." + }, + "IntrinioEtfHoldingsData": { + "properties": { + "symbol": { "anyOf": [ { "type": "string" @@ -38856,38 +45850,22 @@ "type": "null" } ], - "title": "Filing Url", - "description": "URL to the filing page." - }, - "report_url": { - "type": "string", - "title": "Report Url", - "description": "URL to the actual report." - }, - "id": { - "type": "string", - "title": "Id", - "description": "Intrinio ID of the filing." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" }, - "period_end_date": { + "name": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Period End Date", - "description": "Ending date of the fiscal period for the filing." - }, - "sec_unique_id": { - "type": "string", - "title": "Sec Unique Id", - "description": "SEC unique ID of the filing." + "title": "Name", + "description": "The common name for the holding." }, - "instance_url": { + "security_type": { "anyOf": [ { "type": "string" @@ -38896,47 +45874,10 @@ "type": "null" } ], - "title": "Instance Url", - "description": "URL for the XBRL filing for the report." - }, - "industry_group": { - "type": "string", - "title": "Industry Group", - "description": "Industry group of the company." - }, - "industry_category": { - "type": "string", - "title": "Industry Category", - "description": "Industry category of the company." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "filing_date", - "report_url", - "id", - "sec_unique_id", - "industry_group", - "industry_category" - ], - "title": "IntrinioCompanyFilings", - "description": "Intrinio Company Filings Data." - }, - "IntrinioCompanyNews": { - "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. Here it is the published date of the article." - }, - "title": { - "type": "string", - "title": "Title", - "description": "Title of the article." + "title": "Security Type", + "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')" }, - "text": { + "isin": { "anyOf": [ { "type": "string" @@ -38945,33 +45886,22 @@ "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Isin", + "description": "The International Securities Identification Number." }, - "images": { + "ric": { "anyOf": [ { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Images", - "description": "Images associated with the article." - }, - "url": { - "type": "string", - "title": "Url", - "description": "URL to the article." + "title": "Ric", + "description": "The Reuters Instrument Code." }, - "symbols": { + "sedol": { "anyOf": [ { "type": "string" @@ -38980,136 +45910,60 @@ "type": "null" } ], - "title": "Symbols", - "description": "Symbols associated with the article." - }, - "id": { - "type": "string", - "title": "Id", - "description": "Article ID." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "title", - "url", - "id" - ], - "title": "IntrinioCompanyNews", - "description": "Intrinio Company News Data." - }, - "IntrinioCurrencyPairs": { - "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "Name of the currency pair." - }, - "code": { - "type": "string", - "title": "Code", - "description": "Code of the currency pair." - }, - "base_currency": { - "type": "string", - "title": "Base Currency", - "description": "ISO 4217 currency code of the base currency." + "title": "Sedol", + "description": "The Stock Exchange Daily Official List." }, - "quote_currency": { - "type": "string", - "title": "Quote Currency", - "description": "ISO 4217 currency code of the quote currency." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "name", - "code", - "base_currency", - "quote_currency" - ], - "title": "IntrinioCurrencyPairs", - "description": "Intrinio Currency Available Pairs Data." - }, - "IntrinioEquityHistorical": { - "properties": { - "date": { + "share_class_figi": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { - "type": "string", - "format": "date-time" + "type": "null" } ], - "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." + "title": "Share Class Figi", + "description": "The OpenFIGI symbol for the holding." }, - "volume": { + "country": { "anyOf": [ { - "type": "number" - }, - { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Country", + "description": "The country or region of the holding." }, - "vwap": { + "maturity_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Vwap", - "description": "Volume Weighted Average Price over the period." + "title": "Maturity Date", + "description": "The maturity date for the debt security, if available." }, - "average": { + "contract_expiry_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Average", - "description": "Average trade price of an individual equity during the interval." + "title": "Contract Expiry Date", + "description": "Expiry date for the futures contract held, if available." }, - "change": { + "coupon": { "anyOf": [ { "type": "number" @@ -39118,11 +45972,14 @@ "type": "null" } ], - "title": "Change", - "description": "Change in the price of the symbol from the previous day." + "title": "Coupon", + "description": "The coupon rate of the debt security, if available." }, - "change_percent": { + "balance": { "anyOf": [ + { + "type": "integer" + }, { "type": "number" }, @@ -39130,24 +45987,22 @@ "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" + "title": "Balance", + "description": "The number of units of the security held, if available." }, - "adj_open": { + "unit": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Adj Open", - "description": "The adjusted open price." + "title": "Unit", + "description": "The units of the 'balance' field." }, - "adj_high": { + "units_per_share": { "anyOf": [ { "type": "number" @@ -39156,10 +46011,10 @@ "type": "null" } ], - "title": "Adj High", - "description": "The adjusted high price." + "title": "Units Per Share", + "description": "Number of units of the security held per share outstanding of the ETF, if available." }, - "adj_low": { + "face_value": { "anyOf": [ { "type": "number" @@ -39168,10 +46023,10 @@ "type": "null" } ], - "title": "Adj Low", - "description": "The adjusted low price." + "title": "Face Value", + "description": "The face value of the debt security, if available." }, - "adj_close": { + "derivatives_value": { "anyOf": [ { "type": "number" @@ -39180,10 +46035,10 @@ "type": "null" } ], - "title": "Adj Close", - "description": "The adjusted close price." + "title": "Derivatives Value", + "description": "The notional value of derivatives contracts held." }, - "adj_volume": { + "value": { "anyOf": [ { "type": "number" @@ -39192,10 +46047,10 @@ "type": "null" } ], - "title": "Adj Volume", - "description": "The adjusted volume." + "title": "Value", + "description": "The market value of the holding, on the 'as_of' date." }, - "fifty_two_week_high": { + "weight": { "anyOf": [ { "type": "number" @@ -39204,139 +46059,136 @@ "type": "null" } ], - "title": "Fifty Two Week High", - "description": "52 week high price for the symbol." + "title": "Weight", + "description": "The weight of the holding, as a normalized percent." }, - "fifty_two_week_low": { + "updated": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Fifty Two Week Low", - "description": "52 week low price for the symbol." + "title": "Updated", + "description": "The 'as_of' date for the holding." + } + }, + "additionalProperties": true, + "type": "object", + "title": "IntrinioEtfHoldingsData", + "description": "Intrinio ETF Holdings Data." + }, + "IntrinioEtfInfoData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. (ETF)" }, - "factor": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Factor", - "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices." + "title": "Name", + "description": "Name of the ETF." }, - "split_ratio": { + "description": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Split Ratio", - "description": "Ratio of the equity split, if a split occurred." + "title": "Description", + "description": "Description of the fund." }, - "dividend": { + "inception_date": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Dividend", - "description": "Dividend amount, if a dividend was paid." + "title": "Inception Date", + "description": "Inception date of the ETF." }, - "close_time": { + "fund_listing_date": { "anyOf": [ { "type": "string", - "format": "date-time" + "format": "date" }, { "type": "null" } ], - "title": "Close Time", - "description": "The timestamp that represents the end of the interval span." + "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." }, - "interval": { + "data_change_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Interval", - "description": "The data time frequency." + "title": "Data Change Date", + "description": "The last date on which there was a change in a classifications data field for this ETF." }, - "intra_period": { + "etn_maturity_date": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date" }, { "type": "null" } ], - "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" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "open", - "high", - "low", - "close" - ], - "title": "IntrinioEquityHistorical", - "description": "Intrinio Equity Historical Price Data." - }, - "IntrinioEquityInfo": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Etn Maturity Date", + "description": "If the product is an ETN, this field identifies the maturity date for the ETN." }, - "name": { + "is_listed": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Name", - "description": "Common name of the company." + "title": "Is Listed", + "description": "If true, the ETF is still listed on an exchange." }, - "cik": { + "close_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Cik", - "description": "Central Index Key (CIK) for the requested entity." + "title": "Close Date", + "description": "The date on which the ETF was de-listed if it is no longer listed." }, - "cusip": { + "exchange": { "anyOf": [ { "type": "string" @@ -39345,8 +46197,8 @@ "type": "null" } ], - "title": "Cusip", - "description": "CUSIP identifier for the company." + "title": "Exchange", + "description": "The exchange Market Identifier Code (MIC)." }, "isin": { "anyOf": [ @@ -39358,9 +46210,9 @@ } ], "title": "Isin", - "description": "International Securities Identification Number." + "description": "International Securities Identification Number (ISIN)." }, - "lei": { + "ric": { "anyOf": [ { "type": "string" @@ -39369,10 +46221,10 @@ "type": "null" } ], - "title": "Lei", - "description": "Legal Entity Identifier assigned to the company." + "title": "Ric", + "description": "Reuters Instrument Code (RIC)." }, - "legal_name": { + "sedol": { "anyOf": [ { "type": "string" @@ -39381,10 +46233,10 @@ "type": "null" } ], - "title": "Legal Name", - "description": "Official legal name of the company." + "title": "Sedol", + "description": "Stock Exchange Daily Official List (SEDOL)." }, - "stock_exchange": { + "figi_symbol": { "anyOf": [ { "type": "string" @@ -39393,22 +46245,22 @@ "type": "null" } ], - "title": "Stock Exchange", - "description": "Stock exchange where the company is traded." + "title": "Figi Symbol", + "description": "Financial Instrument Global Identifier (FIGI) symbol." }, - "sic": { + "share_class_figi": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Sic", - "description": "Standard Industrial Classification code for the company." + "title": "Share Class Figi", + "description": "Financial Instrument Global Identifier (FIGI)." }, - "short_description": { + "firstbridge_id": { "anyOf": [ { "type": "string" @@ -39417,10 +46269,10 @@ "type": "null" } ], - "title": "Short Description", - "description": "Short description of the company." + "title": "Firstbridge Id", + "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF)." }, - "long_description": { + "firstbridge_parent_id": { "anyOf": [ { "type": "string" @@ -39429,10 +46281,10 @@ "type": "null" } ], - "title": "Long Description", - "description": "Long description of the company." + "title": "Firstbridge Parent Id", + "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable." }, - "ceo": { + "intrinio_id": { "anyOf": [ { "type": "string" @@ -39441,10 +46293,10 @@ "type": "null" } ], - "title": "Ceo", - "description": "Chief Executive Officer of the company." + "title": "Intrinio Id", + "description": "Intrinio unique identifier for the security." }, - "company_url": { + "intraday_nav_symbol": { "anyOf": [ { "type": "string" @@ -39453,10 +46305,10 @@ "type": "null" } ], - "title": "Company Url", - "description": "URL of the company's website." + "title": "Intraday Nav Symbol", + "description": "Intraday Net Asset Value (NAV) symbol." }, - "business_address": { + "primary_symbol": { "anyOf": [ { "type": "string" @@ -39465,10 +46317,10 @@ "type": "null" } ], - "title": "Business Address", - "description": "Address of the company's headquarters." + "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." }, - "mailing_address": { + "etp_structure_type": { "anyOf": [ { "type": "string" @@ -39477,10 +46329,10 @@ "type": "null" } ], - "title": "Mailing Address", - "description": "Mailing address of the company." + "title": "Etp Structure Type", + "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure." }, - "business_phone_no": { + "legal_structure": { "anyOf": [ { "type": "string" @@ -39489,10 +46341,10 @@ "type": "null" } ], - "title": "Business Phone No", - "description": "Phone number of the company's headquarters." + "title": "Legal Structure", + "description": "Legal structure of the fund." }, - "hq_address_1": { + "issuer": { "anyOf": [ { "type": "string" @@ -39501,10 +46353,10 @@ "type": "null" } ], - "title": "Hq Address 1", - "description": "Address of the company's headquarters." + "title": "Issuer", + "description": "Issuer of the ETF." }, - "hq_address_2": { + "etn_issuing_bank": { "anyOf": [ { "type": "string" @@ -39513,10 +46365,10 @@ "type": "null" } ], - "title": "Hq Address 2", - "description": "Address of the company's headquarters." + "title": "Etn Issuing Bank", + "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank." }, - "hq_address_city": { + "fund_family": { "anyOf": [ { "type": "string" @@ -39525,10 +46377,10 @@ "type": "null" } ], - "title": "Hq Address City", - "description": "City of the company's headquarters." + "title": "Fund Family", + "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor." }, - "hq_address_postal_code": { + "investment_style": { "anyOf": [ { "type": "string" @@ -39537,10 +46389,10 @@ "type": "null" } ], - "title": "Hq Address Postal Code", - "description": "Zip code of the company's headquarters." + "title": "Investment Style", + "description": "Investment style of the ETF." }, - "hq_state": { + "derivatives_based": { "anyOf": [ { "type": "string" @@ -39549,10 +46401,10 @@ "type": "null" } ], - "title": "Hq State", - "description": "State of the company's headquarters." + "title": "Derivatives Based", + "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio." }, - "hq_country": { + "income_category": { "anyOf": [ { "type": "string" @@ -39561,10 +46413,10 @@ "type": "null" } ], - "title": "Hq Country", - "description": "Country of the company's headquarters." + "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" }, - "inc_state": { + "asset_class": { "anyOf": [ { "type": "string" @@ -39573,10 +46425,10 @@ "type": "null" } ], - "title": "Inc State", - "description": "State in which the company is incorporated." + "title": "Asset Class", + "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)." }, - "inc_country": { + "other_asset_types": { "anyOf": [ { "type": "string" @@ -39585,22 +46437,22 @@ "type": "null" } ], - "title": "Inc Country", - "description": "Country in which the company is incorporated." + "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." }, - "employees": { + "single_category_designation": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Employees", - "description": "Number of employees working for the company." + "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." }, - "entity_legal_form": { + "beta_type": { "anyOf": [ { "type": "string" @@ -39609,10 +46461,10 @@ "type": "null" } ], - "title": "Entity Legal Form", - "description": "Legal form of the company." + "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." }, - "entity_status": { + "beta_details": { "anyOf": [ { "type": "string" @@ -39621,23 +46473,22 @@ "type": "null" } ], - "title": "Entity Status", - "description": "Status of the company." + "title": "Beta Details", + "description": "This field provides further detail within the traditional and smart beta categories." }, - "latest_filing_date": { + "market_cap_range": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Latest Filing Date", - "description": "Date of the company's latest filing." + "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.)" }, - "irs_number": { + "market_cap_weighting_type": { "anyOf": [ { "type": "string" @@ -39646,10 +46497,10 @@ "type": "null" } ], - "title": "Irs Number", - "description": "IRS number assigned to the company." + "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." }, - "sector": { + "index_weighting_scheme": { "anyOf": [ { "type": "string" @@ -39658,10 +46509,10 @@ "type": "null" } ], - "title": "Sector", - "description": "Sector in which the company operates." + "title": "Index Weighting Scheme", + "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type." }, - "industry_category": { + "index_linked": { "anyOf": [ { "type": "string" @@ -39670,10 +46521,10 @@ "type": "null" } ], - "title": "Industry Category", - "description": "Category of industry in which the company operates." + "title": "Index Linked", + "description": "This field identifies whether an ETF is index linked or active." }, - "industry_group": { + "index_name": { "anyOf": [ { "type": "string" @@ -39682,10 +46533,10 @@ "type": "null" } ], - "title": "Industry Group", - "description": "Group of industry in which the company operates." + "title": "Index Name", + "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable." }, - "template": { + "index_symbol": { "anyOf": [ { "type": "string" @@ -39694,107 +46545,82 @@ "type": "null" } ], - "title": "Template", - "description": "Template used to standardize the company's financial statements." + "title": "Index Symbol", + "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF." }, - "standardized_active": { + "parent_index": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Standardized Active", - "description": "Whether the company is active or not." + "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." }, - "first_fundamental_date": { + "index_family": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "First Fundamental Date", - "description": "Date of the company's first fundamental." + "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." }, - "last_fundamental_date": { + "broader_index_family": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Last Fundamental Date", - "description": "Date of the company's last fundamental." + "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." }, - "first_stock_price_date": { + "index_provider": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "First Stock Price Date", - "description": "Date of the company's first stock price." + "title": "Index Provider", + "description": "This field identifies the Index provider for the index underlying the ETF, if applicable." }, - "last_stock_price_date": { + "index_provider_code": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Last Stock Price Date", - "description": "Date of the company's last stock price." - }, - "id": { - "type": "string", - "title": "Id", - "description": "Intrinio ID for the company." + "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." }, - "thea_enabled": { + "replication_structure": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Thea Enabled", - "description": "Whether the company has been enabled for Thea." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "IntrinioEquityInfo", - "description": "Intrinio Equity Info Data." - }, - "IntrinioEquityQuote": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Replication Structure", + "description": "The replication structure of the Exchange Traded Product (ETP)." }, - "asset_type": { + "growth_value_tilt": { "anyOf": [ { "type": "string" @@ -39803,10 +46629,10 @@ "type": "null" } ], - "title": "Asset Type", - "description": "Type of asset - i.e, stock, ETF, etc." + "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'." }, - "name": { + "growth_type": { "anyOf": [ { "type": "string" @@ -39815,10 +46641,10 @@ "type": "null" } ], - "title": "Name", - "description": "Name of the company or asset." + "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." }, - "exchange": { + "value_type": { "anyOf": [ { "type": "string" @@ -39827,34 +46653,34 @@ "type": "null" } ], - "title": "Exchange", - "description": "The name or symbol of the venue where the data is from." + "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." }, - "bid": { + "sector": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Bid", - "description": "Price of the top bid order." + "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." }, - "bid_size": { + "industry": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Bid Size", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." + "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." }, - "bid_exchange": { + "industry_group": { "anyOf": [ { "type": "string" @@ -39863,34 +46689,34 @@ "type": "null" } ], - "title": "Bid Exchange", - "description": "The specific trading venue where the purchase order was placed." + "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." }, - "ask": { + "cross_sector_theme": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ask", - "description": "Price of the top ask order." + "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.)" }, - "ask_size": { + "natural_resources_type": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Ask Size", - "description": "This represents the number of round lot orders at the given price. The normal round lot size is 100 shares. A size of 2 means there are 200 shares available at the given price." + "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." }, - "ask_exchange": { + "us_or_excludes_us": { "anyOf": [ { "type": "string" @@ -39899,103 +46725,58 @@ "type": "null" } ], - "title": "Ask Exchange", - "description": "The specific trading venue where the sale order was placed." + "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." }, - "quote_conditions": { + "developed_emerging": { "anyOf": [ { "type": "string" }, - { - "type": "integer" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, { "type": "null" } ], - "title": "Quote Conditions", - "description": "Conditions or condition codes applicable to the quote." + "title": "Developed Emerging", + "description": "This field identifies the stage of development of the markets that the ETF provides exposure to." }, - "quote_indicators": { + "specialized_region": { "anyOf": [ { "type": "string" }, - { - "type": "integer" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, { "type": "null" } ], - "title": "Quote Indicators", - "description": "Indicators or indicator codes applicable to the participant quote related to the price bands for the issue, or the affect the quote has on the NBBO." + "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.)" }, - "sales_conditions": { + "continent": { "anyOf": [ { "type": "string" }, - { - "type": "integer" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, { "type": "null" } ], - "title": "Sales Conditions", - "description": "Conditions or condition codes applicable to the sale." + "title": "Continent", + "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent." }, - "sequence_number": { + "latin_america_sub_group": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Sequence Number", - "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)." + "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." }, - "market_center": { + "europe_sub_group": { "anyOf": [ { "type": "string" @@ -40004,61 +46785,58 @@ "type": "null" } ], - "title": "Market Center", - "description": "The ID of the UTP participant that originated the message." + "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." }, - "participant_timestamp": { + "asia_sub_group": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Participant Timestamp", - "description": "Timestamp for when the quote was generated by the exchange." + "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." }, - "trf_timestamp": { + "specific_country": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Trf Timestamp", - "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." + "title": "Specific Country", + "description": "This field is populated if the ETF provides targeted exposure to a specific country." }, - "sip_timestamp": { + "china_listing_location": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Sip Timestamp", - "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." + "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." }, - "last_price": { + "us_state": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Last Price", - "description": "Price of the last trade." + "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." }, - "last_tick": { + "real_estate": { "anyOf": [ { "type": "string" @@ -40067,186 +46845,178 @@ "type": "null" } ], - "title": "Last Tick", - "description": "Whether the last sale was an up or down tick." + "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." }, - "last_size": { + "fundamental_weighting_type": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Last Size", - "description": "Size of the last trade." + "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." }, - "last_timestamp": { + "dividend_weighting_type": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Timestamp", - "description": "Date and Time when the last price was recorded." + "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." }, - "open": { + "bond_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Open", - "description": "The open price." + "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." }, - "high": { + "government_bond_types": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Government Bond Types", + "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure." }, - "low": { + "municipal_bond_region": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Low", - "description": "The low price." + "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." }, - "close": { + "municipal_vrdo": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Close", - "description": "The close price." + "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." }, - "volume": { + "mortgage_bond_types": { "anyOf": [ { - "type": "number" - }, - { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "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." }, - "exchange_volume": { + "bond_tax_status": { "anyOf": [ { - "type": "number" - }, - { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Exchange Volume", - "description": "Volume of shares exchanged during the trading day on the specific exchange." + "title": "Bond Tax Status", + "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities." }, - "prev_close": { + "credit_quality": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Prev Close", - "description": "The previous close price." + "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." }, - "change": { + "average_maturity": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Change", - "description": "Change in price from previous close." + "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." }, - "change_percent": { + "specific_maturity_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Change Percent", - "description": "Change in price as a normalized percentage.", - "x-frontend_multiply": 100 + "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." }, - "year_high": { + "commodity_types": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Year High", - "description": "The one year high (52W High)." + "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." }, - "year_low": { + "energy_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Year Low", - "description": "The one year low (52W Low)." + "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." }, - "is_darkpool": { + "agricultural_type": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Darkpool", - "description": "Whether or not the current trade is from a darkpool." + "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." }, - "source": { + "livestock_type": { "anyOf": [ { "type": "string" @@ -40255,39 +47025,22 @@ "type": "null" } ], - "title": "Source", - "description": "Source of the Intrinio data." - }, - "updated_on": { - "type": "string", - "format": "date-time", - "title": "Updated On", - "description": "Date and Time when the data was last updated." + "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." }, - "security": { + "metal_type": { "anyOf": [ { - "$ref": "#/components/schemas/IntrinioSecurity" + "type": "string" }, { "type": "null" } ], - "description": "Security details related to the quote." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol", - "updated_on" - ], - "title": "IntrinioEquityQuote", - "description": "Intrinio Equity Quote Data." - }, - "IntrinioEquitySearch": { - "properties": { - "symbol": { + "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" @@ -40296,15 +47049,10 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." - }, - "name": { - "type": "string", - "title": "Name", - "description": "Name of the company." + "title": "Inverse Leveraged", + "description": "This field is populated if the ETF provides inverse or leveraged exposure." }, - "cik": { + "target_date_multi_asset_type": { "anyOf": [ { "type": "string" @@ -40313,10 +47061,10 @@ "type": "null" } ], - "title": "Cik", - "description": "" + "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." }, - "lei": { + "currency_pair": { "anyOf": [ { "type": "string" @@ -40325,29 +47073,10 @@ "type": "null" } ], - "title": "Lei", - "description": "The Legal Entity Identifier (LEI) of the company." + "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." }, - "intrinio_id": { - "type": "string", - "title": "Intrinio Id", - "description": "The Intrinio ID of the company." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "name", - "cik", - "lei", - "intrinio_id" - ], - "title": "IntrinioEquitySearch", - "description": "Intrinio Equity Search Data." - }, - "IntrinioEtfHoldings": { - "properties": { - "symbol": { + "social_environmental_type": { "anyOf": [ { "type": "string" @@ -40356,10 +47085,10 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data. (ETF)" + "title": "Social Environmental Type", + "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme." }, - "name": { + "clean_energy_type": { "anyOf": [ { "type": "string" @@ -40368,10 +47097,10 @@ "type": "null" } ], - "title": "Name", - "description": "The common name for the holding." + "title": "Clean Energy Type", + "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field." }, - "security_type": { + "dividend_type": { "anyOf": [ { "type": "string" @@ -40380,10 +47109,10 @@ "type": "null" } ], - "title": "Security Type", - "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')" + "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." }, - "isin": { + "regular_dividend_payor_type": { "anyOf": [ { "type": "string" @@ -40392,10 +47121,10 @@ "type": "null" } ], - "title": "Isin", - "description": "The International Securities Identification Number." + "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." }, - "ric": { + "quant_strategies_type": { "anyOf": [ { "type": "string" @@ -40404,10 +47133,10 @@ "type": "null" } ], - "title": "Ric", - "description": "The Reuters Instrument Code." + "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." }, - "sedol": { + "other_quant_models": { "anyOf": [ { "type": "string" @@ -40416,10 +47145,10 @@ "type": "null" } ], - "title": "Sedol", - "description": "The Stock Exchange Daily Official List." + "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." }, - "share_class_figi": { + "hedge_fund_type": { "anyOf": [ { "type": "string" @@ -40428,273 +47157,250 @@ "type": "null" } ], - "title": "Share Class Figi", - "description": "The OpenFIGI symbol for the holding." + "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." }, - "country": { + "excludes_financials": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Country", - "description": "The country or region of the holding." + "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." }, - "maturity_date": { + "excludes_technology": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "boolean" }, { "type": "null" } ], - "title": "Maturity Date", - "description": "The maturity date for the debt security, if available." + "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." }, - "contract_expiry_date": { + "holds_only_nyse_stocks": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "boolean" }, { "type": "null" } ], - "title": "Contract Expiry Date", - "description": "Expiry date for the futures contract held, if available." + "title": "Holds Only Nyse Stocks", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE." }, - "coupon": { + "holds_only_nasdaq_stocks": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Coupon", - "description": "The coupon rate of the debt security, if available." + "title": "Holds Only Nasdaq Stocks", + "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq." }, - "balance": { + "holds_mlp": { "anyOf": [ { - "type": "number" - }, - { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Balance", - "description": "The number of units of the security held, if available." + "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." }, - "unit": { + "holds_preferred_stock": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Unit", - "description": "The units of the 'balance' field." + "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." }, - "units_per_share": { + "holds_closed_end_funds": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } - ], - "title": "Units Per Share", - "description": "Number of units of the security held per share outstanding of the ETF, if available." + ], + "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." }, - "face_value": { + "holds_adr": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Face Value", - "description": "The face value of the debt security, if available." + "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." }, - "derivatives_value": { + "laddered": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Derivatives Value", - "description": "The notional value of derivatives contracts held." + "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." }, - "value": { + "zero_coupon": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Value", - "description": "The market value of the holding, on the 'as_of' date." + "title": "Zero Coupon", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills." }, - "weight": { + "floating_rate": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Weight", - "description": "The weight of the holding, as a normalized percent." + "title": "Floating Rate", + "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds." }, - "updated": { + "build_america_bonds": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "boolean" }, { "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)" + "title": "Build America Bonds", + "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds." }, - "name": { + "dynamic_futures_roll": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the ETF." + "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." }, - "description": { + "currency_hedged": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Description", - "description": "Description of the fund." + "title": "Currency Hedged", + "description": "This field is populated if the ETF's strategy involves hedging currency exposure." }, - "inception_date": { + "includes_short_exposure": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Inception Date", - "description": "Inception date of the ETF." + "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." }, - "fund_listing_date": { + "ucits": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "boolean" }, { "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." + "title": "Ucits", + "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant" }, - "data_change_date": { + "registered_countries": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Data Change Date", - "description": "The last date on which there was a change in a classifications data field for this ETF." + "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." }, - "etn_maturity_date": { + "issuer_country": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Etn Maturity Date", - "description": "If the product is an ETN, this field identifies the maturity date for the ETN." + "title": "Issuer Country", + "description": "2 letter ISO country code for the country where the issuer is located." }, - "is_listed": { + "domicile": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Is Listed", - "description": "If true, the ETF is still listed on an exchange." + "title": "Domicile", + "description": "2 letter ISO country code for the country where the ETP is domiciled." }, - "close_date": { + "listing_country_code": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "string" }, { "type": "null" } ], - "title": "Close Date", - "description": "The date on which the ETF was de-listed if it is no longer listed." + "title": "Listing Country Code", + "description": "2 letter ISO country code for the country of the primary listing." }, - "exchange": { + "listing_region": { "anyOf": [ { "type": "string" @@ -40703,10 +47409,10 @@ "type": "null" } ], - "title": "Exchange", - "description": "The exchange Market Identifier Code (MIC)." + "title": "Listing Region", + "description": "Geographic region in the country of the primary listing falls." }, - "isin": { + "bond_currency_denomination": { "anyOf": [ { "type": "string" @@ -40715,10 +47421,10 @@ "type": "null" } ], - "title": "Isin", - "description": "International Securities Identification Number (ISIN)." + "title": "Bond Currency Denomination", + "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities." }, - "ric": { + "base_currency": { "anyOf": [ { "type": "string" @@ -40727,10 +47433,10 @@ "type": "null" } ], - "title": "Ric", - "description": "Reuters Instrument Code (RIC)." + "title": "Base Currency", + "description": "Base currency in which NAV is reported." }, - "sedol": { + "listing_currency": { "anyOf": [ { "type": "string" @@ -40739,58 +47445,75 @@ "type": "null" } ], - "title": "Sedol", - "description": "Stock Exchange Daily Official List (SEDOL)." + "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." }, - "figi_symbol": { + "number_of_holdings": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Figi Symbol", - "description": "Financial Instrument Global Identifier (FIGI) symbol." + "title": "Number Of Holdings", + "description": "The number of holdings in the ETF." }, - "share_class_figi": { + "month_end_assets": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Share Class Figi", - "description": "Financial Instrument Global Identifier (FIGI)." + "title": "Month End Assets", + "description": "Net assets in millions of dollars as of the most recent month end." }, - "firstbridge_id": { + "net_expense_ratio": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Firstbridge Id", - "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF)." + "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" }, - "firstbridge_parent_id": { + "etf_portfolio_turnover": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Firstbridge Parent Id", - "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable." - }, - "intrinio_id": { + "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": "IntrinioEtfInfoData", + "description": "Intrinio ETF Info Data." + }, + "IntrinioEtfPricePerformanceData": { + "properties": { + "symbol": { "anyOf": [ { "type": "string" @@ -40799,382 +47522,436 @@ "type": "null" } ], - "title": "Intrinio Id", - "description": "Intrinio unique identifier for the security." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "intraday_nav_symbol": { + "one_day": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Intraday Nav Symbol", - "description": "Intraday Net Asset Value (NAV) symbol." + "title": "One Day", + "description": "One-day return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "primary_symbol": { + "wtd": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Wtd", + "description": "Week to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "etp_structure_type": { + "one_week": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Etp Structure Type", - "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure." + "title": "One Week", + "description": "One-week return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "legal_structure": { + "mtd": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Legal Structure", - "description": "Legal structure of the fund." + "title": "Mtd", + "description": "Month to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "issuer": { + "one_month": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Issuer", - "description": "Issuer of the ETF." + "title": "One Month", + "description": "One-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "etn_issuing_bank": { + "qtd": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Etn Issuing Bank", - "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank." + "title": "Qtd", + "description": "Quarter to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "fund_family": { + "three_month": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Fund Family", - "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor." + "title": "Three Month", + "description": "Three-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "investment_style": { + "six_month": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Investment Style", - "description": "Investment style of the ETF." + "title": "Six Month", + "description": "Six-month return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "derivatives_based": { + "ytd": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Derivatives Based", - "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio." + "title": "Ytd", + "description": "Year to date return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "income_category": { + "one_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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" + "title": "One Year", + "description": "One-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "asset_class": { + "two_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Asset Class", - "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)." + "title": "Two Year", + "description": "Two-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "other_asset_types": { + "three_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Three Year", + "description": "Three-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "single_category_designation": { + "four_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Four Year", + "description": "Four-year", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "beta_type": { + "five_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Five Year", + "description": "Five-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "beta_details": { + "ten_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Beta Details", - "description": "This field provides further detail within the traditional and smart beta categories." + "title": "Ten Year", + "description": "Ten-year return.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "market_cap_range": { + "max": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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.)" + "title": "Max", + "description": "Return from the beginning of the time series.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "market_cap_weighting_type": { + "max_annualized": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Max Annualized", + "description": "Annualized rate of return from inception.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "index_weighting_scheme": { + "volatility_one_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Index Weighting Scheme", - "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type." + "title": "Volatility One Year", + "description": "Trailing one-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "index_linked": { + "volatility_three_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Index Linked", - "description": "This field identifies whether an ETF is index linked or active." + "title": "Volatility Three Year", + "description": "Trailing three-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "index_name": { + "volatility_five_year": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Index Name", - "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable." + "title": "Volatility Five Year", + "description": "Trailing five-year annualized volatility.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "index_symbol": { + "volume": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Index Symbol", - "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF." + "title": "Volume", + "description": "The trading volume." }, - "parent_index": { + "volume_avg_30": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Volume Avg 30", + "description": "The one-month average daily volume." }, - "index_family": { + "volume_avg_90": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Volume Avg 90", + "description": "The three-month average daily volume." }, - "broader_index_family": { + "volume_avg_180": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Volume Avg 180", + "description": "The six-month average daily volume." }, - "index_provider": { + "beta": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Index Provider", - "description": "This field identifies the Index provider for the index underlying the ETF, if applicable." + "title": "Beta", + "description": "Beta compared to the S&P 500." }, - "index_provider_code": { + "nav": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Nav", + "description": "Net asset value per share." }, - "replication_structure": { + "year_high": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Replication Structure", - "description": "The replication structure of the Exchange Traded Product (ETP)." + "title": "Year High", + "description": "The 52-week high price." }, - "growth_value_tilt": { + "year_low": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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'." + "title": "Year Low", + "description": "The 52-week low price." }, - "growth_type": { + "market_cap": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Market Cap", + "description": "The market capitalization." }, - "value_type": { + "shares_outstanding": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Shares Outstanding", + "description": "The number of shares outstanding." }, - "sector": { + "updated": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "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." + "title": "Updated", + "description": "The date of the data." + } + }, + "additionalProperties": true, + "type": "object", + "title": "IntrinioEtfPricePerformanceData", + "description": "Intrinio ETF Performance Data." + }, + "IntrinioEtfSearchData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data.(ETF)" }, - "industry": { + "name": { "anyOf": [ { "type": "string" @@ -41183,10 +47960,10 @@ "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." + "title": "Name", + "description": "Name of the ETF." }, - "industry_group": { + "exchange": { "anyOf": [ { "type": "string" @@ -41195,10 +47972,10 @@ "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." + "title": "Exchange", + "description": "The exchange MIC code." }, - "cross_sector_theme": { + "figi_ticker": { "anyOf": [ { "type": "string" @@ -41207,10 +47984,10 @@ "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.)" + "title": "Figi Ticker", + "description": "The OpenFIGI ticker." }, - "natural_resources_type": { + "ric": { "anyOf": [ { "type": "string" @@ -41219,10 +47996,10 @@ "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." + "title": "Ric", + "description": "The Reuters Instrument Code." }, - "us_or_excludes_us": { + "isin": { "anyOf": [ { "type": "string" @@ -41231,10 +48008,10 @@ "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." + "title": "Isin", + "description": "The International Securities Identification Number." }, - "developed_emerging": { + "sedol": { "anyOf": [ { "type": "string" @@ -41243,10 +48020,10 @@ "type": "null" } ], - "title": "Developed Emerging", - "description": "This field identifies the stage of development of the markets that the ETF provides exposure to." + "title": "Sedol", + "description": "The Stock Exchange Daily Official List." }, - "specialized_region": { + "intrinio_id": { "anyOf": [ { "type": "string" @@ -41255,22 +48032,60 @@ "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.)" + "title": "Intrinio Id", + "description": "The unique Intrinio ID for the security." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioEtfSearchData", + "description": "Intrinio ETF Search Data." + }, + "IntrinioFinancialRatiosData": { + "properties": { + "period_ending": { + "type": "string", + "title": "Period Ending", + "description": "The date of the data." }, - "continent": { + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "Period of the financial ratios." + }, + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Continent", - "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent." + "title": "Fiscal Year", + "description": "Fiscal year." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "fiscal_period" + ], + "title": "IntrinioFinancialRatiosData", + "description": "Intrinio Financial Ratios Data." + }, + "IntrinioForwardEbitdaEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "latin_america_sub_group": { + "name": { "anyOf": [ { "type": "string" @@ -41279,46 +48094,48 @@ "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." + "title": "Name", + "description": "Name of the entity." }, - "europe_sub_group": { + "last_updated": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "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." + "title": "Last Updated", + "description": "The date of the last update." }, - "asia_sub_group": { + "period_ending": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date" }, { "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." + "title": "Period Ending", + "description": "The end date of the reporting period." }, - "specific_country": { + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Specific Country", - "description": "This field is populated if the ETF provides targeted exposure to a specific country." + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." }, - "china_listing_location": { + "fiscal_period": { "anyOf": [ { "type": "string" @@ -41327,23 +48144,26 @@ "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." + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." }, - "us_state": { + "calendar_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Calendar Year", + "description": "Calendar year for the estimate." }, - "real_estate": { + "calendar_period": { "anyOf": [ + { + "type": "integer" + }, { "type": "string" }, @@ -41351,94 +48171,117 @@ "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." + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." }, - "fundamental_weighting_type": { + "low_estimate": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Low Estimate", + "description": "The EBITDA estimate low for the period." }, - "dividend_weighting_type": { + "high_estimate": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "High Estimate", + "description": "The EBITDA estimate high for the period." }, - "bond_type": { + "mean": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Mean", + "description": "The EBITDA estimate mean for the period." }, - "government_bond_types": { + "median": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Median", + "description": "The EBITDA estimate median for the period." }, - "municipal_bond_region": { + "standard_deviation": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Standard Deviation", + "description": "The EBITDA estimate standard deviation for the period." }, - "municipal_vrdo": { + "number_of_analysts": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "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." + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." }, - "mortgage_bond_types": { + "conensus_type": { "anyOf": [ { - "type": "string" + "type": "string", + "enum": [ + "ebitda", + "ebit", + "enterprise_value", + "cash_flow_per_share", + "pretax_income" + ] }, { "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." + "title": "Conensus Type", + "description": "The type of estimate." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioForwardEbitdaEstimatesData", + "description": "Intrinio Forward EBITDA Estimates Data." + }, + "IntrinioForwardEpsEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "bond_tax_status": { + "name": { "anyOf": [ { "type": "string" @@ -41447,22 +48290,28 @@ "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." + "title": "Name", + "description": "Name of the entity." }, - "credit_quality": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." }, - "average_maturity": { + "fiscal_period": { "anyOf": [ { "type": "string" @@ -41471,10 +48320,10 @@ "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." + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." }, - "specific_maturity_year": { + "calendar_year": { "anyOf": [ { "type": "integer" @@ -41483,10 +48332,10 @@ "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." + "title": "Calendar Year", + "description": "Calendar year for the estimate." }, - "commodity_types": { + "calendar_period": { "anyOf": [ { "type": "string" @@ -41495,142 +48344,161 @@ "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." + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." }, - "energy_type": { + "low_estimate": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Low Estimate", + "description": "Estimated EPS low for the period." }, - "agricultural_type": { + "high_estimate": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "High Estimate", + "description": "Estimated EPS high for the period." }, - "livestock_type": { + "mean": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Mean", + "description": "Estimated EPS mean for the period." }, - "metal_type": { + "median": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Median", + "description": "Estimated EPS median for the period." }, - "inverse_leveraged": { + "standard_deviation": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Inverse Leveraged", - "description": "This field is populated if the ETF provides inverse or leveraged exposure." + "title": "Standard Deviation", + "description": "Estimated EPS standard deviation for the period." }, - "target_date_multi_asset_type": { + "number_of_analysts": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." }, - "currency_pair": { + "revisions_change_percent": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Revisions Change Percent", + "description": "The earnings per share (EPS) percent change in estimate for the period.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "social_environmental_type": { + "mean_1w": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Mean 1W", + "description": "The mean estimate for the period one week ago." }, - "clean_energy_type": { + "mean_1m": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Mean 1M", + "description": "The mean estimate for the period one month ago." }, - "dividend_type": { + "mean_2m": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Mean 2M", + "description": "The mean estimate for the period two months ago." }, - "regular_dividend_payor_type": { + "mean_3m": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Mean 3M", + "description": "The mean estimate for the period three months ago." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "IntrinioForwardEpsEstimatesData", + "description": "Intrinio Forward EPS Estimates Data." + }, + "IntrinioForwardPeEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "quant_strategies_type": { + "name": { "anyOf": [ { "type": "string" @@ -41639,322 +48507,349 @@ "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." + "title": "Name", + "description": "Name of the entity." }, - "other_quant_models": { + "year_1": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Year 1", + "description": "Estimated PE ratio for the next fiscal year." }, - "hedge_fund_type": { + "year_2": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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." + "title": "Year 2", + "description": "Estimated PE ratio two fiscal years from now." }, - "excludes_financials": { + "year_3": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "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." + "title": "Year 3", + "description": "Estimated PE ratio three fiscal years from now." }, - "excludes_technology": { + "year_4": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "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." + "title": "Year 4", + "description": "Estimated PE ratio four fiscal years from now." }, - "holds_only_nyse_stocks": { + "year_5": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Holds Only Nyse Stocks", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE." + "title": "Year 5", + "description": "Estimated PE ratio five fiscal years from now." }, - "holds_only_nasdaq_stocks": { + "peg_ratio_year_1": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Holds Only Nasdaq Stocks", - "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq." + "title": "Peg Ratio Year 1", + "description": "Estimated Forward PEG ratio for the next fiscal year." }, - "holds_mlp": { + "eps_ttm": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "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." + "title": "Eps Ttm", + "description": "The latest trailing twelve months earnings per share." }, - "holds_preferred_stock": { + "last_updated": { "anyOf": [ { - "type": "boolean" + "type": "string", + "format": "date" }, { "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." + "title": "Last Updated", + "description": "The date the data was last updated." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioForwardPeEstimatesData", + "description": "Intrinio Forward PE Estimates Data." + }, + "IntrinioForwardSalesEstimatesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "holds_closed_end_funds": { + "name": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "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." + "title": "Name", + "description": "Name of the entity." }, - "holds_adr": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "fiscal_year": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "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." + "title": "Fiscal Year", + "description": "Fiscal year for the estimate." }, - "laddered": { + "fiscal_period": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "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." + "title": "Fiscal Period", + "description": "Fiscal quarter for the estimate." }, - "zero_coupon": { + "calendar_year": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Zero Coupon", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills." + "title": "Calendar Year", + "description": "Calendar year for the estimate." }, - "floating_rate": { + "calendar_period": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Floating Rate", - "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds." + "title": "Calendar Period", + "description": "Calendar quarter for the estimate." }, - "build_america_bonds": { + "low_estimate": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Build America Bonds", - "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds." + "title": "Low Estimate", + "description": "The sales estimate low for the period." }, - "dynamic_futures_roll": { + "high_estimate": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "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." + "title": "High Estimate", + "description": "The sales estimate high for the period." }, - "currency_hedged": { + "mean": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Currency Hedged", - "description": "This field is populated if the ETF's strategy involves hedging currency exposure." + "title": "Mean", + "description": "The sales estimate mean for the period." }, - "includes_short_exposure": { + "median": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "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." + "title": "Median", + "description": "The sales estimate median for the period." }, - "ucits": { + "standard_deviation": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Ucits", - "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant" + "title": "Standard Deviation", + "description": "The sales estimate standard deviation for the period." }, - "registered_countries": { + "number_of_analysts": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Number Of Analysts", + "description": "Number of analysts providing estimates for the period." }, - "issuer_country": { + "revisions_1w_up": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Issuer Country", - "description": "2 letter ISO country code for the country where the issuer is located." + "title": "Revisions 1W Up", + "description": "Number of revisions up in the last week." }, - "domicile": { + "revisions_1w_down": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Domicile", - "description": "2 letter ISO country code for the country where the ETP is domiciled." + "title": "Revisions 1W Down", + "description": "Number of revisions down in the last week." }, - "listing_country": { + "revisions_1w_change_percent": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Listing Country", - "description": "2 letter ISO country code for the country of the primary listing." + "title": "Revisions 1W Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 1 week.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "listing_region": { + "revisions_1m_up": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Listing Region", - "description": "Geographic region in the country of the primary listing falls." + "title": "Revisions 1M Up", + "description": "Number of revisions up in the last month." }, - "bond_currency_denomination": { + "revisions_1m_down": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Bond Currency Denomination", - "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities." + "title": "Revisions 1M Down", + "description": "Number of revisions down in the last month." }, - "base_currency": { + "revisions_1m_change_percent": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Base Currency", - "description": "Base currency in which NAV is reported." + "title": "Revisions 1M Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 1 month.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "listing_currency": { + "revisions_3m_up": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "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." + "title": "Revisions 3M Up", + "description": "Number of revisions up in the last 3 months." }, - "number_of_holdings": { + "revisions_3m_down": { "anyOf": [ { "type": "integer" @@ -41963,10 +48858,10 @@ "type": "null" } ], - "title": "Number Of Holdings", - "description": "The number of holdings in the ETF." + "title": "Revisions 3M Down", + "description": "Number of revisions down in the last 3 months." }, - "month_end_assets": { + "revisions_3m_change_percent": { "anyOf": [ { "type": "number" @@ -41975,10 +48870,30 @@ "type": "null" } ], - "title": "Month End Assets", - "description": "Net assets in millions of dollars as of the most recent month end." + "title": "Revisions 3M Change Percent", + "description": "The analyst revisions percent change in estimate for the period of 3 months.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol", + "date" + ], + "title": "IntrinioForwardSalesEstimatesData", + "description": "Intrinio Forward Sales Estimates Data." + }, + "IntrinioFredSeriesData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." }, - "net_expense_ratio": { + "value": { "anyOf": [ { "type": "number" @@ -41987,12 +48902,44 @@ "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" + "title": "Value", + "description": "Value of the index." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "IntrinioFredSeriesData", + "description": "Intrinio FRED Series Data." + }, + "IntrinioHistoricalAttributesData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "The date of the data." + }, + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "tag": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Tag", + "description": "Tag name for the fetched data." }, - "etf_portfolio_turnover": { + "value": { "anyOf": [ { "type": "number" @@ -42001,25 +48948,45 @@ "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" + "title": "Value", + "description": "The value of the data." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol", - "name", - "inception_date" + "date", + "symbol" ], - "title": "IntrinioEtfInfo", - "description": "Intrinio ETF Info Data." + "title": "IntrinioHistoricalAttributesData", + "description": "Intrinio Historical Attributes Data." }, - "IntrinioEtfPricePerformance": { + "IntrinioHistoricalDividendsData": { "properties": { - "symbol": { + "ex_dividend_date": { + "type": "string", + "format": "date", + "title": "Ex Dividend Date", + "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." + }, + "amount": { + "type": "number", + "title": "Amount", + "description": "The dividend amount per share." + }, + "factor": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Factor", + "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices." + }, + "currency": { "anyOf": [ { "type": "string" @@ -42028,10 +48995,10 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Currency", + "description": "The currency in which the dividend is paid." }, - "one_day": { + "split_ratio": { "anyOf": [ { "type": "number" @@ -42040,54 +49007,64 @@ "type": "null" } ], - "title": "One Day", - "description": "One-day return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Split Ratio", + "description": "The ratio of the stock split, if a stock split occurred." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "ex_dividend_date", + "amount" + ], + "title": "IntrinioHistoricalDividendsData", + "description": "Intrinio Historical Dividends Data." + }, + "IntrinioIncomeStatementData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The end date of the reporting period." }, - "wtd": { + "fiscal_period": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Wtd", - "description": "Week to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Fiscal Period", + "description": "The fiscal period of the report." }, - "one_week": { + "fiscal_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "One Week", - "description": "One-week return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Fiscal Year", + "description": "The fiscal year of the fiscal period." }, - "mtd": { + "reported_currency": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Mtd", - "description": "Month to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Reported Currency", + "description": "The currency in which the balance sheet is reported." }, - "one_month": { + "revenue": { "anyOf": [ { "type": "number" @@ -42096,12 +49073,10 @@ "type": "null" } ], - "title": "One Month", - "description": "One-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Revenue", + "description": "Total revenue" }, - "qtd": { + "operating_revenue": { "anyOf": [ { "type": "number" @@ -42110,12 +49085,10 @@ "type": "null" } ], - "title": "Qtd", - "description": "Quarter to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Operating Revenue", + "description": "Total operating revenue" }, - "three_month": { + "cost_of_revenue": { "anyOf": [ { "type": "number" @@ -42124,12 +49097,10 @@ "type": "null" } ], - "title": "Three Month", - "description": "Three-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Cost Of Revenue", + "description": "Total cost of revenue" }, - "six_month": { + "operating_cost_of_revenue": { "anyOf": [ { "type": "number" @@ -42138,12 +49109,10 @@ "type": "null" } ], - "title": "Six Month", - "description": "Six-month return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Operating Cost Of Revenue", + "description": "Total operating cost of revenue" }, - "ytd": { + "gross_profit": { "anyOf": [ { "type": "number" @@ -42152,12 +49121,10 @@ "type": "null" } ], - "title": "Ytd", - "description": "Year to date return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Gross Profit", + "description": "Total gross profit" }, - "one_year": { + "gross_profit_margin": { "anyOf": [ { "type": "number" @@ -42166,12 +49133,10 @@ "type": "null" } ], - "title": "One Year", - "description": "One-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Gross Profit Margin", + "description": "Gross margin ratio." }, - "two_year": { + "provision_for_credit_losses": { "anyOf": [ { "type": "number" @@ -42180,12 +49145,10 @@ "type": "null" } ], - "title": "Two Year", - "description": "Two-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Provision For Credit Losses", + "description": "Provision for credit losses" }, - "three_year": { + "research_and_development_expense": { "anyOf": [ { "type": "number" @@ -42194,12 +49157,10 @@ "type": "null" } ], - "title": "Three Year", - "description": "Three-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Research And Development Expense", + "description": "Research and development expense" }, - "four_year": { + "selling_general_and_admin_expense": { "anyOf": [ { "type": "number" @@ -42208,12 +49169,10 @@ "type": "null" } ], - "title": "Four Year", - "description": "Four-year", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Selling General And Admin Expense", + "description": "Selling, general, and admin expense" }, - "five_year": { + "salaries_and_employee_benefits": { "anyOf": [ { "type": "number" @@ -42222,12 +49181,10 @@ "type": "null" } ], - "title": "Five Year", - "description": "Five-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Salaries And Employee Benefits", + "description": "Salaries and employee benefits" }, - "ten_year": { + "marketing_expense": { "anyOf": [ { "type": "number" @@ -42236,12 +49193,10 @@ "type": "null" } ], - "title": "Ten Year", - "description": "Ten-year return.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Marketing Expense", + "description": "Marketing expense" }, - "max": { + "net_occupancy_and_equipment_expense": { "anyOf": [ { "type": "number" @@ -42250,12 +49205,10 @@ "type": "null" } ], - "title": "Max", - "description": "Return from the beginning of the time series.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Net Occupancy And Equipment Expense", + "description": "Net occupancy and equipment expense" }, - "max_annualized": { + "other_operating_expenses": { "anyOf": [ { "type": "number" @@ -42264,12 +49217,10 @@ "type": "null" } ], - "title": "Max Annualized", - "description": "Annualized rate of return from inception.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Other Operating Expenses", + "description": "Other operating expenses" }, - "volatility_one_year": { + "depreciation_expense": { "anyOf": [ { "type": "number" @@ -42278,12 +49229,10 @@ "type": "null" } ], - "title": "Volatility One Year", - "description": "Trailing one-year annualized volatility.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Depreciation Expense", + "description": "Depreciation expense" }, - "volatility_three_year": { + "amortization_expense": { "anyOf": [ { "type": "number" @@ -42292,12 +49241,10 @@ "type": "null" } ], - "title": "Volatility Three Year", - "description": "Trailing three-year annualized volatility.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Amortization Expense", + "description": "Amortization expense" }, - "volatility_five_year": { + "amortization_of_deferred_policy_acquisition_costs": { "anyOf": [ { "type": "number" @@ -42306,24 +49253,22 @@ "type": "null" } ], - "title": "Volatility Five Year", - "description": "Trailing five-year annualized volatility.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Amortization Of Deferred Policy Acquisition Costs", + "description": "Amortization of deferred policy acquisition costs" }, - "volume": { + "exploration_expense": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Exploration Expense", + "description": "Exploration expense" }, - "volume_avg_30": { + "depletion_expense": { "anyOf": [ { "type": "number" @@ -42332,10 +49277,10 @@ "type": "null" } ], - "title": "Volume Avg 30", - "description": "The one-month average daily volume." + "title": "Depletion Expense", + "description": "Depletion expense" }, - "volume_avg_90": { + "total_operating_expenses": { "anyOf": [ { "type": "number" @@ -42344,10 +49289,10 @@ "type": "null" } ], - "title": "Volume Avg 90", - "description": "The three-month average daily volume." + "title": "Total Operating Expenses", + "description": "Total operating expenses" }, - "volume_avg_180": { + "total_operating_income": { "anyOf": [ { "type": "number" @@ -42356,10 +49301,10 @@ "type": "null" } ], - "title": "Volume Avg 180", - "description": "The six-month average daily volume." + "title": "Total Operating Income", + "description": "Total operating income" }, - "beta": { + "deposits_and_money_market_investments_interest_income": { "anyOf": [ { "type": "number" @@ -42368,10 +49313,10 @@ "type": "null" } ], - "title": "Beta", - "description": "Beta compared to the S&P 500." + "title": "Deposits And Money Market Investments Interest Income", + "description": "Deposits and money market investments interest income" }, - "nav": { + "federal_funds_sold_and_securities_borrowed_interest_income": { "anyOf": [ { "type": "number" @@ -42380,10 +49325,10 @@ "type": "null" } ], - "title": "Nav", - "description": "Net asset value per share." + "title": "Federal Funds Sold And Securities Borrowed Interest Income", + "description": "Federal funds sold and securities borrowed interest income" }, - "year_high": { + "investment_securities_interest_income": { "anyOf": [ { "type": "number" @@ -42392,10 +49337,10 @@ "type": "null" } ], - "title": "Year High", - "description": "The 52-week high price." + "title": "Investment Securities Interest Income", + "description": "Investment securities interest income" }, - "year_low": { + "loans_and_leases_interest_income": { "anyOf": [ { "type": "number" @@ -42404,10 +49349,10 @@ "type": "null" } ], - "title": "Year Low", - "description": "The 52-week low price." + "title": "Loans And Leases Interest Income", + "description": "Loans and leases interest income" }, - "market_cap": { + "trading_account_interest_income": { "anyOf": [ { "type": "number" @@ -42416,183 +49361,130 @@ "type": "null" } ], - "title": "Market Cap", - "description": "The market capitalization." + "title": "Trading Account Interest Income", + "description": "Trading account interest income" }, - "shares_outstanding": { + "other_interest_income": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Shares Outstanding", - "description": "The number of shares outstanding." + "title": "Other Interest Income", + "description": "Other interest income" }, - "updated": { + "total_non_interest_income": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "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)" + "title": "Total Non Interest Income", + "description": "Total non-interest income" }, - "name": { + "interest_and_investment_income": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the ETF." + "title": "Interest And Investment Income", + "description": "Interest and investment income" }, - "exchange": { + "short_term_borrowings_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Exchange", - "description": "The exchange MIC code." + "title": "Short Term Borrowings Interest Expense", + "description": "Short-term borrowings interest expense" }, - "figi_ticker": { + "long_term_debt_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Figi Ticker", - "description": "The OpenFIGI ticker." + "title": "Long Term Debt Interest Expense", + "description": "Long-term debt interest expense" }, - "ric": { + "capitalized_lease_obligations_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Ric", - "description": "The Reuters Instrument Code." + "title": "Capitalized Lease Obligations Interest Expense", + "description": "Capitalized lease obligations interest expense" }, - "isin": { + "deposits_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Isin", - "description": "The International Securities Identification Number." + "title": "Deposits Interest Expense", + "description": "Deposits interest expense" }, - "sedol": { + "federal_funds_purchased_and_securities_sold_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Sedol", - "description": "The Stock Exchange Daily Official List." + "title": "Federal Funds Purchased And Securities Sold Interest Expense", + "description": "Federal funds purchased and securities sold interest expense" }, - "intrinio_id": { + "other_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "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": { - "type": "string", - "title": "Period Ending", - "description": "The date of the data." - }, - "fiscal_period": { - "type": "string", - "title": "Fiscal Period", - "description": "Period of the financial ratios." + "title": "Other Interest Expense", + "description": "Other interest expense" }, - "fiscal_year": { + "total_interest_expense": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "Fiscal year." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending", - "fiscal_period" - ], - "title": "IntrinioFinancialRatios", - "description": "Intrinio Financial Ratios Data." - }, - "IntrinioFredSeries": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." + "title": "Total Interest Expense", + "description": "Total interest expense" }, - "value": { + "net_interest_income": { "anyOf": [ { "type": "number" @@ -42601,44 +49493,22 @@ "type": "null" } ], - "title": "Value", - "description": "Value of the index." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "IntrinioFredSeries", - "description": "Intrinio FRED Series Data." - }, - "IntrinioHistoricalAttributes": { - "properties": { - "date": { - "type": "string", - "format": "date", - "title": "Date", - "description": "The date of the data." - }, - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Net Interest Income", + "description": "Net interest income" }, - "tag": { + "other_non_interest_income": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Tag", - "description": "Tag name for the fetched data." + "title": "Other Non Interest Income", + "description": "Other non-interest income" }, - "value": { + "investment_banking_income": { "anyOf": [ { "type": "number" @@ -42647,33 +49517,10 @@ "type": "null" } ], - "title": "Value", - "description": "The value of the data." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date", - "symbol" - ], - "title": "IntrinioHistoricalAttributes", - "description": "Intrinio Historical Attributes Data." - }, - "IntrinioHistoricalDividends": { - "properties": { - "ex_dividend_date": { - "type": "string", - "format": "date", - "title": "Ex Dividend Date", - "description": "The ex-dividend date - the date on which the stock begins trading without rights to the dividend." - }, - "amount": { - "type": "number", - "title": "Amount", - "description": "The dividend amount per share." + "title": "Investment Banking Income", + "description": "Investment banking income" }, - "factor": { + "trust_fees_by_commissions": { "anyOf": [ { "type": "number" @@ -42682,22 +49529,22 @@ "type": "null" } ], - "title": "Factor", - "description": "factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices." + "title": "Trust Fees By Commissions", + "description": "Trust fees by commissions" }, - "currency": { + "premiums_earned": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Currency", - "description": "The currency in which the dividend is paid." + "title": "Premiums Earned", + "description": "Premiums earned" }, - "split_ratio": { + "insurance_policy_acquisition_costs": { "anyOf": [ { "type": "number" @@ -42706,64 +49553,46 @@ "type": "null" } ], - "title": "Split Ratio", - "description": "The ratio of the stock split, if a stock split occurred." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "ex_dividend_date", - "amount" - ], - "title": "IntrinioHistoricalDividends", - "description": "Intrinio Historical Dividends Data." - }, - "IntrinioIncomeStatement": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The end date of the reporting period." + "title": "Insurance Policy Acquisition Costs", + "description": "Insurance policy acquisition costs" }, - "fiscal_period": { + "current_and_future_benefits": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Period", - "description": "The fiscal period of the report." + "title": "Current And Future Benefits", + "description": "Current and future benefits" }, - "fiscal_year": { + "property_and_liability_insurance_claims": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." + "title": "Property And Liability Insurance Claims", + "description": "Property and liability insurance claims" }, - "reported_currency": { + "total_non_interest_expense": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Reported Currency", - "description": "The currency in which the balance sheet is reported." + "title": "Total Non Interest Expense", + "description": "Total non-interest expense" }, - "revenue": { + "net_realized_and_unrealized_capital_gains_on_investments": { "anyOf": [ { "type": "number" @@ -42772,10 +49601,10 @@ "type": "null" } ], - "title": "Revenue", - "description": "Total revenue" + "title": "Net Realized And Unrealized Capital Gains On Investments", + "description": "Net realized and unrealized capital gains on investments" }, - "operating_revenue": { + "other_gains": { "anyOf": [ { "type": "number" @@ -42784,10 +49613,10 @@ "type": "null" } ], - "title": "Operating Revenue", - "description": "Total operating revenue" + "title": "Other Gains", + "description": "Other gains" }, - "cost_of_revenue": { + "non_operating_income": { "anyOf": [ { "type": "number" @@ -42796,10 +49625,10 @@ "type": "null" } ], - "title": "Cost Of Revenue", - "description": "Total cost of revenue" + "title": "Non Operating Income", + "description": "Non-operating income" }, - "operating_cost_of_revenue": { + "other_income": { "anyOf": [ { "type": "number" @@ -42808,10 +49637,10 @@ "type": "null" } ], - "title": "Operating Cost Of Revenue", - "description": "Total operating cost of revenue" + "title": "Other Income", + "description": "Other income" }, - "gross_profit": { + "other_revenue": { "anyOf": [ { "type": "number" @@ -42820,10 +49649,10 @@ "type": "null" } ], - "title": "Gross Profit", - "description": "Total gross profit" + "title": "Other Revenue", + "description": "Other revenue" }, - "gross_profit_margin": { + "extraordinary_income": { "anyOf": [ { "type": "number" @@ -42832,10 +49661,10 @@ "type": "null" } ], - "title": "Gross Profit Margin", - "description": "Gross margin ratio." + "title": "Extraordinary Income", + "description": "Extraordinary income" }, - "provision_for_credit_losses": { + "total_other_income": { "anyOf": [ { "type": "number" @@ -42844,10 +49673,10 @@ "type": "null" } ], - "title": "Provision For Credit Losses", - "description": "Provision for credit losses" + "title": "Total Other Income", + "description": "Total other income" }, - "research_and_development_expense": { + "ebitda": { "anyOf": [ { "type": "number" @@ -42856,10 +49685,10 @@ "type": "null" } ], - "title": "Research And Development Expense", - "description": "Research and development expense" + "title": "Ebitda", + "description": "Earnings Before Interest, Taxes, Depreciation and Amortization." }, - "selling_general_and_admin_expense": { + "ebitda_margin": { "anyOf": [ { "type": "number" @@ -42868,10 +49697,10 @@ "type": "null" } ], - "title": "Selling General And Admin Expense", - "description": "Selling, general, and admin expense" + "title": "Ebitda Margin", + "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization." }, - "salaries_and_employee_benefits": { + "total_pre_tax_income": { "anyOf": [ { "type": "number" @@ -42880,10 +49709,10 @@ "type": "null" } ], - "title": "Salaries And Employee Benefits", - "description": "Salaries and employee benefits" + "title": "Total Pre Tax Income", + "description": "Total pre-tax income" }, - "marketing_expense": { + "ebit": { "anyOf": [ { "type": "number" @@ -42892,10 +49721,10 @@ "type": "null" } ], - "title": "Marketing Expense", - "description": "Marketing expense" + "title": "Ebit", + "description": "Earnings Before Interest and Taxes." }, - "net_occupancy_and_equipment_expense": { + "pre_tax_income_margin": { "anyOf": [ { "type": "number" @@ -42904,10 +49733,10 @@ "type": "null" } ], - "title": "Net Occupancy And Equipment Expense", - "description": "Net occupancy and equipment expense" + "title": "Pre Tax Income Margin", + "description": "Pre-Tax Income Margin." }, - "other_operating_expenses": { + "income_tax_expense": { "anyOf": [ { "type": "number" @@ -42916,10 +49745,10 @@ "type": "null" } ], - "title": "Other Operating Expenses", - "description": "Other operating expenses" + "title": "Income Tax Expense", + "description": "Income tax expense" }, - "depreciation_expense": { + "impairment_charge": { "anyOf": [ { "type": "number" @@ -42928,10 +49757,10 @@ "type": "null" } ], - "title": "Depreciation Expense", - "description": "Depreciation expense" + "title": "Impairment Charge", + "description": "Impairment charge" }, - "amortization_expense": { + "restructuring_charge": { "anyOf": [ { "type": "number" @@ -42940,10 +49769,10 @@ "type": "null" } ], - "title": "Amortization Expense", - "description": "Amortization expense" + "title": "Restructuring Charge", + "description": "Restructuring charge" }, - "amortization_of_deferred_policy_acquisition_costs": { + "service_charges_on_deposit_accounts": { "anyOf": [ { "type": "number" @@ -42952,10 +49781,10 @@ "type": "null" } ], - "title": "Amortization Of Deferred Policy Acquisition Costs", - "description": "Amortization of deferred policy acquisition costs" + "title": "Service Charges On Deposit Accounts", + "description": "Service charges on deposit accounts" }, - "exploration_expense": { + "other_service_charges": { "anyOf": [ { "type": "number" @@ -42964,10 +49793,10 @@ "type": "null" } ], - "title": "Exploration Expense", - "description": "Exploration expense" + "title": "Other Service Charges", + "description": "Other service charges" }, - "depletion_expense": { + "other_special_charges": { "anyOf": [ { "type": "number" @@ -42976,10 +49805,10 @@ "type": "null" } ], - "title": "Depletion Expense", - "description": "Depletion expense" + "title": "Other Special Charges", + "description": "Other special charges" }, - "total_operating_expenses": { + "other_cost_of_revenue": { "anyOf": [ { "type": "number" @@ -42988,10 +49817,10 @@ "type": "null" } ], - "title": "Total Operating Expenses", - "description": "Total operating expenses" + "title": "Other Cost Of Revenue", + "description": "Other cost of revenue" }, - "total_operating_income": { + "net_income_continuing_operations": { "anyOf": [ { "type": "number" @@ -43000,10 +49829,10 @@ "type": "null" } ], - "title": "Total Operating Income", - "description": "Total operating income" + "title": "Net Income Continuing Operations", + "description": "Net income (continuing operations)" }, - "deposits_and_money_market_investments_interest_income": { + "net_income_discontinued_operations": { "anyOf": [ { "type": "number" @@ -43012,10 +49841,10 @@ "type": "null" } ], - "title": "Deposits And Money Market Investments Interest Income", - "description": "Deposits and money market investments interest income" + "title": "Net Income Discontinued Operations", + "description": "Net income (discontinued operations)" }, - "federal_funds_sold_and_securities_borrowed_interest_income": { + "consolidated_net_income": { "anyOf": [ { "type": "number" @@ -43024,10 +49853,10 @@ "type": "null" } ], - "title": "Federal Funds Sold And Securities Borrowed Interest Income", - "description": "Federal funds sold and securities borrowed interest income" + "title": "Consolidated Net Income", + "description": "Consolidated net income" }, - "investment_securities_interest_income": { + "other_adjustments_to_consolidated_net_income": { "anyOf": [ { "type": "number" @@ -43036,10 +49865,10 @@ "type": "null" } ], - "title": "Investment Securities Interest Income", - "description": "Investment securities interest income" + "title": "Other Adjustments To Consolidated Net Income", + "description": "Other adjustments to consolidated net income" }, - "loans_and_leases_interest_income": { + "other_adjustment_to_net_income_attributable_to_common_shareholders": { "anyOf": [ { "type": "number" @@ -43048,10 +49877,10 @@ "type": "null" } ], - "title": "Loans And Leases Interest Income", - "description": "Loans and leases interest income" + "title": "Other Adjustment To Net Income Attributable To Common Shareholders", + "description": "Other adjustment to net income attributable to common shareholders" }, - "trading_account_interest_income": { + "net_income_attributable_to_noncontrolling_interest": { "anyOf": [ { "type": "number" @@ -43060,10 +49889,10 @@ "type": "null" } ], - "title": "Trading Account Interest Income", - "description": "Trading account interest income" + "title": "Net Income Attributable To Noncontrolling Interest", + "description": "Net income attributable to noncontrolling interest" }, - "other_interest_income": { + "net_income_attributable_to_common_shareholders": { "anyOf": [ { "type": "number" @@ -43072,10 +49901,10 @@ "type": "null" } ], - "title": "Other Interest Income", - "description": "Other interest income" + "title": "Net Income Attributable To Common Shareholders", + "description": "Net income attributable to common shareholders" }, - "total_non_interest_income": { + "basic_earnings_per_share": { "anyOf": [ { "type": "number" @@ -43084,10 +49913,10 @@ "type": "null" } ], - "title": "Total Non Interest Income", - "description": "Total non-interest income" + "title": "Basic Earnings Per Share", + "description": "Basic earnings per share" }, - "interest_and_investment_income": { + "diluted_earnings_per_share": { "anyOf": [ { "type": "number" @@ -43096,10 +49925,10 @@ "type": "null" } ], - "title": "Interest And Investment Income", - "description": "Interest and investment income" + "title": "Diluted Earnings Per Share", + "description": "Diluted earnings per share" }, - "short_term_borrowings_interest_expense": { + "basic_and_diluted_earnings_per_share": { "anyOf": [ { "type": "number" @@ -43108,10 +49937,10 @@ "type": "null" } ], - "title": "Short Term Borrowings Interest Expense", - "description": "Short-term borrowings interest expense" + "title": "Basic And Diluted Earnings Per Share", + "description": "Basic and diluted earnings per share" }, - "long_term_debt_interest_expense": { + "cash_dividends_to_common_per_share": { "anyOf": [ { "type": "number" @@ -43120,10 +49949,10 @@ "type": "null" } ], - "title": "Long Term Debt Interest Expense", - "description": "Long-term debt interest expense" + "title": "Cash Dividends To Common Per Share", + "description": "Cash dividends to common per share" }, - "capitalized_lease_obligations_interest_expense": { + "preferred_stock_dividends_declared": { "anyOf": [ { "type": "number" @@ -43132,10 +49961,10 @@ "type": "null" } ], - "title": "Capitalized Lease Obligations Interest Expense", - "description": "Capitalized lease obligations interest expense" + "title": "Preferred Stock Dividends Declared", + "description": "Preferred stock dividends declared" }, - "deposits_interest_expense": { + "weighted_average_basic_shares_outstanding": { "anyOf": [ { "type": "number" @@ -43144,10 +49973,10 @@ "type": "null" } ], - "title": "Deposits Interest Expense", - "description": "Deposits interest expense" + "title": "Weighted Average Basic Shares Outstanding", + "description": "Weighted average basic shares outstanding" }, - "federal_funds_purchased_and_securities_sold_interest_expense": { + "weighted_average_diluted_shares_outstanding": { "anyOf": [ { "type": "number" @@ -43156,10 +49985,10 @@ "type": "null" } ], - "title": "Federal Funds Purchased And Securities Sold Interest Expense", - "description": "Federal funds purchased and securities sold interest expense" + "title": "Weighted Average Diluted Shares Outstanding", + "description": "Weighted average diluted shares outstanding" }, - "other_interest_expense": { + "weighted_average_basic_and_diluted_shares_outstanding": { "anyOf": [ { "type": "number" @@ -43168,22 +49997,35 @@ "type": "null" } ], - "title": "Other Interest Expense", - "description": "Other interest expense" - }, - "total_interest_expense": { + "title": "Weighted Average Basic And Diluted Shares Outstanding", + "description": "Weighted average basic and diluted shares outstanding" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending" + ], + "title": "IntrinioIncomeStatementData", + "description": "Intrinio Income Statement Data." + }, + "IntrinioIndexHistoricalData": { + "properties": { + "date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { - "type": "null" + "type": "string", + "format": "date-time" } ], - "title": "Total Interest Expense", - "description": "Total interest expense" + "title": "Date", + "description": "The date of the data." }, - "net_interest_income": { + "open": { "anyOf": [ { "type": "number" @@ -43192,10 +50034,10 @@ "type": "null" } ], - "title": "Net Interest Income", - "description": "Net interest income" + "title": "Open", + "description": "The open price." }, - "other_non_interest_income": { + "high": { "anyOf": [ { "type": "number" @@ -43204,10 +50046,10 @@ "type": "null" } ], - "title": "Other Non Interest Income", - "description": "Other non-interest income" + "title": "High", + "description": "The high price." }, - "investment_banking_income": { + "low": { "anyOf": [ { "type": "number" @@ -43216,10 +50058,10 @@ "type": "null" } ], - "title": "Investment Banking Income", - "description": "Investment banking income" + "title": "Low", + "description": "The low price." }, - "trust_fees_by_commissions": { + "close": { "anyOf": [ { "type": "number" @@ -43228,142 +50070,165 @@ "type": "null" } ], - "title": "Trust Fees By Commissions", - "description": "Trust fees by commissions" + "title": "Close", + "description": "The close price." }, - "premiums_earned": { + "volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Premiums Earned", - "description": "Premiums earned" - }, - "insurance_policy_acquisition_costs": { + "title": "Volume", + "description": "The trading volume." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date" + ], + "title": "IntrinioIndexHistoricalData", + "description": "Intrinio Index Historical Data." + }, + "IntrinioInsiderTradingData": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Insurance Policy Acquisition Costs", - "description": "Insurance policy acquisition costs" + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "current_and_future_benefits": { + "company_cik": { "anyOf": [ { - "type": "number" + "type": "integer" + }, + { + "type": "string" }, { "type": "null" } ], - "title": "Current And Future Benefits", - "description": "Current and future benefits" + "title": "Company Cik", + "description": "CIK number of the company." }, - "property_and_liability_insurance_claims": { + "filing_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" + }, + { + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Property And Liability Insurance Claims", - "description": "Property and liability insurance claims" + "title": "Filing Date", + "description": "Filing date of the trade." }, - "total_non_interest_expense": { + "transaction_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Total Non Interest Expense", - "description": "Total non-interest expense" + "title": "Transaction Date", + "description": "Date of the transaction." }, - "net_realized_and_unrealized_capital_gains_on_investments": { + "owner_cik": { "anyOf": [ { - "type": "number" + "type": "integer" + }, + { + "type": "string" }, { "type": "null" } ], - "title": "Net Realized And Unrealized Capital Gains On Investments", - "description": "Net realized and unrealized capital gains on investments" + "title": "Owner Cik", + "description": "Reporting individual's CIK." }, - "other_gains": { + "owner_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Gains", - "description": "Other gains" + "title": "Owner Name", + "description": "Name of the reporting individual." }, - "non_operating_income": { + "owner_title": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Non Operating Income", - "description": "Non-operating income" + "title": "Owner Title", + "description": "The title held by the reporting individual." }, - "other_income": { + "transaction_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Income", - "description": "Other income" + "title": "Transaction Type", + "description": "Type of transaction being reported." }, - "other_revenue": { + "acquisition_or_disposition": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Revenue", - "description": "Other revenue" + "title": "Acquisition Or Disposition", + "description": "Acquisition or disposition of the shares." }, - "extraordinary_income": { + "security_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Extraordinary Income", - "description": "Extraordinary income" + "title": "Security Type", + "description": "The type of security transacted." }, - "total_other_income": { + "securities_owned": { "anyOf": [ { "type": "number" @@ -43372,10 +50237,10 @@ "type": "null" } ], - "title": "Total Other Income", - "description": "Total other income" + "title": "Securities Owned", + "description": "Number of securities owned by the reporting individual." }, - "ebitda": { + "securities_transacted": { "anyOf": [ { "type": "number" @@ -43384,10 +50249,10 @@ "type": "null" } ], - "title": "Ebitda", - "description": "Earnings Before Interest, Taxes, Depreciation and Amortization." + "title": "Securities Transacted", + "description": "Number of securities transacted by the reporting individual." }, - "ebitda_margin": { + "transaction_price": { "anyOf": [ { "type": "number" @@ -43396,22 +50261,27 @@ "type": "null" } ], - "title": "Ebitda Margin", - "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization." + "title": "Transaction Price", + "description": "The price of the transaction." }, - "total_pre_tax_income": { + "filing_url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Total Pre Tax Income", - "description": "Total pre-tax income" + "title": "Filing Url", + "description": "URL of the filing." }, - "ebit": { + "company_name": { + "type": "string", + "title": "Company Name", + "description": "Name of the company." + }, + "conversion_exercise_price": { "anyOf": [ { "type": "number" @@ -43420,59 +50290,65 @@ "type": "null" } ], - "title": "Ebit", - "description": "Earnings Before Interest and Taxes." + "title": "Conversion Exercise Price", + "description": "Conversion/Exercise price of the shares." }, - "pre_tax_income_margin": { + "deemed_execution_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Pre Tax Income Margin", - "description": "Pre-Tax Income Margin." + "title": "Deemed Execution Date", + "description": "Deemed execution date of the trade." }, - "income_tax_expense": { + "exercise_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Income Tax Expense", - "description": "Income tax expense" + "title": "Exercise Date", + "description": "Exercise date of the trade." }, - "impairment_charge": { + "expiration_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Impairment Charge", - "description": "Impairment charge" + "title": "Expiration Date", + "description": "Expiration date of the derivative." }, - "restructuring_charge": { + "underlying_security_title": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Restructuring Charge", - "description": "Restructuring charge" + "title": "Underlying Security Title", + "description": "Name of the underlying non-derivative security related to this derivative transaction." }, - "service_charges_on_deposit_accounts": { + "underlying_shares": { "anyOf": [ + { + "type": "integer" + }, { "type": "number" }, @@ -43480,106 +50356,117 @@ "type": "null" } ], - "title": "Service Charges On Deposit Accounts", - "description": "Service charges on deposit accounts" + "title": "Underlying Shares", + "description": "Number of underlying shares related to this derivative transaction." }, - "other_service_charges": { + "nature_of_ownership": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Service Charges", - "description": "Other service charges" + "title": "Nature Of Ownership", + "description": "Nature of ownership of the insider trading." }, - "other_special_charges": { + "director": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Other Special Charges", - "description": "Other special charges" + "title": "Director", + "description": "Whether the owner is a director." }, - "other_cost_of_revenue": { + "officer": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Other Cost Of Revenue", - "description": "Other cost of revenue" + "title": "Officer", + "description": "Whether the owner is an officer." }, - "net_income_continuing_operations": { + "ten_percent_owner": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Net Income Continuing Operations", - "description": "Net income (continuing operations)" + "title": "Ten Percent Owner", + "description": "Whether the owner is a 10% owner." }, - "net_income_discontinued_operations": { + "other_relation": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Net Income Discontinued Operations", - "description": "Net income (discontinued operations)" + "title": "Other Relation", + "description": "Whether the owner is having another relation." }, - "consolidated_net_income": { + "derivative_transaction": { "anyOf": [ { - "type": "number" + "type": "boolean" }, { "type": "null" } ], - "title": "Consolidated Net Income", - "description": "Consolidated net income" + "title": "Derivative Transaction", + "description": "Whether the owner is having a derivative transaction." }, - "other_adjustments_to_consolidated_net_income": { + "report_line_number": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Other Adjustments To Consolidated Net Income", - "description": "Other adjustments to consolidated net income" - }, - "other_adjustment_to_net_income_attributable_to_common_shareholders": { + "title": "Report Line Number", + "description": "Report line number of the insider trading." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "company_name" + ], + "title": "IntrinioInsiderTradingData", + "description": "Intrinio Insider Trading Data." + }, + "IntrinioKeyMetricsData": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Other Adjustment To Net Income Attributable To Common Shareholders", - "description": "Other adjustment to net income attributable to common shareholders" + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "net_income_attributable_to_noncontrolling_interest": { + "market_cap": { "anyOf": [ { "type": "number" @@ -43588,10 +50475,10 @@ "type": "null" } ], - "title": "Net Income Attributable To Noncontrolling Interest", - "description": "Net income attributable to noncontrolling interest" + "title": "Market Cap", + "description": "Market capitalization" }, - "net_income_attributable_to_common_shareholders": { + "pe_ratio": { "anyOf": [ { "type": "number" @@ -43600,10 +50487,10 @@ "type": "null" } ], - "title": "Net Income Attributable To Common Shareholders", - "description": "Net income attributable to common shareholders" + "title": "Pe Ratio", + "description": "Price-to-earnings ratio (P/E ratio)" }, - "basic_earnings_per_share": { + "price_to_book": { "anyOf": [ { "type": "number" @@ -43612,10 +50499,10 @@ "type": "null" } ], - "title": "Basic Earnings Per Share", - "description": "Basic earnings per share" + "title": "Price To Book", + "description": "Price to book ratio." }, - "diluted_earnings_per_share": { + "price_to_tangible_book": { "anyOf": [ { "type": "number" @@ -43624,10 +50511,10 @@ "type": "null" } ], - "title": "Diluted Earnings Per Share", - "description": "Diluted earnings per share" + "title": "Price To Tangible Book", + "description": "Price to tangible book ratio." }, - "basic_and_diluted_earnings_per_share": { + "price_to_revenue": { "anyOf": [ { "type": "number" @@ -43636,10 +50523,10 @@ "type": "null" } ], - "title": "Basic And Diluted Earnings Per Share", - "description": "Basic and diluted earnings per share" + "title": "Price To Revenue", + "description": "Price to revenue ratio." }, - "cash_dividends_to_common_per_share": { + "quick_ratio": { "anyOf": [ { "type": "number" @@ -43648,10 +50535,10 @@ "type": "null" } ], - "title": "Cash Dividends To Common Per Share", - "description": "Cash dividends to common per share" + "title": "Quick Ratio", + "description": "Quick ratio." }, - "preferred_stock_dividends_declared": { + "gross_margin": { "anyOf": [ { "type": "number" @@ -43660,10 +50547,12 @@ "type": "null" } ], - "title": "Preferred Stock Dividends Declared", - "description": "Preferred stock dividends declared" + "title": "Gross Margin", + "description": "Gross margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "weighted_average_basic_shares_outstanding": { + "ebit_margin": { "anyOf": [ { "type": "number" @@ -43672,10 +50561,12 @@ "type": "null" } ], - "title": "Weighted Average Basic Shares Outstanding", - "description": "Weighted average basic shares outstanding" + "title": "Ebit Margin", + "description": "EBIT margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "weighted_average_diluted_shares_outstanding": { + "profit_margin": { "anyOf": [ { "type": "number" @@ -43684,10 +50575,12 @@ "type": "null" } ], - "title": "Weighted Average Diluted Shares Outstanding", - "description": "Weighted average diluted shares outstanding" + "title": "Profit Margin", + "description": "Profit margin, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "weighted_average_basic_and_diluted_shares_outstanding": { + "eps": { "anyOf": [ { "type": "number" @@ -43696,35 +50589,24 @@ "type": "null" } ], - "title": "Weighted Average Basic And Diluted Shares Outstanding", - "description": "Weighted average basic and diluted shares outstanding" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending" - ], - "title": "IntrinioIncomeStatement", - "description": "Intrinio Income Statement Data." - }, - "IntrinioIndexHistorical": { - "properties": { - "date": { + "title": "Eps", + "description": "Basic earnings per share." + }, + "eps_growth": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { - "type": "string", - "format": "date-time" + "type": "null" } ], - "title": "Date", - "description": "The date of the data." + "title": "Eps Growth", + "description": "EPS growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "open": { + "revenue_growth": { "anyOf": [ { "type": "number" @@ -43733,10 +50615,12 @@ "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Revenue Growth", + "description": "Revenue growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "high": { + "ebitda_growth": { "anyOf": [ { "type": "number" @@ -43745,10 +50629,12 @@ "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Ebitda Growth", + "description": "EBITDA growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "low": { + "ebit_growth": { "anyOf": [ { "type": "number" @@ -43757,10 +50643,12 @@ "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Ebit Growth", + "description": "EBIT growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "close": { + "net_income_growth": { "anyOf": [ { "type": "number" @@ -43769,177 +50657,166 @@ "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Net Income Growth", + "description": "Net income growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "volume": { + "free_cash_flow_to_firm_growth": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "date" - ], - "title": "IntrinioIndexHistorical", - "description": "Intrinio Index Historical Data." - }, - "IntrinioInsiderTrading": { - "properties": { - "symbol": { + "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": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Invested Capital Growth", + "description": "Invested capital growth, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "company_cik": { + "return_on_assets": { "anyOf": [ { - "type": "integer" - }, - { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Company Cik", - "description": "CIK number of the company." + "title": "Return On Assets", + "description": "Return on assets, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "filing_date": { + "return_on_equity": { "anyOf": [ { - "type": "string", - "format": "date" - }, - { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Filing Date", - "description": "Filing date of the trade." + "title": "Return On Equity", + "description": "Return on equity, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "transaction_date": { + "return_on_invested_capital": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Transaction Date", - "description": "Date of the transaction." + "title": "Return On Invested Capital", + "description": "Return on invested capital, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "owner_cik": { + "ebitda": { "anyOf": [ { "type": "integer" }, - { - "type": "string" - }, { "type": "null" } ], - "title": "Owner Cik", - "description": "Reporting individual's CIK." + "title": "Ebitda", + "description": "Earnings before interest, taxes, depreciation, and amortization." }, - "owner_name": { + "ebit": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Owner Name", - "description": "Name of the reporting individual." + "title": "Ebit", + "description": "Earnings before interest and taxes." }, - "owner_title": { + "long_term_debt": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Owner Title", - "description": "The title held by the reporting individual." + "title": "Long Term Debt", + "description": "Long-term debt." }, - "transaction_type": { + "total_debt": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Transaction Type", - "description": "Type of transaction being reported." + "title": "Total Debt", + "description": "Total debt." }, - "acquisition_or_disposition": { + "total_capital": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Acquisition Or Disposition", - "description": "Acquisition or disposition of the shares." + "title": "Total Capital", + "description": "The sum of long-term debt and total shareholder equity." }, - "security_type": { + "enterprise_value": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Security Type", - "description": "The type of security transacted." + "title": "Enterprise Value", + "description": "Enterprise value." }, - "securities_owned": { + "free_cash_flow_to_firm": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Securities Owned", - "description": "Number of securities owned by the reporting individual." + "title": "Free Cash Flow To Firm", + "description": "Free cash flow to firm." }, - "securities_transacted": { + "altman_z_score": { "anyOf": [ { "type": "number" @@ -43948,10 +50825,10 @@ "type": "null" } ], - "title": "Securities Transacted", - "description": "Number of securities transacted by the reporting individual." + "title": "Altman Z Score", + "description": "Altman Z-score." }, - "transaction_price": { + "beta": { "anyOf": [ { "type": "number" @@ -43960,27 +50837,24 @@ "type": "null" } ], - "title": "Transaction Price", - "description": "The price of the transaction." + "title": "Beta", + "description": "Beta relative to the broad market (rolling three-year)." }, - "filing_url": { + "dividend_yield": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Filing Url", - "description": "URL of the filing." - }, - "company_name": { - "type": "string", - "title": "Company Name", - "description": "Name of the company." + "title": "Dividend Yield", + "description": "Dividend yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "conversion_exercise_price": { + "earnings_yield": { "anyOf": [ { "type": "number" @@ -43989,65 +50863,66 @@ "type": "null" } ], - "title": "Conversion Exercise Price", - "description": "Conversion/Exercise price of the shares." + "title": "Earnings Yield", + "description": "Earnings yield, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "deemed_execution_date": { + "last_price": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Deemed Execution Date", - "description": "Deemed execution date of the trade." + "title": "Last Price", + "description": "Last price of the stock." }, - "exercise_date": { + "year_high": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Exercise Date", - "description": "Exercise date of the trade." + "title": "Year High", + "description": "52 week high" }, - "expiration_date": { + "year_low": { + "type": "number", + "title": "Year Low", + "description": "52 week low" + }, + "volume_avg": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "integer" }, { "type": "null" } ], - "title": "Expiration Date", - "description": "Expiration date of the derivative." + "title": "Volume Avg", + "description": "Average daily volume." }, - "underlying_security_title": { + "short_interest": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Underlying Security Title", - "description": "Name of the underlying non-derivative security related to this derivative transaction." + "title": "Short Interest", + "description": "Number of shares reported as sold short." }, - "underlying_shares": { + "shares_outstanding": { "anyOf": [ - { - "type": "number" - }, { "type": "integer" }, @@ -44055,129 +50930,138 @@ "type": "null" } ], - "title": "Underlying Shares", - "description": "Number of underlying shares related to this derivative transaction." + "title": "Shares Outstanding", + "description": "Weighted average shares outstanding (TTM)." }, - "nature_of_ownership": { + "days_to_cover": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Nature Of Ownership", - "description": "Nature of ownership of the insider trading." + "title": "Days To Cover", + "description": "Days to cover short interest, based on average daily volume." + } + }, + "additionalProperties": true, + "type": "object", + "title": "IntrinioKeyMetricsData", + "description": "Intrinio Key Metrics Data." + }, + "IntrinioLatestAttributesData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "director": { + "tag": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Director", - "description": "Whether the owner is a director." + "title": "Tag", + "description": "Tag name for the fetched data." }, - "officer": { + "value": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { - "type": "null" - } - ], - "title": "Officer", - "description": "Whether the owner is an officer." - }, - "ten_percent_owner": { - "anyOf": [ - { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Ten Percent Owner", - "description": "Whether the owner is a 10% owner." + "title": "Value", + "description": "The value of the data." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioLatestAttributesData", + "description": "Intrinio Latest Attributes Data." + }, + "IntrinioMarketSnapshotsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "other_relation": { + "open": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Other Relation", - "description": "Whether the owner is having another relation." + "title": "Open", + "description": "The open price." }, - "derivative_transaction": { + "high": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Derivative Transaction", - "description": "Whether the owner is having a derivative transaction." + "title": "High", + "description": "The high price." }, - "report_line_number": { + "low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Report Line Number", - "description": "Report line number of the insider trading." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "company_name" - ], - "title": "IntrinioInsiderTrading", - "description": "Intrinio Insider Trading Data." - }, - "IntrinioKeyMetrics": { - "properties": { - "symbol": { + "title": "Low", + "description": "The low price." + }, + "close": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Close", + "description": "The close price." }, - "market_cap": { + "volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Market Cap", - "description": "Market capitalization" + "title": "Volume", + "description": "The trading volume." }, - "pe_ratio": { + "prev_close": { "anyOf": [ { "type": "number" @@ -44186,10 +51070,10 @@ "type": "null" } ], - "title": "Pe Ratio", - "description": "Price-to-earnings ratio (P/E ratio)" + "title": "Prev Close", + "description": "The previous close price." }, - "price_to_book": { + "change": { "anyOf": [ { "type": "number" @@ -44198,10 +51082,10 @@ "type": "null" } ], - "title": "Price To Book", - "description": "Price to book ratio." + "title": "Change", + "description": "The change in price from the previous close." }, - "price_to_tangible_book": { + "change_percent": { "anyOf": [ { "type": "number" @@ -44210,10 +51094,12 @@ "type": "null" } ], - "title": "Price To Tangible Book", - "description": "Price to tangible book ratio." + "title": "Change Percent", + "description": "The change in price from the previous close, as a normalized percent.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "price_to_revenue": { + "last_price": { "anyOf": [ { "type": "number" @@ -44222,64 +51108,59 @@ "type": "null" } ], - "title": "Price To Revenue", - "description": "Price to revenue ratio." + "title": "Last Price", + "description": "The last trade price." }, - "quick_ratio": { + "last_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Quick Ratio", - "description": "Quick ratio." + "title": "Last Size", + "description": "The last trade size." }, - "gross_margin": { + "last_volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Gross Margin", - "description": "Gross margin, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Last Volume", + "description": "The last trade volume." }, - "ebit_margin": { + "last_trade_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Ebit Margin", - "description": "EBIT margin, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Last Trade Timestamp", + "description": "The timestamp of the last trade." }, - "profit_margin": { + "bid_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Profit Margin", - "description": "Profit margin, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Bid Size", + "description": "The size of the last bid price. Bid price and size is not always available." }, - "eps": { + "bid_price": { "anyOf": [ { "type": "number" @@ -44288,10 +51169,10 @@ "type": "null" } ], - "title": "Eps", - "description": "Basic earnings per share." + "title": "Bid Price", + "description": "The last bid price. Bid price and size is not always available." }, - "eps_growth": { + "ask_price": { "anyOf": [ { "type": "number" @@ -44300,110 +51181,129 @@ "type": "null" } ], - "title": "Eps Growth", - "description": "EPS growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Ask Price", + "description": "The last ask price. Ask price and size is not always available." }, - "revenue_growth": { + "ask_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Revenue Growth", - "description": "Revenue growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Ask Size", + "description": "The size of the last ask price. Ask price and size is not always available." }, - "ebitda_growth": { + "last_bid_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Ebitda Growth", - "description": "EBITDA growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Last Bid Timestamp", + "description": "The timestamp of the last bid price. Bid price and size is not always available." }, - "ebit_growth": { + "last_ask_timestamp": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Ebit Growth", - "description": "EBIT growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" - }, - "net_income_growth": { + "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": [ + "symbol" + ], + "title": "IntrinioMarketSnapshotsData", + "description": "Intrinio Market Snapshots Data." + }, + "IntrinioOptionsChainsData": { + "properties": { + "symbol": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Net Income Growth", - "description": "Net income growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Symbol", + "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option." }, - "free_cash_flow_to_firm_growth": { + "contract_symbol": { + "type": "string", + "title": "Contract Symbol", + "description": "Contract symbol for the option." + }, + "eod_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "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" + "title": "Eod Date", + "description": "Date for which the options chains are returned." }, - "invested_capital_growth": { + "expiration": { + "type": "string", + "format": "date", + "title": "Expiration", + "description": "Expiration date of the contract." + }, + "strike": { + "type": "number", + "title": "Strike", + "description": "Strike price of the contract." + }, + "option_type": { + "type": "string", + "title": "Option Type", + "description": "Call or Put." + }, + "open_interest": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Invested Capital Growth", - "description": "Invested capital growth, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Open Interest", + "description": "Open interest on the contract." }, - "return_on_assets": { + "volume": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Return On Assets", - "description": "Return on assets, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Volume", + "description": "The trading volume." }, - "return_on_equity": { + "theoretical_price": { "anyOf": [ { "type": "number" @@ -44412,12 +51312,10 @@ "type": "null" } ], - "title": "Return On Equity", - "description": "Return on equity, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Theoretical Price", + "description": "Theoretical value of the option." }, - "return_on_invested_capital": { + "last_trade_price": { "anyOf": [ { "type": "number" @@ -44426,36 +51324,34 @@ "type": "null" } ], - "title": "Return On Invested Capital", - "description": "Return on invested capital, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Last Trade Price", + "description": "Last trade price of the option." }, - "ebitda": { + "tick": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Ebitda", - "description": "Earnings before interest, taxes, depreciation, and amortization." + "title": "Tick", + "description": "Whether the last tick was up or down in price." }, - "ebit": { + "bid": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Ebit", - "description": "Earnings before interest and taxes." + "title": "Bid", + "description": "Current bid price for the option." }, - "long_term_debt": { + "bid_size": { "anyOf": [ { "type": "integer" @@ -44464,22 +51360,22 @@ "type": "null" } ], - "title": "Long Term Debt", - "description": "Long-term debt." + "title": "Bid Size", + "description": "Bid size for the option." }, - "total_debt": { + "ask": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Total Debt", - "description": "Total debt." + "title": "Ask", + "description": "Current ask price for the option." }, - "total_capital": { + "ask_size": { "anyOf": [ { "type": "integer" @@ -44488,34 +51384,34 @@ "type": "null" } ], - "title": "Total Capital", - "description": "The sum of long-term debt and total shareholder equity." + "title": "Ask Size", + "description": "Ask size for the option." }, - "enterprise_value": { + "mark": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Enterprise Value", - "description": "Enterprise value." + "title": "Mark", + "description": "The mid-price between the latest bid and ask." }, - "free_cash_flow_to_firm": { + "open": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Free Cash Flow To Firm", - "description": "Free cash flow to firm." + "title": "Open", + "description": "The open price." }, - "altman_z_score": { + "open_bid": { "anyOf": [ { "type": "number" @@ -44524,10 +51420,10 @@ "type": "null" } ], - "title": "Altman Z Score", - "description": "Altman Z-score." + "title": "Open Bid", + "description": "The opening bid price for the option that day." }, - "beta": { + "open_ask": { "anyOf": [ { "type": "number" @@ -44536,10 +51432,10 @@ "type": "null" } ], - "title": "Beta", - "description": "Beta relative to the broad market (rolling three-year)." + "title": "Open Ask", + "description": "The opening ask price for the option that day." }, - "dividend_yield": { + "high": { "anyOf": [ { "type": "number" @@ -44548,12 +51444,10 @@ "type": "null" } ], - "title": "Dividend Yield", - "description": "Dividend yield, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "High", + "description": "The high price." }, - "earnings_yield": { + "bid_high": { "anyOf": [ { "type": "number" @@ -44562,12 +51456,10 @@ "type": "null" } ], - "title": "Earnings Yield", - "description": "Earnings yield, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "title": "Bid High", + "description": "The highest bid price for the option that day." }, - "last_price": { + "ask_high": { "anyOf": [ { "type": "number" @@ -44576,10 +51468,10 @@ "type": "null" } ], - "title": "Last Price", - "description": "Last price of the stock." + "title": "Ask High", + "description": "The highest ask price for the option that day." }, - "year_high": { + "low": { "anyOf": [ { "type": "number" @@ -44588,92 +51480,72 @@ "type": "null" } ], - "title": "Year High", - "description": "52 week high" - }, - "year_low": { - "type": "number", - "title": "Year Low", - "description": "52 week low" + "title": "Low", + "description": "The low price." }, - "volume_avg": { + "bid_low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume Avg", - "description": "Average daily volume." + "title": "Bid Low", + "description": "The lowest bid price for the option that day." }, - "short_interest": { + "ask_low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Short Interest", - "description": "Number of shares reported as sold short." + "title": "Ask Low", + "description": "The lowest ask price for the option that day." }, - "shares_outstanding": { + "close": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Shares Outstanding", - "description": "Weighted average shares outstanding (TTM)." + "title": "Close", + "description": "The close price." }, - "days_to_cover": { + "close_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Days To Cover", - "description": "Days to cover short interest, based on average daily volume." - } - }, - "additionalProperties": true, - "type": "object", - "title": "IntrinioKeyMetrics", - "description": "Intrinio Key Metrics Data." - }, - "IntrinioLatestAttributes": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Close Size", + "description": "The closing trade size for the option that day." }, - "tag": { + "close_time": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Tag", - "description": "Tag name for the fetched data." + "title": "Close Time", + "description": "The time of the closing price for the option that day." }, - "value": { + "close_bid": { "anyOf": [ - { - "type": "string" - }, { "type": "number" }, @@ -44681,50 +51553,35 @@ "type": "null" } ], - "title": "Value", - "description": "The value of the data." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "symbol" - ], - "title": "IntrinioLatestAttributes", - "description": "Intrinio Latest Attributes Data." - }, - "IntrinioMarketSnapshots": { - "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": "Close Bid", + "description": "The closing bid price for the option that day." }, - "open": { + "close_bid_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Close Bid Size", + "description": "The closing bid size for the option that day." }, - "high": { + "close_bid_time": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Close Bid Time", + "description": "The time of the bid closing price for the option that day." }, - "low": { + "close_ask": { "anyOf": [ { "type": "number" @@ -44733,32 +51590,33 @@ "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Close Ask", + "description": "The closing ask price for the option that day." }, - "close": { + "close_ask_size": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Close Ask Size", + "description": "The closing ask size for the option that day." }, - "volume": { + "close_ask_time": { "anyOf": [ { - "type": "integer" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Close Ask Time", + "description": "The time of the ask closing price for the option that day." }, "prev_close": { "anyOf": [ @@ -44782,7 +51640,7 @@ } ], "title": "Change", - "description": "The change in price from the previous close." + "description": "The change in the price of the option." }, "change_percent": { "anyOf": [ @@ -44794,11 +51652,9 @@ } ], "title": "Change Percent", - "description": "The change in price from the previous close, as a normalized percent.", - "x-frontend_multiply": 100, - "x-unit_measurement": "percent" + "description": "Change, in normalizezd percentage points, of the option." }, - "last_price": { + "implied_volatility": { "anyOf": [ { "type": "number" @@ -44807,59 +51663,58 @@ "type": "null" } ], - "title": "Last Price", - "description": "The last trade price." + "title": "Implied Volatility", + "description": "Implied volatility of the option." }, - "last_size": { + "delta": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Last Size", - "description": "The last trade size." + "title": "Delta", + "description": "Delta of the option." }, - "last_volume": { + "gamma": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Last Volume", - "description": "The last trade volume." + "title": "Gamma", + "description": "Gamma of the option." }, - "last_trade_timestamp": { + "theta": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Last Trade Timestamp", - "description": "The timestamp of the last trade." + "title": "Theta", + "description": "Theta of the option." }, - "bid_size": { + "vega": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Bid Size", - "description": "The size of the last bid price. Bid price and size is not always available." + "title": "Vega", + "description": "Vega of the option." }, - "bid_price": { + "rho": { "anyOf": [ { "type": "number" @@ -44868,71 +51723,147 @@ "type": "null" } ], - "title": "Bid Price", - "description": "The last bid price. Bid price and size is not always available." + "title": "Rho", + "description": "Rho of the option." }, - "ask_price": { + "exercise_style": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ask Price", - "description": "The last ask price. Ask price and size is not always available." - }, - "ask_size": { + "title": "Exercise Style", + "description": "The exercise style of the option, American or European." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "contract_symbol", + "expiration", + "strike", + "option_type" + ], + "title": "IntrinioOptionsChainsData", + "description": "Intrinio Options Chains Data." + }, + "IntrinioOptionsUnusualData": { + "properties": { + "underlying_symbol": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Ask Size", - "description": "The size of the last ask price. Ask price and size is not always available." + "title": "Underlying Symbol", + "description": "Symbol representing the entity requested in the data. (the underlying symbol)" }, - "last_bid_timestamp": { + "contract_symbol": { + "type": "string", + "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": "string", - "format": "date-time" + "type": "number" }, { "type": "null" } ], - "title": "Last Bid Timestamp", - "description": "The timestamp of the last bid price. Bid price and size is not always available." + "title": "Underlying Price At Execution", + "description": "Price of the underlying security at execution of trade." }, - "last_ask_timestamp": { + "total_size": { + "type": "integer", + "title": "Total Size", + "description": "The total number of contracts involved in a single transaction." + }, + "total_value": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "integer" }, { - "type": "null" + "type": "number" } ], - "title": "Last Ask Timestamp", - "description": "The timestamp of the last ask price. Ask price and size is not always available." + "title": "Total Value", + "description": "The aggregated value of all option contract premiums included in the trade." } }, "additionalProperties": true, "type": "object", "required": [ - "symbol" + "contract_symbol", + "trade_timestamp", + "trade_type", + "sentiment", + "bid_at_execution", + "ask_at_execution", + "average_price", + "total_size", + "total_value" ], - "title": "IntrinioMarketSnapshots", - "description": "Intrinio Market Snapshots Data." + "title": "IntrinioOptionsUnusualData", + "description": "Intrinio Unusual Options Data." }, - "IntrinioOptionsChains": { + "IntrinioPriceTargetConsensusData": { "properties": { "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { "anyOf": [ { "type": "string" @@ -44941,68 +51872,46 @@ "type": "null" } ], - "title": "Symbol", - "description": "Symbol representing the entity requested in the data. Here, it is the underlying symbol for the option." - }, - "contract_symbol": { - "type": "string", - "title": "Contract Symbol", - "description": "Contract symbol for the option." + "title": "Name", + "description": "The company name" }, - "eod_date": { + "target_high": { "anyOf": [ { - "type": "string", - "format": "date" + "type": "number" }, { "type": "null" } ], - "title": "Eod Date", - "description": "Date for which the options chains are returned." - }, - "expiration": { - "type": "string", - "format": "date", - "title": "Expiration", - "description": "Expiration date of the contract." - }, - "strike": { - "type": "number", - "title": "Strike", - "description": "Strike price of the contract." - }, - "option_type": { - "type": "string", - "title": "Option Type", - "description": "Call or Put." + "title": "Target High", + "description": "High target of the price target consensus." }, - "open_interest": { + "target_low": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Open Interest", - "description": "Open interest on the contract." + "title": "Target Low", + "description": "Low target of the price target consensus." }, - "volume": { + "target_consensus": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Volume", - "description": "The trading volume." + "title": "Target Consensus", + "description": "Consensus target of the price target consensus." }, - "theoretical_price": { + "target_median": { "anyOf": [ { "type": "number" @@ -45011,10 +51920,10 @@ "type": "null" } ], - "title": "Theoretical Price", - "description": "Theoretical value of the option." + "title": "Target Median", + "description": "Median target of the price target consensus." }, - "last_trade_price": { + "standard_deviation": { "anyOf": [ { "type": "number" @@ -45023,34 +51932,34 @@ "type": "null" } ], - "title": "Last Trade Price", - "description": "Last trade price of the option." + "title": "Standard Deviation", + "description": "The standard deviation of target price estimates." }, - "tick": { + "total_analysts": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Tick", - "description": "Whether the last tick was up or down in price." + "title": "Total Analysts", + "description": "The total number of target price estimates in consensus." }, - "bid": { + "raised": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Bid", - "description": "Current bid price for the option." + "title": "Raised", + "description": "The number of analysts that have raised their target price estimates." }, - "bid_size": { + "lowered": { "anyOf": [ { "type": "integer" @@ -45059,22 +51968,23 @@ "type": "null" } ], - "title": "Bid Size", - "description": "Bid size for the option." + "title": "Lowered", + "description": "The number of analysts that have lowered their target price estimates." }, - "ask": { + "most_recent_date": { "anyOf": [ { - "type": "number" + "type": "string", + "format": "date" }, { "type": "null" } ], - "title": "Ask", - "description": "Current ask price for the option." + "title": "Most Recent Date", + "description": "The date of the most recent estimate." }, - "ask_size": { + "industry_group_number": { "anyOf": [ { "type": "integer" @@ -45083,241 +51993,328 @@ "type": "null" } ], - "title": "Ask Size", - "description": "Ask size for the option." + "title": "Industry Group Number", + "description": "The Zacks industry group number." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioPriceTargetConsensusData", + "description": "Intrinio Price Target Consensus Data." + }, + "IntrinioReportedFinancialsData": { + "properties": { + "period_ending": { + "type": "string", + "format": "date", + "title": "Period Ending", + "description": "The ending date of the reporting period." }, - "mark": { + "fiscal_period": { + "type": "string", + "title": "Fiscal Period", + "description": "The fiscal period of the report (e.g. FY, Q1, etc.)." + }, + "fiscal_year": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Mark", - "description": "The mid-price between the latest bid and ask." + "title": "Fiscal Year", + "description": "The fiscal year of the fiscal period." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "period_ending", + "fiscal_period" + ], + "title": "IntrinioReportedFinancialsData", + "description": "Intrinio Reported Financials Data.\n\nThe fields for this model are generated dynamically from the XBRL tags in the Intrinio response." + }, + "IntrinioSearchAttributesData": { + "properties": { + "id": { + "type": "string", + "title": "Id", + "description": "ID of the financial attribute." }, - "open": { + "name": { + "type": "string", + "title": "Name", + "description": "Name of the financial attribute." + }, + "tag": { + "type": "string", + "title": "Tag", + "description": "Tag of the financial attribute." + }, + "statement_code": { + "type": "string", + "title": "Statement Code", + "description": "Code of the financial statement." + }, + "statement_type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Open", - "description": "The open price." + "title": "Statement Type", + "description": "Type of the financial statement." }, - "open_bid": { + "parent_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Open Bid", - "description": "The opening bid price for the option that day." + "title": "Parent Name", + "description": "Parent's name of the financial attribute." }, - "open_ask": { + "sequence": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "type": "null" } ], - "title": "Open Ask", - "description": "The opening ask price for the option that day." + "title": "Sequence", + "description": "Sequence of the financial statement." }, - "high": { + "factor": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "High", - "description": "The high price." + "title": "Factor", + "description": "Unit of the financial attribute." }, - "bid_high": { + "transaction": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Bid High", - "description": "The highest bid price for the option that day." + "title": "Transaction", + "description": "Transaction type (credit/debit) of the financial attribute." }, - "ask_high": { + "type": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ask High", - "description": "The highest ask price for the option that day." + "title": "Type", + "description": "Type of the financial attribute." }, - "low": { + "unit": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Low", - "description": "The low price." + "title": "Unit", + "description": "Unit of the financial attribute." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "id", + "name", + "tag", + "statement_code" + ], + "title": "IntrinioSearchAttributesData", + "description": "Intrinio Search Attributes Data." + }, + "IntrinioSecurity": { + "properties": { + "id": { + "type": "string", + "title": "Id", + "description": "The Intrinio ID for Security." }, - "bid_low": { + "company_id": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Bid Low", - "description": "The lowest bid price for the option that day." + "title": "Company Id", + "description": "The Intrinio ID for the company for which the Security is issued." }, - "ask_low": { + "name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Ask Low", - "description": "The lowest ask price for the option that day." + "title": "Name", + "description": "Name of the Security." }, - "close": { + "code": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Close", - "description": "The close price." + "title": "Code", + "description": "\n A 2-3 digit code classifying the Security.\n Reference: https://docs.intrinio.com/documentation/security_codes\n " }, - "close_size": { + "currency": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Close Size", - "description": "The closing trade size for the option that day." + "title": "Currency", + "description": "The currency in which the Security is traded." }, - "close_time": { + "ticker": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Close Time", - "description": "The time of the closing price for the option that day." + "title": "Ticker", + "description": "The common/local ticker of the Security." }, - "close_bid": { + "composite_ticker": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Close Bid", - "description": "The closing bid price for the option that day." + "title": "Composite Ticker", + "description": "The country-composite ticker of the Security." }, - "close_bid_size": { + "figi": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Close Bid Size", - "description": "The closing bid size for the option that day." + "title": "Figi", + "description": "The OpenFIGI identifier." }, - "close_bid_time": { + "composite_figi": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Close Bid Time", - "description": "The time of the bid closing price for the option that day." + "title": "Composite Figi", + "description": "The country-composite OpenFIGI identifier." }, - "close_ask": { + "share_class_figi": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Close Ask", - "description": "The closing ask price for the option that day." + "title": "Share Class Figi", + "description": "The global-composite OpenFIGI identifier." }, - "close_ask_size": { + "primary_listing": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Close Ask Size", - "description": "The closing ask size for the option that day." + "title": "Primary Listing", + "description": "\n If true, the Security is the primary issue for the company,\n otherwise it is a secondary issue on a secondary stock exchange,\n " + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "id" + ], + "title": "IntrinioSecurity", + "description": "Intrinio Security Data." + }, + "IntrinioShareStatisticsData": { + "properties": { + "symbol": { + "type": "string", + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "close_ask_time": { + "date": { "anyOf": [ { "type": "string", - "format": "date-time" + "format": "date" }, { "type": "null" } ], - "title": "Close Ask Time", - "description": "The time of the ask closing price for the option that day." + "title": "Date", + "description": "The date of the data." }, - "prev_close": { + "free_float": { "anyOf": [ { "type": "number" @@ -45326,10 +52323,10 @@ "type": "null" } ], - "title": "Prev Close", - "description": "The previous close price." + "title": "Free Float", + "description": "Percentage of unrestricted shares of a publicly-traded company." }, - "change": { + "float_shares": { "anyOf": [ { "type": "number" @@ -45338,10 +52335,10 @@ "type": "null" } ], - "title": "Change", - "description": "The change in the price of the option." + "title": "Float Shares", + "description": "Number of shares available for trading by the general public." }, - "change_percent": { + "outstanding_shares": { "anyOf": [ { "type": "number" @@ -45350,22 +52347,22 @@ "type": "null" } ], - "title": "Change Percent", - "description": "Change, in normalizezd percentage points, of the option." + "title": "Outstanding Shares", + "description": "Total number of shares of a publicly-traded company." }, - "implied_volatility": { + "source": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Implied Volatility", - "description": "Implied volatility of the option." + "title": "Source", + "description": "Source of the received data." }, - "delta": { + "adjweightedavebasicdilutedsharesos": { "anyOf": [ { "type": "number" @@ -45374,10 +52371,10 @@ "type": "null" } ], - "title": "Delta", - "description": "Delta of the option." + "title": "Adjweightedavebasicdilutedsharesos", + "description": "Total number of shares of a publicly-traded company, adjusted for splits." }, - "gamma": { + "public_float": { "anyOf": [ { "type": "number" @@ -45386,46 +52383,74 @@ "type": "null" } ], - "title": "Gamma", - "description": "Gamma of the option." + "title": "Public Float", + "description": "Aggregate market value of the shares of a publicly-traded company." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "symbol" + ], + "title": "IntrinioShareStatisticsData", + "description": "Intrinio Share Statistics Data." + }, + "IntrinioWorldNewsData": { + "properties": { + "date": { + "type": "string", + "format": "date-time", + "title": "Date", + "description": "The date of the data. The published date of the article." }, - "theta": { + "title": { + "type": "string", + "title": "Title", + "description": "Title of the article." + }, + "images": { "anyOf": [ { - "type": "number" + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" }, { "type": "null" } ], - "title": "Theta", - "description": "Theta of the option." + "title": "Images", + "description": "Images associated with the article." }, - "vega": { + "text": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Vega", - "description": "Vega of the option." + "title": "Text", + "description": "Text/body of the article." }, - "rho": { + "url": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Rho", - "description": "Rho of the option." + "title": "Url", + "description": "URL to the article." }, - "exercise_style": { + "source": { "anyOf": [ { "type": "string" @@ -45434,24 +52459,10 @@ "type": "null" } ], - "title": "Exercise Style", - "description": "The exercise style of the option, American or European." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "contract_symbol", - "expiration", - "strike", - "option_type" - ], - "title": "IntrinioOptionsChains", - "description": "Intrinio Options Chains Data." - }, - "IntrinioOptionsUnusual": { - "properties": { - "underlying_symbol": { + "title": "Source", + "description": "The source of the news article." + }, + "summary": { "anyOf": [ { "type": "string" @@ -45460,171 +52471,70 @@ "type": "null" } ], - "title": "Underlying Symbol", - "description": "Symbol representing the entity requested in the data. (the underlying symbol)" - }, - "contract_symbol": { - "type": "string", - "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." + "title": "Summary", + "description": "The summary of the news article." }, - "sentiment": { - "type": "string", - "enum": [ - "bullish", - "bearish", - "neutral" + "topics": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } ], - "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." + "title": "Topics", + "description": "The topics related to the news article." }, - "underlying_price_at_execution": { + "word_count": { "anyOf": [ { - "type": "number" + "type": "integer" }, { "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." + "title": "Word Count", + "description": "The word count of the news article." }, - "total_value": { + "business_relevance": { "anyOf": [ { - "type": "integer" + "type": "number" }, { - "type": "number" + "type": "null" } ], - "title": "Total Value", - "description": "The aggregated value of all option contract premiums included in the trade." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "contract_symbol", - "trade_timestamp", - "trade_type", - "sentiment", - "bid_at_execution", - "ask_at_execution", - "average_price", - "total_size", - "total_value" - ], - "title": "IntrinioOptionsUnusual", - "description": "Intrinio Unusual Options Data." - }, - "IntrinioReportedFinancials": { - "properties": { - "period_ending": { - "type": "string", - "format": "date", - "title": "Period Ending", - "description": "The ending date of the reporting period." - }, - "fiscal_period": { - "type": "string", - "title": "Fiscal Period", - "description": "The fiscal period of the report (e.g. FY, Q1, etc.)." + "title": "Business Relevance", + "description": " \tHow strongly correlated the news article is to the business" }, - "fiscal_year": { + "sentiment": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Fiscal Year", - "description": "The fiscal year of the fiscal period." - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "period_ending", - "fiscal_period" - ], - "title": "IntrinioReportedFinancials", - "description": "Intrinio Reported Financials Data.\n\nThe fields for this model are generated dynamically from the XBRL tags in the Intrinio response." - }, - "IntrinioSearchAttributes": { - "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "ID of the financial attribute." - }, - "name": { - "type": "string", - "title": "Name", - "description": "Name of the financial attribute." - }, - "tag": { - "type": "string", - "title": "Tag", - "description": "Tag of the financial attribute." - }, - "statement_code": { - "type": "string", - "title": "Statement Code", - "description": "Code of the financial statement." + "title": "Sentiment", + "description": "The sentiment of the news article - i.e, negative, positive." }, - "statement_type": { + "sentiment_confidence": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Statement Type", - "description": "Type of the financial statement." + "title": "Sentiment Confidence", + "description": "The confidence score of the sentiment rating." }, - "parent_name": { + "language": { "anyOf": [ { "type": "string" @@ -45633,22 +52543,22 @@ "type": "null" } ], - "title": "Parent Name", - "description": "Parent's name of the financial attribute." + "title": "Language", + "description": "The language of the news article." }, - "sequence": { + "spam": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Sequence", - "description": "Sequence of the financial statement." + "title": "Spam", + "description": "Whether the news article is spam." }, - "factor": { + "copyright": { "anyOf": [ { "type": "string" @@ -45657,65 +52567,123 @@ "type": "null" } ], - "title": "Factor", - "description": "Unit of the financial attribute." + "title": "Copyright", + "description": "The copyright notice of the news article." }, - "transaction": { + "id": { + "type": "string", + "title": "Id", + "description": "Article ID." + }, + "company": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IntrinioCompany" }, { "type": "null" } ], - "title": "Transaction", - "description": "Transaction type (credit/debit) of the financial attribute." + "description": "The Intrinio Company object. Contains details company reference data." }, - "type": { + "security": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], - "title": "Type", - "description": "Type of the financial attribute." + "description": "The Intrinio Security object. Contains the security details related to the news article." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "date", + "title", + "id" + ], + "title": "IntrinioWorldNewsData", + "description": "Intrinio World News Data." + }, + "NixtlaTimegenData": { + "properties": { + "date": { + "type": "string", + "format": "date", + "title": "Date", + "description": "Date." }, - "unit": { + "forecast": { + "type": "number", + "title": "Forecast", + "description": "Forecast value." + }, + "levels": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/NixtlaTimegenLevelData" + }, + "type": "array" }, { "type": "null" } ], - "title": "Unit", - "description": "Unit of the financial attribute." + "title": "Levels", + "description": "Prediction intervals." } }, "additionalProperties": true, "type": "object", "required": [ - "id", - "name", - "tag", - "statement_code" + "date", + "forecast" ], - "title": "IntrinioSearchAttributes", - "description": "Intrinio Search Attributes Data." + "title": "NixtlaTimegenData", + "description": "Nixtla Timegen Data." }, - "IntrinioSecurity": { + "NixtlaTimegenLevelData": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The Intrinio ID for Security." + "level": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + } + ], + "title": "Level", + "description": "Level." }, - "company_id": { + "high": { + "type": "number", + "title": "High", + "description": "High value." + }, + "low": { + "type": "number", + "title": "Low", + "description": "Low value." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "level", + "high", + "low" + ], + "title": "NixtlaTimegenLevelData", + "description": "Nixtla Timegen Level Data." + }, + "NixtlaTimegenQueryParams": { + "properties": { + "freq": { "anyOf": [ { "type": "string" @@ -45724,94 +52692,158 @@ "type": "null" } ], - "title": "Company Id", - "description": "The Intrinio ID for the company for which the Security is issued." + "title": "Freq", + "description": "Frequency of the data. H: hourly, D: daily, W: weekly, M: monthly, Q: quarterly, Y: yearly.", + "default": "D" }, - "name": { + "fh": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Name", - "description": "Name of the Security." + "title": "Fh", + "description": "Forecast horizon.", + "default": 7 }, - "code": { + "y": { "anyOf": [ { - "type": "string" + "additionalProperties": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + } + ] + }, + "type": "object" }, { "type": "null" } ], - "title": "Code", - "description": "\n A 2-3 digit code classifying the Security.\n Reference: https://docs.intrinio.com/documentation/security_codes\n " + "title": "Y", + "description": "Time series data." }, - "currency": { + "level": { "anyOf": [ { - "type": "string" + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "number" + } + ] + }, + "type": "array" }, { "type": "null" } ], - "title": "Currency", - "description": "The currency in which the Security is traded." + "title": "Level", + "description": "A list of values representing the prediction intervals. Each value is a percentage that indicates the level of certainty for the corresponding prediction interval. For example, [80, 90] defines 80% and 90% prediction intervals." }, - "ticker": { + "clean_ex_first": { + "type": "boolean", + "title": "Clean Ex First", + "description": "Clean the first example.", + "default": true + }, + "finetune_steps": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Ticker", - "description": "The common/local ticker of the Security." + "title": "Finetune Steps", + "description": "Number of finetune steps.", + "default": 0 }, - "composite_ticker": { + "finetune_loss": { "anyOf": [ { - "type": "string" + "type": "string", + "enum": [ + "default", + "mae", + "mse", + "rmse", + "mape", + "smape" + ] }, { "type": "null" } ], - "title": "Composite Ticker", - "description": "The country-composite ticker of the Security." + "title": "Finetune Loss", + "description": "Finetune loss.", + "default": "default" }, - "figi": { + "model": { "anyOf": [ { - "type": "string" + "type": "string", + "enum": [ + "timegpt-1", + "timegpt-1-long-horizon", + "short-horizon", + "long-horizon", + "azureai" + ] }, { "type": "null" } ], - "title": "Figi", - "description": "The OpenFIGI identifier." + "title": "Model", + "description": "Model to use.", + "default": "timegpt-1" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "y" + ], + "title": "NixtlaTimegenQueryParams", + "description": "Nixtla Timegen Query." + }, + "OBBject_AMERIBOR": { + "properties": { + "_id": { + "type": "string", + "title": " Id" }, - "composite_figi": { + "results": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/FREDAMERIBORData" + }, + "type": "array" }, { "type": "null" } ], - "title": "Composite Figi", - "description": "The country-composite OpenFIGI identifier." + "title": "Results", + "description": "Serializable results." }, - "share_class_figi": { + "provider": { "anyOf": [ { "type": "string" @@ -45820,87 +52852,136 @@ "type": "null" } ], - "title": "Share Class Figi", - "description": "The global-composite OpenFIGI identifier." + "title": "Provider", + "description": "Provider name." }, - "primary_listing": { + "warnings": { "anyOf": [ { - "type": "boolean" + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" }, { "type": "null" } ], - "title": "Primary Listing", - "description": "\n If true, the Security is the primary issue for the company,\n otherwise it is a secondary issue on a secondary stock exchange,\n " + "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." } }, - "additionalProperties": true, "type": "object", - "required": [ - "id" - ], - "title": "IntrinioSecurity", - "description": "Intrinio Security Data." + "title": "OBBject_AMERIBOR", + "description": "OBBject with results of type AMERIBOR" }, - "IntrinioShareStatistics": { + "OBBject_AnalystEstimates": { "properties": { - "symbol": { + "_id": { "type": "string", - "title": "Symbol", - "description": "Symbol representing the entity requested in the data." + "title": " Id" }, - "date": { + "results": { "anyOf": [ { - "type": "string", - "format": "date" + "items": { + "$ref": "#/components/schemas/FMPAnalystEstimatesData" + }, + "type": "array" }, { "type": "null" } ], - "title": "Date", - "description": "The date of the data." + "title": "Results", + "description": "Serializable results." }, - "free_float": { + "provider": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Free Float", - "description": "Percentage of unrestricted shares of a publicly-traded company." + "title": "Provider", + "description": "Provider name." }, - "float_shares": { + "warnings": { "anyOf": [ { - "type": "number" + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" }, { "type": "null" } ], - "title": "Float Shares", - "description": "Number of shares available for trading by the general public." + "title": "Warnings", + "description": "List of warnings." }, - "outstanding_shares": { + "chart": { "anyOf": [ { - "type": "number" + "$ref": "#/components/schemas/Chart" }, { "type": "null" } ], - "title": "Outstanding Shares", - "description": "Total number of shares of a publicly-traded company." + "description": "Chart object." }, - "source": { + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." + } + }, + "type": "object", + "title": "OBBject_AnalystEstimates", + "description": "OBBject with results of type AnalystEstimates" + }, + "OBBject_AnalystSearch": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/BenzingaAnalystSearchData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "provider": { "anyOf": [ { "type": "string" @@ -45909,63 +52990,56 @@ "type": "null" } ], - "title": "Source", - "description": "Source of the received data." + "title": "Provider", + "description": "Provider name." }, - "adjusted_outstanding_shares": { + "warnings": { "anyOf": [ { - "type": "number" + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" }, { "type": "null" } ], - "title": "Adjusted Outstanding Shares", - "description": "Total number of shares of a publicly-traded company, adjusted for splits." + "title": "Warnings", + "description": "List of warnings." }, - "public_float": { + "chart": { "anyOf": [ { - "type": "number" + "$ref": "#/components/schemas/Chart" }, { "type": "null" } ], - "title": "Public Float", - "description": "Aggregate market value of the shares of a publicly-traded company." + "description": "Chart object." + }, + "extra": { + "type": "object", + "title": "Extra", + "description": "Extra info." } }, - "additionalProperties": true, "type": "object", - "required": [ - "symbol" - ], - "title": "IntrinioShareStatistics", - "description": "Intrinio Share Statistics Data." + "title": "OBBject_AnalystSearch", + "description": "OBBject with results of type AnalystSearch" }, - "IntrinioWorldNews": { + "OBBject_AvailableIndicators": { "properties": { - "date": { - "type": "string", - "format": "date-time", - "title": "Date", - "description": "The date of the data. The published date of the article." - }, - "title": { + "_id": { "type": "string", - "title": "Title", - "description": "Title of the article." + "title": " Id" }, - "images": { + "results": { "anyOf": [ { "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "$ref": "#/components/schemas/EconDbAvailableIndicatorsData" }, "type": "array" }, @@ -45973,10 +53047,10 @@ "type": "null" } ], - "title": "Images", - "description": "Images associated with the article." + "title": "Results", + "description": "Serializable results." }, - "text": { + "provider": { "anyOf": [ { "type": "string" @@ -45985,44 +53059,46 @@ "type": "null" } ], - "title": "Text", - "description": "Text/body of the article." + "title": "Provider", + "description": "Provider name." }, - "url": { + "warnings": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/Warning_" + }, + "type": "array" }, { "type": "null" } ], - "title": "Url", - "description": "URL to the article." + "title": "Warnings", + "description": "List of warnings." }, - "id": { - "type": "string", - "title": "Id", - "description": "Article ID." + "chart": { + "anyOf": [ + { + "$ref": "#/components/schemas/Chart" + }, + { + "type": "null" + } + ], + "description": "Chart object." }, - "company": { + "extra": { "type": "object", - "title": "Company", - "description": "Company details related to the news article." + "title": "Extra", + "description": "Extra info." } }, - "additionalProperties": true, "type": "object", - "required": [ - "date", - "title", - "id", - "company" - ], - "title": "IntrinioWorldNews", - "description": "Intrinio World News Data." + "title": "OBBject_AvailableIndicators", + "description": "OBBject with results of type AvailableIndicators" }, - "OBBject_AMERIBOR": { + "OBBject_AvailableIndices": { "properties": { "_id": { "type": "string", @@ -46032,17 +53108,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDAMERIBOR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDAMERIBOR" - } - } + "$ref": "#/components/schemas/FMPAvailableIndicesData" }, "type": "array" }, @@ -46051,10 +53117,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AMERIBOR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46101,10 +53164,10 @@ } }, "type": "object", - "title": "OBBject_AMERIBOR", - "description": "OBBject with results of type AMERIBOR" + "title": "OBBject_AvailableIndices", + "description": "OBBject with results of type AvailableIndices" }, - "OBBject_AnalystEstimates": { + "OBBject_BalanceOfPayments": { "properties": { "_id": { "type": "string", @@ -46116,15 +53179,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPAnalystEstimates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPAnalystEstimates" + "$ref": "#/components/schemas/ECBBalanceOfPaymentsData" + }, + { + "$ref": "#/components/schemas/FredBalanceOfPaymentsData" } - } + ] }, "type": "array" }, @@ -46133,10 +53193,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AnalystEstimates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46183,10 +53240,10 @@ } }, "type": "object", - "title": "OBBject_AnalystEstimates", - "description": "OBBject with results of type AnalystEstimates" + "title": "OBBject_BalanceOfPayments", + "description": "OBBject with results of type BalanceOfPayments" }, - "OBBject_AnalystSearch": { + "OBBject_BalanceSheet": { "properties": { "_id": { "type": "string", @@ -46198,15 +53255,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaAnalystSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaAnalystSearch" + "$ref": "#/components/schemas/PolygonBalanceSheetData" + }, + { + "$ref": "#/components/schemas/IntrinioBalanceSheetData" + }, + { + "$ref": "#/components/schemas/FMPBalanceSheetData" } - } + ] }, "type": "array" }, @@ -46215,10 +53272,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AnalystSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46265,10 +53319,10 @@ } }, "type": "object", - "title": "OBBject_AnalystSearch", - "description": "OBBject with results of type AnalystSearch" + "title": "OBBject_BalanceSheet", + "description": "OBBject with results of type BalanceSheet" }, - "OBBject_AvailableIndices": { + "OBBject_BalanceSheetGrowth": { "properties": { "_id": { "type": "string", @@ -46278,17 +53332,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPAvailableIndices" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPAvailableIndices" - } - } + "$ref": "#/components/schemas/FMPBalanceSheetGrowthData" }, "type": "array" }, @@ -46297,10 +53341,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "AvailableIndices" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46347,10 +53388,10 @@ } }, "type": "object", - "title": "OBBject_AvailableIndices", - "description": "OBBject with results of type AvailableIndices" + "title": "OBBject_BalanceSheetGrowth", + "description": "OBBject with results of type BalanceSheetGrowth" }, - "OBBject_BalanceOfPayments": { + "OBBject_CLI": { "properties": { "_id": { "type": "string", @@ -46360,17 +53401,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/ECBBalanceOfPayments" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBBalanceOfPayments" - } - } + "$ref": "#/components/schemas/OECDCLIData" }, "type": "array" }, @@ -46379,10 +53410,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceOfPayments" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46429,10 +53457,10 @@ } }, "type": "object", - "title": "OBBject_BalanceOfPayments", - "description": "OBBject with results of type BalanceOfPayments" + "title": "OBBject_CLI", + "description": "OBBject with results of type CLI" }, - "OBBject_BalanceSheet": { + "OBBject_CalendarDividend": { "properties": { "_id": { "type": "string", @@ -46442,25 +53470,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPBalanceSheet" - }, - { - "$ref": "#/components/schemas/IntrinioBalanceSheet" - }, - { - "$ref": "#/components/schemas/PolygonBalanceSheet" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPBalanceSheet", - "intrinio": "#/components/schemas/IntrinioBalanceSheet", - "polygon": "#/components/schemas/PolygonBalanceSheet" - } - } + "$ref": "#/components/schemas/FMPCalendarDividendData" }, "type": "array" }, @@ -46469,10 +53479,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceSheet" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46519,10 +53526,10 @@ } }, "type": "object", - "title": "OBBject_BalanceSheet", - "description": "OBBject with results of type BalanceSheet" + "title": "OBBject_CalendarDividend", + "description": "OBBject with results of type CalendarDividend" }, - "OBBject_BalanceSheetGrowth": { + "OBBject_CalendarEarnings": { "properties": { "_id": { "type": "string", @@ -46532,17 +53539,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPBalanceSheetGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPBalanceSheetGrowth" - } - } + "$ref": "#/components/schemas/FMPCalendarEarningsData" }, "type": "array" }, @@ -46551,10 +53548,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "BalanceSheetGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46601,10 +53595,10 @@ } }, "type": "object", - "title": "OBBject_BalanceSheetGrowth", - "description": "OBBject with results of type BalanceSheetGrowth" + "title": "OBBject_CalendarEarnings", + "description": "OBBject with results of type CalendarEarnings" }, - "OBBject_CLI": { + "OBBject_CalendarIpo": { "properties": { "_id": { "type": "string", @@ -46614,17 +53608,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDCLI" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDCLI" - } - } + "$ref": "#/components/schemas/IntrinioCalendarIpoData" }, "type": "array" }, @@ -46633,10 +53617,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CLI" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46683,10 +53664,10 @@ } }, "type": "object", - "title": "OBBject_CLI", - "description": "OBBject with results of type CLI" + "title": "OBBject_CalendarIpo", + "description": "OBBject with results of type CalendarIpo" }, - "OBBject_CalendarDividend": { + "OBBject_CalendarSplits": { "properties": { "_id": { "type": "string", @@ -46696,17 +53677,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCalendarDividend" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarDividend" - } - } + "$ref": "#/components/schemas/FMPCalendarSplitsData" }, "type": "array" }, @@ -46715,10 +53686,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarDividend" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46765,10 +53733,10 @@ } }, "type": "object", - "title": "OBBject_CalendarDividend", - "description": "OBBject with results of type CalendarDividend" + "title": "OBBject_CalendarSplits", + "description": "OBBject with results of type CalendarSplits" }, - "OBBject_CalendarEarnings": { + "OBBject_CashFlowStatement": { "properties": { "_id": { "type": "string", @@ -46780,15 +53748,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCalendarEarnings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarEarnings" + "$ref": "#/components/schemas/FMPCashFlowStatementData" + }, + { + "$ref": "#/components/schemas/PolygonCashFlowStatementData" + }, + { + "$ref": "#/components/schemas/IntrinioCashFlowStatementData" } - } + ] }, "type": "array" }, @@ -46797,10 +53765,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarEarnings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46847,10 +53812,10 @@ } }, "type": "object", - "title": "OBBject_CalendarEarnings", - "description": "OBBject with results of type CalendarEarnings" + "title": "OBBject_CashFlowStatement", + "description": "OBBject with results of type CashFlowStatement" }, - "OBBject_CalendarIpo": { + "OBBject_CashFlowStatementGrowth": { "properties": { "_id": { "type": "string", @@ -46860,17 +53825,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioCalendarIpo" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioCalendarIpo" - } - } + "$ref": "#/components/schemas/FMPCashFlowStatementGrowthData" }, "type": "array" }, @@ -46879,10 +53834,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarIpo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -46929,30 +53881,85 @@ } }, "type": "object", - "title": "OBBject_CalendarIpo", - "description": "OBBject with results of type CalendarIpo" + "title": "OBBject_CashFlowStatementGrowth", + "description": "OBBject with results of type CashFlowStatementGrowth" }, - "OBBject_CalendarSplits": { + "OBBject_CikMap": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/SecCikMapData" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCalendarSplits" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCalendarSplits" - } - } + "$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_CikMap", + "description": "OBBject with results of type CikMap" + }, + "OBBject_CommercialPaper": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FREDCommercialPaperData" }, "type": "array" }, @@ -46961,10 +53968,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CalendarSplits" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47011,10 +54015,10 @@ } }, "type": "object", - "title": "OBBject_CalendarSplits", - "description": "OBBject with results of type CalendarSplits" + "title": "OBBject_CommercialPaper", + "description": "OBBject with results of type CommercialPaper" }, - "OBBject_CashFlowStatement": { + "OBBject_CompanyFilings": { "properties": { "_id": { "type": "string", @@ -47026,23 +54030,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCashFlowStatement" + "$ref": "#/components/schemas/IntrinioCompanyFilingsData" }, { - "$ref": "#/components/schemas/IntrinioCashFlowStatement" + "$ref": "#/components/schemas/FMPCompanyFilingsData" }, { - "$ref": "#/components/schemas/PolygonCashFlowStatement" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCashFlowStatement", - "intrinio": "#/components/schemas/IntrinioCashFlowStatement", - "polygon": "#/components/schemas/PolygonCashFlowStatement" + "$ref": "#/components/schemas/SecCompanyFilingsData" } - } + ] }, "type": "array" }, @@ -47051,10 +54047,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CashFlowStatement" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47101,10 +54094,10 @@ } }, "type": "object", - "title": "OBBject_CashFlowStatement", - "description": "OBBject with results of type CashFlowStatement" + "title": "OBBject_CompanyFilings", + "description": "OBBject with results of type CompanyFilings" }, - "OBBject_CashFlowStatementGrowth": { + "OBBject_CompanyNews": { "properties": { "_id": { "type": "string", @@ -47116,15 +54109,18 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCashFlowStatementGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCashFlowStatementGrowth" + "$ref": "#/components/schemas/FMPCompanyNewsData" + }, + { + "$ref": "#/components/schemas/PolygonCompanyNewsData" + }, + { + "$ref": "#/components/schemas/BenzingaCompanyNewsData" + }, + { + "$ref": "#/components/schemas/IntrinioCompanyNewsData" } - } + ] }, "type": "array" }, @@ -47133,10 +54129,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CashFlowStatementGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47183,10 +54176,10 @@ } }, "type": "object", - "title": "OBBject_CashFlowStatementGrowth", - "description": "OBBject with results of type CashFlowStatementGrowth" + "title": "OBBject_CompanyNews", + "description": "OBBject with results of type CompanyNews" }, - "OBBject_CikMap": { + "OBBject_CompanyOverview": { "properties": { "_id": { "type": "string", @@ -47195,27 +54188,82 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecCikMap" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecCikMap" - } - } + "$ref": "#/components/schemas/FMPCompanyOverviewData" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "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_CompanyOverview", + "description": "OBBject with results of type CompanyOverview" + }, + "OBBject_CompareCompanyFacts": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SecCompareCompanyFactsData" + }, + "type": "array" }, { "type": "null" } ], "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CikMap" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47262,10 +54310,10 @@ } }, "type": "object", - "title": "OBBject_CikMap", - "description": "OBBject with results of type CikMap" + "title": "OBBject_CompareCompanyFacts", + "description": "OBBject with results of type CompareCompanyFacts" }, - "OBBject_CommercialPaper": { + "OBBject_ConsumerPriceIndex": { "properties": { "_id": { "type": "string", @@ -47275,17 +54323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDCommercialPaper" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDCommercialPaper" - } - } + "$ref": "#/components/schemas/FREDConsumerPriceIndexData" }, "type": "array" }, @@ -47294,10 +54332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CommercialPaper" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47344,10 +54379,10 @@ } }, "type": "object", - "title": "OBBject_CommercialPaper", - "description": "OBBject with results of type CommercialPaper" + "title": "OBBject_ConsumerPriceIndex", + "description": "OBBject with results of type ConsumerPriceIndex" }, - "OBBject_CompanyFilings": { + "OBBject_CountryProfile": { "properties": { "_id": { "type": "string", @@ -47357,25 +54392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCompanyFilings" - }, - { - "$ref": "#/components/schemas/IntrinioCompanyFilings" - }, - { - "$ref": "#/components/schemas/SecCompanyFilings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCompanyFilings", - "intrinio": "#/components/schemas/IntrinioCompanyFilings", - "sec": "#/components/schemas/SecCompanyFilings" - } - } + "$ref": "#/components/schemas/EconDbCountryProfileData" }, "type": "array" }, @@ -47384,10 +54401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CompanyFilings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47434,10 +54448,10 @@ } }, "type": "object", - "title": "OBBject_CompanyFilings", - "description": "OBBject with results of type CompanyFilings" + "title": "OBBject_CountryProfile", + "description": "OBBject with results of type CountryProfile" }, - "OBBject_CompanyNews": { + "OBBject_CryptoHistorical": { "properties": { "_id": { "type": "string", @@ -47449,27 +54463,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaCompanyNews" + "$ref": "#/components/schemas/FMPCryptoHistoricalData" }, { - "$ref": "#/components/schemas/FMPCompanyNews" - }, - { - "$ref": "#/components/schemas/IntrinioCompanyNews" - }, - { - "$ref": "#/components/schemas/PolygonCompanyNews" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaCompanyNews", - "fmp": "#/components/schemas/FMPCompanyNews", - "intrinio": "#/components/schemas/IntrinioCompanyNews", - "polygon": "#/components/schemas/PolygonCompanyNews" + "$ref": "#/components/schemas/PolygonCryptoHistoricalData" } - } + ] }, "type": "array" }, @@ -47478,10 +54477,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CompanyNews" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47528,10 +54524,10 @@ } }, "type": "object", - "title": "OBBject_CompanyNews", - "description": "OBBject with results of type CompanyNews" + "title": "OBBject_CryptoHistorical", + "description": "OBBject with results of type CryptoHistorical" }, - "OBBject_CompanyOverview": { + "OBBject_CryptoSearch": { "properties": { "_id": { "type": "string", @@ -47540,27 +54536,17 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCompanyOverview" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCompanyOverview" - } - } + "items": { + "$ref": "#/components/schemas/FMPCryptoSearchData" + }, + "type": "array" }, { "type": "null" } ], "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CompanyOverview" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47607,10 +54593,10 @@ } }, "type": "object", - "title": "OBBject_CompanyOverview", - "description": "OBBject with results of type CompanyOverview" + "title": "OBBject_CryptoSearch", + "description": "OBBject with results of type CryptoSearch" }, - "OBBject_ConsumerPriceIndex": { + "OBBject_CurrencyHistorical": { "properties": { "_id": { "type": "string", @@ -47622,15 +54608,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FREDConsumerPriceIndex" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDConsumerPriceIndex" + "$ref": "#/components/schemas/FMPCurrencyHistoricalData" + }, + { + "$ref": "#/components/schemas/PolygonCurrencyHistoricalData" } - } + ] }, "type": "array" }, @@ -47639,10 +54622,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ConsumerPriceIndex" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47689,10 +54669,10 @@ } }, "type": "object", - "title": "OBBject_ConsumerPriceIndex", - "description": "OBBject with results of type ConsumerPriceIndex" + "title": "OBBject_CurrencyHistorical", + "description": "OBBject with results of type CurrencyHistorical" }, - "OBBject_CryptoHistorical": { + "OBBject_CurrencyPairs": { "properties": { "_id": { "type": "string", @@ -47704,19 +54684,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCryptoHistorical" + "$ref": "#/components/schemas/PolygonCurrencyPairsData" }, { - "$ref": "#/components/schemas/PolygonCryptoHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCryptoHistorical", - "polygon": "#/components/schemas/PolygonCryptoHistorical" + "$ref": "#/components/schemas/IntrinioCurrencyPairsData" + }, + { + "$ref": "#/components/schemas/FMPCurrencyPairsData" } - } + ] }, "type": "array" }, @@ -47725,10 +54701,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CryptoHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47775,10 +54748,75 @@ } }, "type": "object", - "title": "OBBject_CryptoHistorical", - "description": "OBBject with results of type CryptoHistorical" + "title": "OBBject_CurrencyPairs", + "description": "OBBject with results of type CurrencyPairs" }, - "OBBject_CryptoSearch": { + "OBBject_CurrencyReferenceRates": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/ECBCurrencyReferenceRatesData" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "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_CurrencyReferenceRates", + "description": "OBBject with results of type CurrencyReferenceRates" + }, + "OBBject_CurrencySnapshots": { "properties": { "_id": { "type": "string", @@ -47790,15 +54828,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPCryptoSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCryptoSearch" + "$ref": "#/components/schemas/PolygonCurrencySnapshotsData" + }, + { + "$ref": "#/components/schemas/FMPCurrencySnapshotsData" } - } + ] }, "type": "array" }, @@ -47807,10 +54842,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CryptoSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47857,10 +54889,10 @@ } }, "type": "object", - "title": "OBBject_CryptoSearch", - "description": "OBBject with results of type CryptoSearch" + "title": "OBBject_CurrencySnapshots", + "description": "OBBject with results of type CurrencySnapshots" }, - "OBBject_CurrencyHistorical": { + "OBBject_DiscountWindowPrimaryCreditRate": { "properties": { "_id": { "type": "string", @@ -47870,21 +54902,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCurrencyHistorical" - }, - { - "$ref": "#/components/schemas/PolygonCurrencyHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencyHistorical", - "polygon": "#/components/schemas/PolygonCurrencyHistorical" - } - } + "$ref": "#/components/schemas/FREDDiscountWindowPrimaryCreditRateData" }, "type": "array" }, @@ -47893,10 +54911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencyHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -47943,10 +54958,10 @@ } }, "type": "object", - "title": "OBBject_CurrencyHistorical", - "description": "OBBject with results of type CurrencyHistorical" + "title": "OBBject_DiscountWindowPrimaryCreditRate", + "description": "OBBject with results of type DiscountWindowPrimaryCreditRate" }, - "OBBject_CurrencyPairs": { + "OBBject_DiscoveryFilings": { "properties": { "_id": { "type": "string", @@ -47956,25 +54971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCurrencyPairs" - }, - { - "$ref": "#/components/schemas/IntrinioCurrencyPairs" - }, - { - "$ref": "#/components/schemas/PolygonCurrencyPairs" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencyPairs", - "intrinio": "#/components/schemas/IntrinioCurrencyPairs", - "polygon": "#/components/schemas/PolygonCurrencyPairs" - } - } + "$ref": "#/components/schemas/FMPDiscoveryFilingsData" }, "type": "array" }, @@ -47983,10 +54980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencyPairs" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48033,10 +55027,10 @@ } }, "type": "object", - "title": "OBBject_CurrencyPairs", - "description": "OBBject with results of type CurrencyPairs" + "title": "OBBject_DiscoveryFilings", + "description": "OBBject with results of type DiscoveryFilings" }, - "OBBject_CurrencyReferenceRates": { + "OBBject_ESTR": { "properties": { "_id": { "type": "string", @@ -48045,27 +55039,17 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/ECBCurrencyReferenceRates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBCurrencyReferenceRates" - } - } + "items": { + "$ref": "#/components/schemas/FREDESTRData" + }, + "type": "array" }, { "type": "null" } ], "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "CurrencyReferenceRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48112,10 +55096,10 @@ } }, "type": "object", - "title": "OBBject_CurrencyReferenceRates", - "description": "OBBject with results of type CurrencyReferenceRates" + "title": "OBBject_ESTR", + "description": "OBBject with results of type ESTR" }, - "OBBject_CurrencySnapshots": { + "OBBject_EUYieldCurve": { "properties": { "_id": { "type": "string", @@ -48125,17 +55109,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPCurrencySnapshots" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPCurrencySnapshots" - } - } + "$ref": "#/components/schemas/ECBEUYieldCurveData" }, "type": "array" }, @@ -48144,10 +55118,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "CurrencySnapshots" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48194,10 +55165,79 @@ } }, "type": "object", - "title": "OBBject_CurrencySnapshots", - "description": "OBBject with results of type CurrencySnapshots" + "title": "OBBject_EUYieldCurve", + "description": "OBBject with results of type EUYieldCurve" }, - "OBBject_DiscountWindowPrimaryCreditRate": { + "OBBject_EarningsCallTranscript": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FMPEarningsCallTranscriptData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "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_EarningsCallTranscript", + "description": "OBBject with results of type EarningsCallTranscript" + }, + "OBBject_EconomicCalendar": { "properties": { "_id": { "type": "string", @@ -48209,15 +55249,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FREDDiscountWindowPrimaryCreditRate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDDiscountWindowPrimaryCreditRate" + "$ref": "#/components/schemas/FMPEconomicCalendarData" + }, + { + "$ref": "#/components/schemas/TEEconomicCalendarData" } - } + ] }, "type": "array" }, @@ -48226,10 +55263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "DiscountWindowPrimaryCreditRate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48276,10 +55310,10 @@ } }, "type": "object", - "title": "OBBject_DiscountWindowPrimaryCreditRate", - "description": "OBBject with results of type DiscountWindowPrimaryCreditRate" + "title": "OBBject_EconomicCalendar", + "description": "OBBject with results of type EconomicCalendar" }, - "OBBject_DiscoveryFilings": { + "OBBject_EconomicIndicators": { "properties": { "_id": { "type": "string", @@ -48289,17 +55323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPDiscoveryFilings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPDiscoveryFilings" - } - } + "$ref": "#/components/schemas/EconDbEconomicIndicatorsData" }, "type": "array" }, @@ -48308,10 +55332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "DiscoveryFilings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48358,10 +55379,10 @@ } }, "type": "object", - "title": "OBBject_DiscoveryFilings", - "description": "OBBject with results of type DiscoveryFilings" + "title": "OBBject_EconomicIndicators", + "description": "OBBject with results of type EconomicIndicators" }, - "OBBject_ESTR": { + "OBBject_EquityFTD": { "properties": { "_id": { "type": "string", @@ -48371,17 +55392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDESTR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDESTR" - } - } + "$ref": "#/components/schemas/SecEquityFtdData" }, "type": "array" }, @@ -48390,10 +55401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ESTR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48440,10 +55448,10 @@ } }, "type": "object", - "title": "OBBject_ESTR", - "description": "OBBject with results of type ESTR" + "title": "OBBject_EquityFTD", + "description": "OBBject with results of type EquityFTD" }, - "OBBject_EUYieldCurve": { + "OBBject_EquityHistorical": { "properties": { "_id": { "type": "string", @@ -48455,15 +55463,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/ECBEUYieldCurve" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "ecb": "#/components/schemas/ECBEUYieldCurve" + "$ref": "#/components/schemas/IntrinioEquityHistoricalData" + }, + { + "$ref": "#/components/schemas/FMPEquityHistoricalData" + }, + { + "$ref": "#/components/schemas/PolygonEquityHistoricalData" } - } + ] }, "type": "array" }, @@ -48472,10 +55480,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EUYieldCurve" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48522,10 +55527,10 @@ } }, "type": "object", - "title": "OBBject_EUYieldCurve", - "description": "OBBject with results of type EUYieldCurve" + "title": "OBBject_EquityHistorical", + "description": "OBBject with results of type EquityHistorical" }, - "OBBject_EarningsCallTranscript": { + "OBBject_EquityInfo": { "properties": { "_id": { "type": "string", @@ -48537,15 +55542,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEarningsCallTranscript" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEarningsCallTranscript" + "$ref": "#/components/schemas/IntrinioEquityInfoData" + }, + { + "$ref": "#/components/schemas/FMPEquityProfileData" } - } + ] }, "type": "array" }, @@ -48554,10 +55556,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EarningsCallTranscript" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48604,10 +55603,10 @@ } }, "type": "object", - "title": "OBBject_EarningsCallTranscript", - "description": "OBBject with results of type EarningsCallTranscript" + "title": "OBBject_EquityInfo", + "description": "OBBject with results of type EquityInfo" }, - "OBBject_EconomicCalendar": { + "OBBject_EquityNBBO": { "properties": { "_id": { "type": "string", @@ -48617,21 +55616,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEconomicCalendar" - }, - { - "$ref": "#/components/schemas/TEEconomicCalendar" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEconomicCalendar", - "tradingeconomics": "#/components/schemas/TEEconomicCalendar" - } - } + "$ref": "#/components/schemas/PolygonEquityNBBOData" }, "type": "array" }, @@ -48640,10 +55625,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EconomicCalendar" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48690,10 +55672,10 @@ } }, "type": "object", - "title": "OBBject_EconomicCalendar", - "description": "OBBject with results of type EconomicCalendar" + "title": "OBBject_EquityNBBO", + "description": "OBBject with results of type EquityNBBO" }, - "OBBject_EquityFTD": { + "OBBject_EquityOwnership": { "properties": { "_id": { "type": "string", @@ -48703,17 +55685,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecEquityFtd" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecEquityFtd" - } - } + "$ref": "#/components/schemas/FMPEquityOwnershipData" }, "type": "array" }, @@ -48722,10 +55694,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityFTD" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48772,10 +55741,75 @@ } }, "type": "object", - "title": "OBBject_EquityFTD", - "description": "OBBject with results of type EquityFTD" + "title": "OBBject_EquityOwnership", + "description": "OBBject with results of type EquityOwnership" }, - "OBBject_EquityHistorical": { + "OBBject_EquityPeers": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/FMPEquityPeersData" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "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_EquityPeers", + "description": "OBBject with results of type EquityPeers" + }, + "OBBject_EquityQuote": { "properties": { "_id": { "type": "string", @@ -48787,23 +55821,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityHistorical" - }, - { - "$ref": "#/components/schemas/IntrinioEquityHistorical" + "$ref": "#/components/schemas/FMPEquityQuoteData" }, { - "$ref": "#/components/schemas/PolygonEquityHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityHistorical", - "intrinio": "#/components/schemas/IntrinioEquityHistorical", - "polygon": "#/components/schemas/PolygonEquityHistorical" + "$ref": "#/components/schemas/IntrinioEquityQuoteData" } - } + ] }, "type": "array" }, @@ -48812,10 +55835,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48862,10 +55882,79 @@ } }, "type": "object", - "title": "OBBject_EquityHistorical", - "description": "OBBject with results of type EquityHistorical" + "title": "OBBject_EquityQuote", + "description": "OBBject with results of type EquityQuote" }, - "OBBject_EquityInfo": { + "OBBject_EquityScreener": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FMPEquityScreenerData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "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_EquityScreener", + "description": "OBBject with results of type EquityScreener" + }, + "OBBject_EquitySearch": { "properties": { "_id": { "type": "string", @@ -48877,19 +55966,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityProfile" + "$ref": "#/components/schemas/SecEquitySearchData" }, { - "$ref": "#/components/schemas/IntrinioEquityInfo" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityProfile", - "intrinio": "#/components/schemas/IntrinioEquityInfo" + "$ref": "#/components/schemas/IntrinioEquitySearchData" } - } + ] }, "type": "array" }, @@ -48898,10 +55980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityInfo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -48948,10 +56027,10 @@ } }, "type": "object", - "title": "OBBject_EquityInfo", - "description": "OBBject with results of type EquityInfo" + "title": "OBBject_EquitySearch", + "description": "OBBject with results of type EquitySearch" }, - "OBBject_EquityNBBO": { + "OBBject_EquityValuationMultiples": { "properties": { "_id": { "type": "string", @@ -48961,17 +56040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/PolygonEquityNBBO" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "polygon": "#/components/schemas/PolygonEquityNBBO" - } - } + "$ref": "#/components/schemas/FMPEquityValuationMultiplesData" }, "type": "array" }, @@ -48980,10 +56049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityNBBO" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49030,10 +56096,10 @@ } }, "type": "object", - "title": "OBBject_EquityNBBO", - "description": "OBBject with results of type EquityNBBO" + "title": "OBBject_EquityValuationMultiples", + "description": "OBBject with results of type EquityValuationMultiples" }, - "OBBject_EquityOwnership": { + "OBBject_EtfCountries": { "properties": { "_id": { "type": "string", @@ -49043,17 +56109,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityOwnership" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityOwnership" - } - } + "$ref": "#/components/schemas/FMPEtfCountriesData" }, "type": "array" }, @@ -49062,10 +56118,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityOwnership" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49112,10 +56165,10 @@ } }, "type": "object", - "title": "OBBject_EquityOwnership", - "description": "OBBject with results of type EquityOwnership" + "title": "OBBject_EtfCountries", + "description": "OBBject with results of type EtfCountries" }, - "OBBject_EquityPeers": { + "OBBject_EtfEquityExposure": { "properties": { "_id": { "type": "string", @@ -49124,27 +56177,17 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityPeers" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityPeers" - } - } + "items": { + "$ref": "#/components/schemas/FMPEtfEquityExposureData" + }, + "type": "array" }, { "type": "null" } ], "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "EquityPeers" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49191,10 +56234,10 @@ } }, "type": "object", - "title": "OBBject_EquityPeers", - "description": "OBBject with results of type EquityPeers" + "title": "OBBject_EtfEquityExposure", + "description": "OBBject with results of type EtfEquityExposure" }, - "OBBject_EquityQuote": { + "OBBject_EtfHistorical": { "properties": { "_id": { "type": "string", @@ -49206,101 +56249,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityQuote" + "$ref": "#/components/schemas/IntrinioEquityHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioEquityQuote" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityQuote", - "intrinio": "#/components/schemas/IntrinioEquityQuote" - } - } - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityQuote" - }, - "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_EquityQuote", - "description": "OBBject with results of type EquityQuote" - }, - "OBBject_EquityScreener": { - "properties": { - "_id": { - "type": "string", - "title": " Id" - }, - "results": { - "anyOf": [ - { - "items": { - "oneOf": [ + "$ref": "#/components/schemas/FMPEquityHistoricalData" + }, { - "$ref": "#/components/schemas/FMPEquityScreener" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityScreener" + "$ref": "#/components/schemas/PolygonEquityHistoricalData" } - } + ] }, "type": "array" }, @@ -49309,10 +56266,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityScreener" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49359,10 +56313,10 @@ } }, "type": "object", - "title": "OBBject_EquityScreener", - "description": "OBBject with results of type EquityScreener" + "title": "OBBject_EtfHistorical", + "description": "OBBject with results of type EtfHistorical" }, - "OBBject_EquitySearch": { + "OBBject_EtfHoldings": { "properties": { "_id": { "type": "string", @@ -49374,19 +56328,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/IntrinioEquitySearch" + "$ref": "#/components/schemas/SecEtfHoldingsData" }, { - "$ref": "#/components/schemas/SecEquitySearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioEquitySearch", - "sec": "#/components/schemas/SecEquitySearch" + "$ref": "#/components/schemas/FMPEtfHoldingsData" + }, + { + "$ref": "#/components/schemas/IntrinioEtfHoldingsData" } - } + ] }, "type": "array" }, @@ -49395,10 +56345,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquitySearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49445,10 +56392,10 @@ } }, "type": "object", - "title": "OBBject_EquitySearch", - "description": "OBBject with results of type EquitySearch" + "title": "OBBject_EtfHoldings", + "description": "OBBject with results of type EtfHoldings" }, - "OBBject_EquityValuationMultiples": { + "OBBject_EtfHoldingsDate": { "properties": { "_id": { "type": "string", @@ -49458,17 +56405,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEquityValuationMultiples" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityValuationMultiples" - } - } + "$ref": "#/components/schemas/FMPEtfHoldingsDateData" }, "type": "array" }, @@ -49477,10 +56414,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EquityValuationMultiples" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49527,10 +56461,10 @@ } }, "type": "object", - "title": "OBBject_EquityValuationMultiples", - "description": "OBBject with results of type EquityValuationMultiples" + "title": "OBBject_EtfHoldingsDate", + "description": "OBBject with results of type EtfHoldingsDate" }, - "OBBject_EtfCountries": { + "OBBject_EtfInfo": { "properties": { "_id": { "type": "string", @@ -49542,15 +56476,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfCountries" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfCountries" + "$ref": "#/components/schemas/IntrinioEtfInfoData" + }, + { + "$ref": "#/components/schemas/FMPEtfInfoData" } - } + ] }, "type": "array" }, @@ -49559,10 +56490,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfCountries" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49609,10 +56537,10 @@ } }, "type": "object", - "title": "OBBject_EtfCountries", - "description": "OBBject with results of type EtfCountries" + "title": "OBBject_EtfInfo", + "description": "OBBject with results of type EtfInfo" }, - "OBBject_EtfEquityExposure": { + "OBBject_EtfPricePerformance": { "properties": { "_id": { "type": "string", @@ -49624,15 +56552,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfEquityExposure" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfEquityExposure" + "$ref": "#/components/schemas/IntrinioEtfPricePerformanceData" + }, + { + "$ref": "#/components/schemas/FMPPricePerformanceData" } - } + ] }, "type": "array" }, @@ -49641,10 +56566,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfEquityExposure" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49691,10 +56613,10 @@ } }, "type": "object", - "title": "OBBject_EtfEquityExposure", - "description": "OBBject with results of type EtfEquityExposure" + "title": "OBBject_EtfPricePerformance", + "description": "OBBject with results of type EtfPricePerformance" }, - "OBBject_EtfHistorical": { + "OBBject_EtfSearch": { "properties": { "_id": { "type": "string", @@ -49706,23 +56628,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEquityHistorical" + "$ref": "#/components/schemas/FMPEtfSearchData" }, { - "$ref": "#/components/schemas/IntrinioEquityHistorical" - }, - { - "$ref": "#/components/schemas/PolygonEquityHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEquityHistorical", - "intrinio": "#/components/schemas/IntrinioEquityHistorical", - "polygon": "#/components/schemas/PolygonEquityHistorical" + "$ref": "#/components/schemas/IntrinioEtfSearchData" } - } + ] }, "type": "array" }, @@ -49731,10 +56642,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49781,10 +56689,10 @@ } }, "type": "object", - "title": "OBBject_EtfHistorical", - "description": "OBBject with results of type EtfHistorical" + "title": "OBBject_EtfSearch", + "description": "OBBject with results of type EtfSearch" }, - "OBBject_EtfHoldings": { + "OBBject_EtfSectors": { "properties": { "_id": { "type": "string", @@ -49794,25 +56702,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfHoldings" - }, - { - "$ref": "#/components/schemas/IntrinioEtfHoldings" - }, - { - "$ref": "#/components/schemas/SecEtfHoldings" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldings", - "intrinio": "#/components/schemas/IntrinioEtfHoldings", - "sec": "#/components/schemas/SecEtfHoldings" - } - } + "$ref": "#/components/schemas/FMPEtfSectorsData" }, "type": "array" }, @@ -49821,10 +56711,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldings" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49871,10 +56758,10 @@ } }, "type": "object", - "title": "OBBject_EtfHoldings", - "description": "OBBject with results of type EtfHoldings" + "title": "OBBject_EtfSectors", + "description": "OBBject with results of type EtfSectors" }, - "OBBject_EtfHoldingsDate": { + "OBBject_EuropeanCentralBankInterestRates": { "properties": { "_id": { "type": "string", @@ -49884,17 +56771,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfHoldingsDate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldingsDate" - } - } + "$ref": "#/components/schemas/FREDEuropeanCentralBankInterestRatesData" }, "type": "array" }, @@ -49903,10 +56780,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldingsDate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -49953,10 +56827,10 @@ } }, "type": "object", - "title": "OBBject_EtfHoldingsDate", - "description": "OBBject with results of type EtfHoldingsDate" + "title": "OBBject_EuropeanCentralBankInterestRates", + "description": "OBBject with results of type EuropeanCentralBankInterestRates" }, - "OBBject_EtfHoldingsPerformance": { + "OBBject_ExecutiveCompensation": { "properties": { "_id": { "type": "string", @@ -49966,17 +56840,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfHoldingsPerformance" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfHoldingsPerformance" - } - } + "$ref": "#/components/schemas/FMPExecutiveCompensationData" }, "type": "array" }, @@ -49985,10 +56849,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfHoldingsPerformance" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50035,10 +56896,10 @@ } }, "type": "object", - "title": "OBBject_EtfHoldingsPerformance", - "description": "OBBject with results of type EtfHoldingsPerformance" + "title": "OBBject_ExecutiveCompensation", + "description": "OBBject with results of type ExecutiveCompensation" }, - "OBBject_EtfInfo": { + "OBBject_FEDFUNDS": { "properties": { "_id": { "type": "string", @@ -50050,19 +56911,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfInfo" + "$ref": "#/components/schemas/FederalReserveFEDData" }, { - "$ref": "#/components/schemas/IntrinioEtfInfo" + "$ref": "#/components/schemas/FREDFEDData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfInfo", - "intrinio": "#/components/schemas/IntrinioEtfInfo" - } - } + ] }, "type": "array" }, @@ -50071,10 +56925,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfInfo" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50121,10 +56972,10 @@ } }, "type": "object", - "title": "OBBject_EtfInfo", - "description": "OBBject with results of type EtfInfo" + "title": "OBBject_FEDFUNDS", + "description": "OBBject with results of type FEDFUNDS" }, - "OBBject_EtfPricePerformance": { + "OBBject_FinancialRatios": { "properties": { "_id": { "type": "string", @@ -50136,19 +56987,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPPricePerformance" + "$ref": "#/components/schemas/IntrinioFinancialRatiosData" }, { - "$ref": "#/components/schemas/IntrinioEtfPricePerformance" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPricePerformance", - "intrinio": "#/components/schemas/IntrinioEtfPricePerformance" + "$ref": "#/components/schemas/FMPFinancialRatiosData" } - } + ] }, "type": "array" }, @@ -50157,10 +57001,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfPricePerformance" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50207,10 +57048,10 @@ } }, "type": "object", - "title": "OBBject_EtfPricePerformance", - "description": "OBBject with results of type EtfPricePerformance" + "title": "OBBject_FinancialRatios", + "description": "OBBject with results of type FinancialRatios" }, - "OBBject_EtfSearch": { + "OBBject_Form13FHR": { "properties": { "_id": { "type": "string", @@ -50220,21 +57061,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPEtfSearch" - }, - { - "$ref": "#/components/schemas/IntrinioEtfSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfSearch", - "intrinio": "#/components/schemas/IntrinioEtfSearch" - } - } + "$ref": "#/components/schemas/SecForm13FHRData" }, "type": "array" }, @@ -50243,10 +57070,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50293,10 +57117,10 @@ } }, "type": "object", - "title": "OBBject_EtfSearch", - "description": "OBBject with results of type EtfSearch" + "title": "OBBject_Form13FHR", + "description": "OBBject with results of type Form13FHR" }, - "OBBject_EtfSectors": { + "OBBject_ForwardEbitdaEstimates": { "properties": { "_id": { "type": "string", @@ -50308,15 +57132,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPEtfSectors" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPEtfSectors" + "$ref": "#/components/schemas/FMPForwardEbitdaEstimatesData" + }, + { + "$ref": "#/components/schemas/IntrinioForwardEbitdaEstimatesData" } - } + ] }, "type": "array" }, @@ -50325,10 +57146,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EtfSectors" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50375,10 +57193,10 @@ } }, "type": "object", - "title": "OBBject_EtfSectors", - "description": "OBBject with results of type EtfSectors" + "title": "OBBject_ForwardEbitdaEstimates", + "description": "OBBject with results of type ForwardEbitdaEstimates" }, - "OBBject_EuropeanCentralBankInterestRates": { + "OBBject_ForwardEpsEstimates": { "properties": { "_id": { "type": "string", @@ -50390,15 +57208,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FREDEuropeanCentralBankInterestRates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDEuropeanCentralBankInterestRates" + "$ref": "#/components/schemas/IntrinioForwardEpsEstimatesData" + }, + { + "$ref": "#/components/schemas/FMPForwardEpsEstimatesData" } - } + ] }, "type": "array" }, @@ -50407,10 +57222,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "EuropeanCentralBankInterestRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50457,10 +57269,10 @@ } }, "type": "object", - "title": "OBBject_EuropeanCentralBankInterestRates", - "description": "OBBject with results of type EuropeanCentralBankInterestRates" + "title": "OBBject_ForwardEpsEstimates", + "description": "OBBject with results of type ForwardEpsEstimates" }, - "OBBject_ExecutiveCompensation": { + "OBBject_ForwardPeEstimates": { "properties": { "_id": { "type": "string", @@ -50470,17 +57282,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPExecutiveCompensation" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPExecutiveCompensation" - } - } + "$ref": "#/components/schemas/IntrinioForwardPeEstimatesData" }, "type": "array" }, @@ -50489,10 +57291,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ExecutiveCompensation" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50539,10 +57338,10 @@ } }, "type": "object", - "title": "OBBject_ExecutiveCompensation", - "description": "OBBject with results of type ExecutiveCompensation" + "title": "OBBject_ForwardPeEstimates", + "description": "OBBject with results of type ForwardPeEstimates" }, - "OBBject_FEDFUNDS": { + "OBBject_ForwardSalesEstimates": { "properties": { "_id": { "type": "string", @@ -50552,21 +57351,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FederalReserveFED" - }, - { - "$ref": "#/components/schemas/FREDFED" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveFED", - "fred": "#/components/schemas/FREDFED" - } - } + "$ref": "#/components/schemas/IntrinioForwardSalesEstimatesData" }, "type": "array" }, @@ -50575,10 +57360,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FEDFUNDS" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50625,10 +57407,10 @@ } }, "type": "object", - "title": "OBBject_FEDFUNDS", - "description": "OBBject with results of type FEDFUNDS" + "title": "OBBject_ForwardSalesEstimates", + "description": "OBBject with results of type ForwardSalesEstimates" }, - "OBBject_FinancialRatios": { + "OBBject_FredRegional": { "properties": { "_id": { "type": "string", @@ -50638,21 +57420,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPFinancialRatios" - }, - { - "$ref": "#/components/schemas/IntrinioFinancialRatios" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPFinancialRatios", - "intrinio": "#/components/schemas/IntrinioFinancialRatios" - } - } + "$ref": "#/components/schemas/FredRegionalData" }, "type": "array" }, @@ -50661,10 +57429,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FinancialRatios" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50711,10 +57476,10 @@ } }, "type": "object", - "title": "OBBject_FinancialRatios", - "description": "OBBject with results of type FinancialRatios" + "title": "OBBject_FredRegional", + "description": "OBBject with results of type FredRegional" }, - "OBBject_Form13FHR": { + "OBBject_FredSearch": { "properties": { "_id": { "type": "string", @@ -50724,17 +57489,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecForm13FHR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecForm13FHR" - } - } + "$ref": "#/components/schemas/FredSearchData" }, "type": "array" }, @@ -50743,10 +57498,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "Form13FHR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50793,10 +57545,10 @@ } }, "type": "object", - "title": "OBBject_Form13FHR", - "description": "OBBject with results of type Form13FHR" + "title": "OBBject_FredSearch", + "description": "OBBject with results of type FredSearch" }, - "OBBject_FredRegional": { + "OBBject_FredSeries": { "properties": { "_id": { "type": "string", @@ -50808,15 +57560,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FredRegional" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredRegional" + "$ref": "#/components/schemas/FredSeriesData" + }, + { + "$ref": "#/components/schemas/IntrinioFredSeriesData" } - } + ] }, "type": "array" }, @@ -50825,10 +57574,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredRegional" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50875,10 +57621,10 @@ } }, "type": "object", - "title": "OBBject_FredRegional", - "description": "OBBject with results of type FredRegional" + "title": "OBBject_FredSeries", + "description": "OBBject with results of type FredSeries" }, - "OBBject_FredSearch": { + "OBBject_GdpForecast": { "properties": { "_id": { "type": "string", @@ -50888,17 +57634,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FredSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredSearch" - } - } + "$ref": "#/components/schemas/OECDGdpForecastData" }, "type": "array" }, @@ -50907,10 +57643,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -50957,10 +57690,10 @@ } }, "type": "object", - "title": "OBBject_FredSearch", - "description": "OBBject with results of type FredSearch" + "title": "OBBject_GdpForecast", + "description": "OBBject with results of type GdpForecast" }, - "OBBject_FredSeries": { + "OBBject_GdpNominal": { "properties": { "_id": { "type": "string", @@ -50970,21 +57703,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FredSeries" - }, - { - "$ref": "#/components/schemas/IntrinioFredSeries" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FredSeries", - "intrinio": "#/components/schemas/IntrinioFredSeries" - } - } + "$ref": "#/components/schemas/OECDGdpNominalData" }, "type": "array" }, @@ -50993,10 +57712,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "FredSeries" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51043,10 +57759,10 @@ } }, "type": "object", - "title": "OBBject_FredSeries", - "description": "OBBject with results of type FredSeries" + "title": "OBBject_GdpNominal", + "description": "OBBject with results of type GdpNominal" }, - "OBBject_GdpForecast": { + "OBBject_GdpReal": { "properties": { "_id": { "type": "string", @@ -51056,17 +57772,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpForecast" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpForecast" - } - } + "$ref": "#/components/schemas/OECDGdpRealData" }, "type": "array" }, @@ -51075,10 +57781,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpForecast" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51125,10 +57828,10 @@ } }, "type": "object", - "title": "OBBject_GdpForecast", - "description": "OBBject with results of type GdpForecast" + "title": "OBBject_GdpReal", + "description": "OBBject with results of type GdpReal" }, - "OBBject_GdpNominal": { + "OBBject_GroupedComparisons": { "properties": { "_id": { "type": "string", @@ -51137,30 +57840,13 @@ "results": { "anyOf": [ { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpNominal" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpNominal" - } - } - }, - "type": "array" + "$ref": "#/components/schemas/GroupedComparisons" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpNominal" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51207,10 +57893,10 @@ } }, "type": "object", - "title": "OBBject_GdpNominal", - "description": "OBBject with results of type GdpNominal" + "title": "OBBject_GroupedComparisons", + "description": "OBBject with results of type GroupedComparisons" }, - "OBBject_GdpReal": { + "OBBject_GroupedFinancials": { "properties": { "_id": { "type": "string", @@ -51219,30 +57905,13 @@ "results": { "anyOf": [ { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDGdpReal" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDGdpReal" - } - } - }, - "type": "array" + "$ref": "#/components/schemas/GroupedFinancials" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "GdpReal" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51289,8 +57958,8 @@ } }, "type": "object", - "title": "OBBject_GdpReal", - "description": "OBBject with results of type GdpReal" + "title": "OBBject_GroupedFinancials", + "description": "OBBject with results of type GroupedFinancials" }, "OBBject_HighQualityMarketCorporateBond": { "properties": { @@ -51302,17 +57971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDHighQualityMarketCorporateBond" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDHighQualityMarketCorporateBond" - } - } + "$ref": "#/components/schemas/FREDHighQualityMarketCorporateBondData" }, "type": "array" }, @@ -51321,10 +57980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HighQualityMarketCorporateBond" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51384,17 +58040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioHistoricalAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioHistoricalAttributes" - } - } + "$ref": "#/components/schemas/IntrinioHistoricalAttributesData" }, "type": "array" }, @@ -51403,10 +58049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51468,19 +58111,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPHistoricalDividends" + "$ref": "#/components/schemas/FMPHistoricalDividendsData" }, { - "$ref": "#/components/schemas/IntrinioHistoricalDividends" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalDividends", - "intrinio": "#/components/schemas/IntrinioHistoricalDividends" + "$ref": "#/components/schemas/IntrinioHistoricalDividendsData" } - } + ] }, "type": "array" }, @@ -51489,10 +58125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalDividends" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51552,17 +58185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalEmployees" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalEmployees" - } - } + "$ref": "#/components/schemas/FMPHistoricalEmployeesData" }, "type": "array" }, @@ -51571,10 +58194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalEmployees" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51634,17 +58254,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalEps" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalEps" - } - } + "$ref": "#/components/schemas/FMPHistoricalEpsData" }, "type": "array" }, @@ -51653,10 +58263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalEps" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51716,17 +58323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPHistoricalSplits" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPHistoricalSplits" - } - } + "$ref": "#/components/schemas/FMPHistoricalSplitsData" }, "type": "array" }, @@ -51735,10 +58332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "HistoricalSplits" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51798,17 +58392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDICEBofA" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDICEBofA" - } - } + "$ref": "#/components/schemas/FREDICEBofAData" }, "type": "array" }, @@ -51817,10 +58401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ICEBofA" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51880,17 +58461,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDIORB" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDIORB" - } - } + "$ref": "#/components/schemas/FREDIORBData" }, "type": "array" }, @@ -51899,10 +58470,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IORB" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -51964,23 +58532,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIncomeStatement" + "$ref": "#/components/schemas/FMPIncomeStatementData" }, { - "$ref": "#/components/schemas/IntrinioIncomeStatement" + "$ref": "#/components/schemas/PolygonIncomeStatementData" }, { - "$ref": "#/components/schemas/PolygonIncomeStatement" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIncomeStatement", - "intrinio": "#/components/schemas/IntrinioIncomeStatement", - "polygon": "#/components/schemas/PolygonIncomeStatement" + "$ref": "#/components/schemas/IntrinioIncomeStatementData" } - } + ] }, "type": "array" }, @@ -51989,10 +58549,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IncomeStatement" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52052,17 +58609,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPIncomeStatementGrowth" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIncomeStatementGrowth" - } - } + "$ref": "#/components/schemas/FMPIncomeStatementGrowthData" }, "type": "array" }, @@ -52071,10 +58618,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IncomeStatementGrowth" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52134,17 +58678,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPIndexConstituents" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexConstituents" - } - } + "$ref": "#/components/schemas/FMPIndexConstituentsData" }, "type": "array" }, @@ -52153,10 +58687,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IndexConstituents" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52218,23 +58749,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIndexHistorical" + "$ref": "#/components/schemas/FMPIndexHistoricalData" }, { - "$ref": "#/components/schemas/IntrinioIndexHistorical" + "$ref": "#/components/schemas/PolygonIndexHistoricalData" }, { - "$ref": "#/components/schemas/PolygonIndexHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexHistorical", - "intrinio": "#/components/schemas/IntrinioIndexHistorical", - "polygon": "#/components/schemas/PolygonIndexHistorical" + "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } - } + ] }, "type": "array" }, @@ -52243,10 +58766,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "IndexHistorical" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52308,19 +58828,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPInsiderTrading" + "$ref": "#/components/schemas/IntrinioInsiderTradingData" }, { - "$ref": "#/components/schemas/IntrinioInsiderTrading" + "$ref": "#/components/schemas/FMPInsiderTradingData" } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPInsiderTrading", - "intrinio": "#/components/schemas/IntrinioInsiderTrading" - } - } + ] }, "type": "array" }, @@ -52329,10 +58842,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InsiderTrading" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52392,17 +58902,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPInstitutionalOwnership" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPInstitutionalOwnership" - } - } + "$ref": "#/components/schemas/FMPInstitutionalOwnershipData" }, "type": "array" }, @@ -52411,10 +58911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InstitutionalOwnership" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52474,17 +58971,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecInstitutionsSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecInstitutionsSearch" - } - } + "$ref": "#/components/schemas/SecInstitutionsSearchData" }, "type": "array" }, @@ -52493,10 +58980,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "InstitutionsSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52556,17 +59040,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPKeyExecutives" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPKeyExecutives" - } - } + "$ref": "#/components/schemas/FMPKeyExecutivesData" }, "type": "array" }, @@ -52575,10 +59049,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "KeyExecutives" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52640,19 +59111,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPKeyMetrics" + "$ref": "#/components/schemas/IntrinioKeyMetricsData" }, { - "$ref": "#/components/schemas/IntrinioKeyMetrics" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPKeyMetrics", - "intrinio": "#/components/schemas/IntrinioKeyMetrics" + "$ref": "#/components/schemas/FMPKeyMetricsData" } - } + ] }, "type": "array" }, @@ -52661,10 +59125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "KeyMetrics" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52724,17 +59185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDLTIR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDLTIR" - } - } + "$ref": "#/components/schemas/OECDLTIRData" }, "type": "array" }, @@ -52743,10 +59194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "LTIR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52797,6 +59245,75 @@ "description": "OBBject with results of type LTIR" }, "OBBject_LatestAttributes": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IntrinioLatestAttributesData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "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_LatestAttributes", + "description": "OBBject with results of type LatestAttributes" + }, + "OBBject_MarketIndices": { "properties": { "_id": { "type": "string", @@ -52808,15 +59325,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/IntrinioLatestAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioLatestAttributes" + "$ref": "#/components/schemas/FMPIndexHistoricalData" + }, + { + "$ref": "#/components/schemas/PolygonIndexHistoricalData" + }, + { + "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } - } + ] }, "type": "array" }, @@ -52825,10 +59342,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "LatestAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52875,10 +59389,10 @@ } }, "type": "object", - "title": "OBBject_LatestAttributes", - "description": "OBBject with results of type LatestAttributes" + "title": "OBBject_MarketIndices", + "description": "OBBject with results of type MarketIndices" }, - "OBBject_MarketIndices": { + "OBBject_MarketSnapshots": { "properties": { "_id": { "type": "string", @@ -52890,23 +59404,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPIndexHistorical" + "$ref": "#/components/schemas/FMPMarketSnapshotsData" }, { - "$ref": "#/components/schemas/IntrinioIndexHistorical" + "$ref": "#/components/schemas/PolygonMarketSnapshotsData" }, { - "$ref": "#/components/schemas/PolygonIndexHistorical" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPIndexHistorical", - "intrinio": "#/components/schemas/IntrinioIndexHistorical", - "polygon": "#/components/schemas/PolygonIndexHistorical" + "$ref": "#/components/schemas/IntrinioMarketSnapshotsData" } - } + ] }, "type": "array" }, @@ -52915,10 +59421,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MarketIndices" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -52965,10 +59468,10 @@ } }, "type": "object", - "title": "OBBject_MarketIndices", - "description": "OBBject with results of type MarketIndices" + "title": "OBBject_MarketSnapshots", + "description": "OBBject with results of type MarketSnapshots" }, - "OBBject_MarketSnapshots": { + "OBBject_MoneyMeasures": { "properties": { "_id": { "type": "string", @@ -52978,25 +59481,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPMarketSnapshots" - }, - { - "$ref": "#/components/schemas/IntrinioMarketSnapshots" - }, - { - "$ref": "#/components/schemas/PolygonMarketSnapshots" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPMarketSnapshots", - "intrinio": "#/components/schemas/IntrinioMarketSnapshots", - "polygon": "#/components/schemas/PolygonMarketSnapshots" - } - } + "$ref": "#/components/schemas/FederalReserveMoneyMeasuresData" }, "type": "array" }, @@ -53005,10 +59490,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MarketSnapshots" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53055,10 +59537,10 @@ } }, "type": "object", - "title": "OBBject_MarketSnapshots", - "description": "OBBject with results of type MarketSnapshots" + "title": "OBBject_MoneyMeasures", + "description": "OBBject with results of type MoneyMeasures" }, - "OBBject_MoneyMeasures": { + "OBBject_MoodyCorporateBondIndex": { "properties": { "_id": { "type": "string", @@ -53068,17 +59550,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FederalReserveMoneyMeasures" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveMoneyMeasures" - } - } + "$ref": "#/components/schemas/FREDMoodyCorporateBondIndexData" }, "type": "array" }, @@ -53087,10 +59559,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MoneyMeasures" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53137,10 +59606,10 @@ } }, "type": "object", - "title": "OBBject_MoneyMeasures", - "description": "OBBject with results of type MoneyMeasures" + "title": "OBBject_MoodyCorporateBondIndex", + "description": "OBBject with results of type MoodyCorporateBondIndex" }, - "OBBject_MoodyCorporateBondIndex": { + "OBBject_OptionsChains": { "properties": { "_id": { "type": "string", @@ -53150,17 +59619,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDMoodyCorporateBondIndex" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDMoodyCorporateBondIndex" - } - } + "$ref": "#/components/schemas/IntrinioOptionsChainsData" }, "type": "array" }, @@ -53169,10 +59628,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "MoodyCorporateBondIndex" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53219,10 +59675,10 @@ } }, "type": "object", - "title": "OBBject_MoodyCorporateBondIndex", - "description": "OBBject with results of type MoodyCorporateBondIndex" + "title": "OBBject_OptionsChains", + "description": "OBBject with results of type OptionsChains" }, - "OBBject_OptionsChains": { + "OBBject_OptionsUnusual": { "properties": { "_id": { "type": "string", @@ -53232,17 +59688,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioOptionsChains" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioOptionsChains" - } - } + "$ref": "#/components/schemas/IntrinioOptionsUnusualData" }, "type": "array" }, @@ -53251,10 +59697,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "OptionsChains" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53301,10 +59744,10 @@ } }, "type": "object", - "title": "OBBject_OptionsChains", - "description": "OBBject with results of type OptionsChains" + "title": "OBBject_OptionsUnusual", + "description": "OBBject with results of type OptionsUnusual" }, - "OBBject_OptionsUnusual": { + "OBBject_PROJECTIONS": { "properties": { "_id": { "type": "string", @@ -53314,17 +59757,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioOptionsUnusual" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioOptionsUnusual" - } - } + "$ref": "#/components/schemas/FREDPROJECTIONData" }, "type": "array" }, @@ -53333,10 +59766,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "OptionsUnusual" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53383,10 +59813,10 @@ } }, "type": "object", - "title": "OBBject_OptionsUnusual", - "description": "OBBject with results of type OptionsUnusual" + "title": "OBBject_PROJECTIONS", + "description": "OBBject with results of type PROJECTIONS" }, - "OBBject_PROJECTIONS": { + "OBBject_PricePerformance": { "properties": { "_id": { "type": "string", @@ -53396,17 +59826,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDPROJECTION" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDPROJECTION" - } - } + "$ref": "#/components/schemas/FMPPricePerformanceData" }, "type": "array" }, @@ -53415,10 +59835,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PROJECTIONS" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53465,10 +59882,10 @@ } }, "type": "object", - "title": "OBBject_PROJECTIONS", - "description": "OBBject with results of type PROJECTIONS" + "title": "OBBject_PricePerformance", + "description": "OBBject with results of type PricePerformance" }, - "OBBject_PricePerformance": { + "OBBject_PriceTarget": { "properties": { "_id": { "type": "string", @@ -53480,15 +59897,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPPricePerformance" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPricePerformance" + "$ref": "#/components/schemas/BenzingaPriceTargetData" + }, + { + "$ref": "#/components/schemas/FMPPriceTargetData" } - } + ] }, "type": "array" }, @@ -53497,10 +59911,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PricePerformance" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53547,10 +59958,10 @@ } }, "type": "object", - "title": "OBBject_PricePerformance", - "description": "OBBject with results of type PricePerformance" + "title": "OBBject_PriceTarget", + "description": "OBBject with results of type PriceTarget" }, - "OBBject_PriceTarget": { + "OBBject_PriceTargetConsensus": { "properties": { "_id": { "type": "string", @@ -53562,19 +59973,12 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaPriceTarget" + "$ref": "#/components/schemas/FMPPriceTargetConsensusData" }, { - "$ref": "#/components/schemas/FMPPriceTarget" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaPriceTarget", - "fmp": "#/components/schemas/FMPPriceTarget" + "$ref": "#/components/schemas/IntrinioPriceTargetConsensusData" } - } + ] }, "type": "array" }, @@ -53583,10 +59987,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PriceTarget" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53633,10 +60034,10 @@ } }, "type": "object", - "title": "OBBject_PriceTarget", - "description": "OBBject with results of type PriceTarget" + "title": "OBBject_PriceTargetConsensus", + "description": "OBBject with results of type PriceTargetConsensus" }, - "OBBject_PriceTargetConsensus": { + "OBBject_ProKeyMetrics": { "properties": { "_id": { "type": "string", @@ -53646,17 +60047,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPPriceTargetConsensus" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPPriceTargetConsensus" - } - } + "$ref": "#/components/schemas/ProKeyMetrics" }, "type": "array" }, @@ -53665,10 +60056,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "PriceTargetConsensus" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53715,8 +60103,8 @@ } }, "type": "object", - "title": "OBBject_PriceTargetConsensus", - "description": "OBBject with results of type PriceTargetConsensus" + "title": "OBBject_ProKeyMetrics", + "description": "OBBject with results of type ProKeyMetrics" }, "OBBject_ReportedFinancials": { "properties": { @@ -53728,17 +60116,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioReportedFinancials" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioReportedFinancials" - } - } + "$ref": "#/components/schemas/IntrinioReportedFinancialsData" }, "type": "array" }, @@ -53747,10 +60125,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ReportedFinancials" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53810,17 +60185,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRevenueBusinessLine" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRevenueBusinessLine" - } - } + "$ref": "#/components/schemas/FMPRevenueBusinessLineData" }, "type": "array" }, @@ -53829,10 +60194,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RevenueBusinessLine" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53892,17 +60254,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRevenueGeographic" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRevenueGeographic" - } - } + "$ref": "#/components/schemas/FMPRevenueGeographicData" }, "type": "array" }, @@ -53911,10 +60263,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RevenueGeographic" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -53974,17 +60323,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FMPRiskPremium" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPRiskPremium" - } - } + "$ref": "#/components/schemas/FMPRiskPremiumData" }, "type": "array" }, @@ -53993,10 +60332,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RiskPremium" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54056,17 +60392,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecRssLitigation" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecRssLitigation" - } - } + "$ref": "#/components/schemas/SecRssLitigationData" }, "type": "array" }, @@ -54075,10 +60401,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "RssLitigation" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54138,17 +60461,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSOFR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSOFR" - } - } + "$ref": "#/components/schemas/FREDSOFRData" }, "type": "array" }, @@ -54157,10 +60470,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SOFR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54220,17 +60530,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSONIA" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSONIA" - } - } + "$ref": "#/components/schemas/FREDSONIAData" }, "type": "array" }, @@ -54239,10 +60539,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SONIA" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54302,17 +60599,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/OECDSTIR" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDSTIR" - } - } + "$ref": "#/components/schemas/OECDSTIRData" }, "type": "array" }, @@ -54321,10 +60608,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "STIR" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54383,27 +60667,13 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSchemaFiles" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSchemaFiles" - } - } + "$ref": "#/components/schemas/SecSchemaFilesData" }, { "type": "null" } ], - "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "SchemaFiles" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54463,17 +60733,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/IntrinioSearchAttributes" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "intrinio": "#/components/schemas/IntrinioSearchAttributes" - } - } + "$ref": "#/components/schemas/IntrinioSearchAttributesData" }, "type": "array" }, @@ -54482,10 +60742,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SearchAttributes" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54545,17 +60802,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSelectedTreasuryBill" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSelectedTreasuryBill" - } - } + "$ref": "#/components/schemas/FREDSelectedTreasuryBillData" }, "type": "array" }, @@ -54564,10 +60811,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SelectedTreasuryBill" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54627,17 +60871,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSelectedTreasuryConstantMaturity" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSelectedTreasuryConstantMaturity" - } - } + "$ref": "#/components/schemas/FREDSelectedTreasuryConstantMaturityData" }, "type": "array" }, @@ -54646,10 +60880,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SelectedTreasuryConstantMaturity" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54711,19 +60942,81 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/FMPShareStatistics" + "$ref": "#/components/schemas/IntrinioShareStatisticsData" }, { - "$ref": "#/components/schemas/IntrinioShareStatistics" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fmp": "#/components/schemas/FMPShareStatistics", - "intrinio": "#/components/schemas/IntrinioShareStatistics" + "$ref": "#/components/schemas/FMPShareStatisticsData" } - } + ] + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "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_ShareStatistics", + "description": "OBBject with results of type ShareStatistics" + }, + "OBBject_SicSearch": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SecSicSearchData" }, "type": "array" }, @@ -54732,10 +61025,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "ShareStatistics" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54782,10 +61072,10 @@ } }, "type": "object", - "title": "OBBject_ShareStatistics", - "description": "OBBject with results of type ShareStatistics" + "title": "OBBject_SicSearch", + "description": "OBBject with results of type SicSearch" }, - "OBBject_SicSearch": { + "OBBject_SpotRate": { "properties": { "_id": { "type": "string", @@ -54795,17 +61085,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSicSearch" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSicSearch" - } - } + "$ref": "#/components/schemas/FREDSpotRateData" }, "type": "array" }, @@ -54814,10 +61094,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SicSearch" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54864,30 +61141,85 @@ } }, "type": "object", - "title": "OBBject_SicSearch", - "description": "OBBject with results of type SicSearch" + "title": "OBBject_SpotRate", + "description": "OBBject with results of type SpotRate" }, - "OBBject_SpotRate": { + "OBBject_SymbolMap": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { + "anyOf": [ + { + "$ref": "#/components/schemas/SecSymbolMapData" + }, + { + "type": "null" + } + ], + "description": "Serializable results." + }, + "provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Provider", + "description": "Provider name." + }, + "warnings": { "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDSpotRate" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDSpotRate" - } - } + "$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_SymbolMap", + "description": "OBBject with results of type SymbolMap" + }, + "OBBject_TreasuryConstantMaturity": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FREDTreasuryConstantMaturityData" }, "type": "array" }, @@ -54896,10 +61228,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "SpotRate" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -54946,10 +61275,10 @@ } }, "type": "object", - "title": "OBBject_SpotRate", - "description": "OBBject with results of type SpotRate" + "title": "OBBject_TreasuryConstantMaturity", + "description": "OBBject with results of type TreasuryConstantMaturity" }, - "OBBject_SymbolMap": { + "OBBject_TreasuryRates": { "properties": { "_id": { "type": "string", @@ -54958,27 +61287,24 @@ "results": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/SecSymbolMap" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "sec": "#/components/schemas/SecSymbolMap" - } - } + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FMPTreasuryRatesData" + }, + { + "$ref": "#/components/schemas/FederalReserveTreasuryRatesData" + } + ] + }, + "type": "array" }, { "type": "null" } ], "title": "Results", - "description": "Serializable results.", - "has_list": false, - "is_union": false, - "model": "SymbolMap" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55025,10 +61351,10 @@ } }, "type": "object", - "title": "OBBject_SymbolMap", - "description": "OBBject with results of type SymbolMap" + "title": "OBBject_TreasuryRates", + "description": "OBBject with results of type TreasuryRates" }, - "OBBject_TreasuryConstantMaturity": { + "OBBject_USYieldCurve": { "properties": { "_id": { "type": "string", @@ -55038,17 +61364,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDTreasuryConstantMaturity" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDTreasuryConstantMaturity" - } - } + "$ref": "#/components/schemas/openbb_fred__models__us_yield_curve__FREDYieldCurveData" }, "type": "array" }, @@ -55057,10 +61373,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "TreasuryConstantMaturity" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55107,10 +61420,10 @@ } }, "type": "object", - "title": "OBBject_TreasuryConstantMaturity", - "description": "OBBject with results of type TreasuryConstantMaturity" + "title": "OBBject_USYieldCurve", + "description": "OBBject with results of type USYieldCurve" }, - "OBBject_TreasuryRates": { + "OBBject_Unemployment": { "properties": { "_id": { "type": "string", @@ -55120,21 +61433,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FederalReserveTreasuryRates" - }, - { - "$ref": "#/components/schemas/FMPTreasuryRates" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "federal_reserve": "#/components/schemas/FederalReserveTreasuryRates", - "fmp": "#/components/schemas/FMPTreasuryRates" - } - } + "$ref": "#/components/schemas/OECDUnemploymentData" }, "type": "array" }, @@ -55143,10 +61442,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "TreasuryRates" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55193,10 +61489,10 @@ } }, "type": "object", - "title": "OBBject_TreasuryRates", - "description": "OBBject with results of type TreasuryRates" + "title": "OBBject_Unemployment", + "description": "OBBject with results of type Unemployment" }, - "OBBject_USYieldCurve": { + "OBBject_Watchlist": { "properties": { "_id": { "type": "string", @@ -55206,17 +61502,7 @@ "anyOf": [ { "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FREDYieldCurve" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "fred": "#/components/schemas/FREDYieldCurve" - } - } + "$ref": "#/components/schemas/Watchlist" }, "type": "array" }, @@ -55225,10 +61511,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "USYieldCurve" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55275,10 +61558,10 @@ } }, "type": "object", - "title": "OBBject_USYieldCurve", - "description": "OBBject with results of type USYieldCurve" + "title": "OBBject_Watchlist", + "description": "OBBject with results of type Watchlist" }, - "OBBject_Unemployment": { + "OBBject_WorldNews": { "properties": { "_id": { "type": "string", @@ -55290,15 +61573,15 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/OECDUnemployment" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "oecd": "#/components/schemas/OECDUnemployment" + "$ref": "#/components/schemas/IntrinioWorldNewsData" + }, + { + "$ref": "#/components/schemas/BenzingaWorldNewsData" + }, + { + "$ref": "#/components/schemas/FMPWorldNewsData" } - } + ] }, "type": "array" }, @@ -55307,10 +61590,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "Unemployment" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55357,10 +61637,10 @@ } }, "type": "object", - "title": "OBBject_Unemployment", - "description": "OBBject with results of type Unemployment" + "title": "OBBject_WorldNews", + "description": "OBBject with results of type WorldNews" }, - "OBBject_WorldNews": { + "OBBject_YieldCurve": { "properties": { "_id": { "type": "string", @@ -55372,23 +61652,21 @@ "items": { "oneOf": [ { - "$ref": "#/components/schemas/BenzingaWorldNews" + "$ref": "#/components/schemas/FMPYieldCurveData" }, { - "$ref": "#/components/schemas/FMPWorldNews" + "$ref": "#/components/schemas/openbb_fred__models__yield_curve__FREDYieldCurveData" }, { - "$ref": "#/components/schemas/IntrinioWorldNews" - } - ], - "discriminator": { - "propertyName": "provider", - "mapping": { - "benzinga": "#/components/schemas/BenzingaWorldNews", - "fmp": "#/components/schemas/FMPWorldNews", - "intrinio": "#/components/schemas/IntrinioWorldNews" + "$ref": "#/components/schemas/EconDbYieldCurveData" + }, + { + "$ref": "#/components/schemas/FederalReserveYieldCurveData" + }, + { + "$ref": "#/components/schemas/ECBYieldCurveData" } - } + ] }, "type": "array" }, @@ -55397,10 +61675,7 @@ } ], "title": "Results", - "description": "Serializable results.", - "has_list": true, - "is_union": false, - "model": "WorldNews" + "description": "Serializable results." }, "provider": { "anyOf": [ @@ -55447,10 +61722,79 @@ } }, "type": "object", - "title": "OBBject_WorldNews", - "description": "OBBject with results of type WorldNews" + "title": "OBBject_YieldCurve", + "description": "OBBject with results of type YieldCurve" + }, + "OBBject_list_NixtlaTimegenData__": { + "properties": { + "_id": { + "type": "string", + "title": " Id" + }, + "results": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/NixtlaTimegenData" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Results", + "description": "Serializable results." + }, + "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[T]", + "description": "OBBject" }, - "OECDCLI": { + "OECDCLIData": { "properties": { "date": { "anyOf": [ @@ -55492,10 +61836,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDCLI", + "title": "OECDCLIData", "description": "OECD CLI Data." }, - "OECDGdpForecast": { + "OECDGdpForecastData": { "properties": { "date": { "anyOf": [ @@ -55525,10 +61869,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpForecast", + "title": "OECDGdpForecastData", "description": "OECD GDP Forecast Data." }, - "OECDGdpNominal": { + "OECDGdpNominalData": { "properties": { "date": { "anyOf": [ @@ -55558,10 +61902,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpNominal", + "title": "OECDGdpNominalData", "description": "OECD Nominal GDP Data." }, - "OECDGdpReal": { + "OECDGdpRealData": { "properties": { "date": { "anyOf": [ @@ -55591,10 +61935,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDGdpReal", + "title": "OECDGdpRealData", "description": "OECD Real GDP Data." }, - "OECDLTIR": { + "OECDLTIRData": { "properties": { "date": { "anyOf": [ @@ -55636,10 +61980,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDLTIR", + "title": "OECDLTIRData", "description": "OECD Long Term Interest Rate Data." }, - "OECDSTIR": { + "OECDSTIRData": { "properties": { "date": { "anyOf": [ @@ -55681,10 +62025,10 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDSTIR", + "title": "OECDSTIRData", "description": "OECD Short Term Interest Rate Data." }, - "OECDUnemployment": { + "OECDUnemploymentData": { "properties": { "date": { "anyOf": [ @@ -55726,7 +62070,7 @@ }, "additionalProperties": true, "type": "object", - "title": "OECDUnemployment", + "title": "OECDUnemploymentData", "description": "OECD Unemployment Data." }, "OpenBBErrorResponse": { @@ -55748,7 +62092,7 @@ "title": "OpenBBErrorResponse", "description": "OpenBB Error Response." }, - "PolygonBalanceSheet": { + "PolygonBalanceSheetData": { "properties": { "period_ending": { "type": "string", @@ -56134,10 +62478,10 @@ "required": [ "period_ending" ], - "title": "PolygonBalanceSheet", + "title": "PolygonBalanceSheetData", "description": "Polygon Balance Sheet Statement Data." }, - "PolygonCashFlowStatement": { + "PolygonCashFlowStatementData": { "properties": { "period_ending": { "type": "string", @@ -56331,10 +62675,10 @@ "required": [ "period_ending" ], - "title": "PolygonCashFlowStatement", + "title": "PolygonCashFlowStatementData", "description": "Polygon Cash Flow Statement Data." }, - "PolygonCompanyNews": { + "PolygonCompanyNewsData": { "properties": { "date": { "type": "string", @@ -56453,10 +62797,10 @@ "id", "publisher" ], - "title": "PolygonCompanyNews", + "title": "PolygonCompanyNewsData", "description": "Polygon Company News Data." }, - "PolygonCryptoHistorical": { + "PolygonCryptoHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56514,7 +62858,7 @@ "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -56524,7 +62868,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -56538,10 +62882,10 @@ "close", "volume" ], - "title": "PolygonCryptoHistorical", + "title": "PolygonCryptoHistoricalData", "description": "Polygon Crypto Historical Price Data." }, - "PolygonCurrencyHistorical": { + "PolygonCurrencyHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56629,27 +62973,17 @@ "low", "close" ], - "title": "PolygonCurrencyHistorical", + "title": "PolygonCurrencyHistoricalData", "description": "Polygon Currency Historical Price Data." }, - "PolygonCurrencyPairs": { + "PolygonCurrencyPairsData": { "properties": { - "name": { - "type": "string", - "title": "Name", - "description": "Name of the currency pair." - }, - "market": { - "type": "string", - "title": "Market", - "description": "Name of the trading market. Always 'fx'." - }, - "locale": { + "symbol": { "type": "string", - "title": "Locale", - "description": "Locale of the currency pair." + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." }, - "currency_symbol": { + "name": { "anyOf": [ { "type": "string" @@ -56658,10 +62992,10 @@ "type": "null" } ], - "title": "Currency Symbol", - "description": "The symbol of the quote currency." + "title": "Name", + "description": "Name of the currency pair." }, - "currency_name": { + "currency_symbol": { "anyOf": [ { "type": "string" @@ -56670,8 +63004,8 @@ "type": "null" } ], - "title": "Currency Name", - "description": "Name of the quote currency." + "title": "Currency Symbol", + "description": "The symbol of the quote currency." }, "base_currency_symbol": { "anyOf": [ @@ -56697,38 +63031,400 @@ "title": "Base Currency Name", "description": "Name of the base currency." }, - "last_updated_utc": { + "market": { "type": "string", - "format": "date-time", - "title": "Last Updated Utc", - "description": "The last updated timestamp in UTC." + "title": "Market", + "description": "Name of the trading market. Always 'fx'." }, - "delisted_utc": { + "locale": { + "type": "string", + "title": "Locale", + "description": "Locale of the currency pair." + }, + "last_updated": { "anyOf": [ { "type": "string", - "format": "date-time" + "format": "date" }, { "type": "null" } ], - "title": "Delisted Utc", - "description": "The delisted timestamp in UTC." + "title": "Last Updated", + "description": "The date the reference data was last updated." + }, + "delisted": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Delisted", + "description": "The date the item was delisted." } }, "additionalProperties": true, "type": "object", "required": [ - "name", + "symbol", "market", - "locale", - "last_updated_utc" + "locale" ], - "title": "PolygonCurrencyPairs", + "title": "PolygonCurrencyPairsData", "description": "Polygon Currency Available Pairs Data." }, - "PolygonEquityHistorical": { + "PolygonCurrencySnapshotsData": { + "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." + }, + "vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Vwap", + "description": "The volume-weighted average price." + }, + "change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change", + "description": "The change in price from the previous day." + }, + "change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Change Percent", + "description": "The percentage change in price from the previous day.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "prev_open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Open", + "description": "The previous day's opening price." + }, + "prev_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev High", + "description": "The previous day's high price." + }, + "prev_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Low", + "description": "The previous day's low price." + }, + "prev_volume": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Volume", + "description": "The previous day's volume." + }, + "prev_vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Prev Vwap", + "description": "The previous day's VWAP." + }, + "bid": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Bid", + "description": "The current bid price." + }, + "ask": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Ask", + "description": "The current ask price." + }, + "minute_open": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Open", + "description": "The open price from the most recent minute bar." + }, + "minute_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute High", + "description": "The high price from the most recent minute bar." + }, + "minute_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Low", + "description": "The low price from the most recent minute bar." + }, + "minute_close": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Close", + "description": "The close price from the most recent minute bar." + }, + "minute_volume": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Volume", + "description": "The volume from the most recent minute bar." + }, + "minute_vwap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Vwap", + "description": "The VWAP from the most recent minute bar." + }, + "minute_transactions": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Minute Transactions", + "description": "The number of transactions in the most recent minute bar." + }, + "quote_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Quote Timestamp", + "description": "The timestamp of the last quote." + }, + "minute_timestamp": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Minute Timestamp", + "description": "The timestamp for the start of the most recent minute bar." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "The last time the data was updated." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "base_currency", + "counter_currency", + "last_rate", + "last_updated" + ], + "title": "PolygonCurrencySnapshotsData", + "description": "Polygon Currency Snapshots Data." + }, + "PolygonEquityHistoricalData": { "properties": { "date": { "anyOf": [ @@ -56791,7 +63487,7 @@ "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -56801,7 +63497,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -56814,10 +63510,10 @@ "low", "close" ], - "title": "PolygonEquityHistorical", + "title": "PolygonEquityHistoricalData", "description": "Polygon Equity Historical Price Data." }, - "PolygonEquityNBBO": { + "PolygonEquityNBBOData": { "properties": { "ask_exchange": { "type": "string", @@ -56849,7 +63545,7 @@ "title": "Bid Exchange", "description": "The exchange ID for the bid." }, - "tape": { + "tape_integer": { "anyOf": [ { "type": "string" @@ -56858,7 +63554,7 @@ "type": "null" } ], - "title": "Tape", + "title": "Tape Integer", "description": "The exchange tape." }, "conditions": { @@ -56900,7 +63596,7 @@ "title": "Indicators", "description": "A list of indicator codes." }, - "sequence_num": { + "sequence_number": { "anyOf": [ { "type": "integer" @@ -56909,7 +63605,7 @@ "type": "null" } ], - "title": "Sequence Num", + "title": "Sequence Number", "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": { @@ -56962,10 +63658,10 @@ "bid", "bid_exchange" ], - "title": "PolygonEquityNBBO", + "title": "PolygonEquityNBBOData", "description": "Polygon Equity NBBO data." }, - "PolygonIncomeStatement": { + "PolygonIncomeStatementData": { "properties": { "period_ending": { "type": "string", @@ -57519,10 +64215,10 @@ "required": [ "period_ending" ], - "title": "PolygonIncomeStatement", + "title": "PolygonIncomeStatementData", "description": "Polygon Income Statement Data." }, - "PolygonIndexHistorical": { + "PolygonIndexHistoricalData": { "properties": { "date": { "anyOf": [ @@ -57598,7 +64294,7 @@ "title": "Volume", "description": "The trading volume." }, - "transactions": { + "n": { "anyOf": [ { "type": "integer", @@ -57608,7 +64304,7 @@ "type": "null" } ], - "title": "Transactions", + "title": "N", "description": "Number of transactions for the symbol in the time period." } }, @@ -57617,10 +64313,10 @@ "required": [ "date" ], - "title": "PolygonIndexHistorical", + "title": "PolygonIndexHistoricalData", "description": "Polygon Index Historical Data." }, - "PolygonMarketSnapshots": { + "PolygonMarketSnapshotsData": { "properties": { "symbol": { "type": "string", @@ -57942,7 +64638,7 @@ "symbol", "last_updated" ], - "title": "PolygonMarketSnapshots", + "title": "PolygonMarketSnapshotsData", "description": "Polygon Market Snapshots Data." }, "PolygonPublisher": { @@ -57978,13 +64674,45 @@ "title": "PolygonPublisher", "description": "PolygonPublisher Data Model." }, - "SecCikMap": { + "PossibleYears": { "properties": { - "cik": { + "calendar_year": { "anyOf": [ { "type": "integer" }, + { + "type": "null" + } + ], + "title": "Calendar Year", + "description": "Calendar year." + }, + "periods": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Periods", + "description": "Periods." + } + }, + "additionalProperties": true, + "type": "object", + "title": "PossibleYears", + "description": "Possible Financial Years." + }, + "PostSearchParams": { + "properties": { + "q": { + "anyOf": [ { "type": "string" }, @@ -57992,16 +64720,272 @@ "type": "null" } ], + "title": "Q", + "default": "" + }, + "type": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/FilterTypes" + }, + "type": "array" + }, + { + "$ref": "#/components/schemas/FilterTypes" + }, + { + "type": "null" + } + ], + "title": "Type" + }, + "ignore_type": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IgnoreTypes" + }, + "type": "array" + }, + { + "$ref": "#/components/schemas/IgnoreTypes" + }, + { + "type": "null" + } + ], + "title": "Ignore Type" + }, + "limit": { + "type": "integer", + "minimum": 1.0, + "title": "Limit", + "default": 25 + } + }, + "type": "object", + "title": "PostSearchParams", + "description": "Query Symbols Params." + }, + "ProKeyMetrics": { + "properties": { + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "Market cap." + }, + "beta": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Beta", + "description": "Beta of the stock relative to the market." + }, + "day_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day High", + "description": "Day high." + }, + "day_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Low", + "description": "Day low." + }, + "avg_volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Avg Volume", + "description": "Average volume over the last 10 trading days." + }, + "year_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year High", + "description": "52-week high of the stock price." + }, + "year_low": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Low", + "description": "52-week low of the stock price." + }, + "dividend_yield_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Dividend Yield Ttm", + "description": "Dividend yield trailing twelve months." + }, + "pe_ratio_ttm": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pe Ratio Ttm", + "description": "Price earnings ratio trailing twelve months." + }, + "portfolio_turnover": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Portfolio Turnover", + "description": "Portfolio turnover.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "net_asset_value": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Asset Value", + "description": "Net asset value." + }, + "number_of_holdings": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Number Of Holdings", + "description": "Number of holdings." + }, + "net_expense_ratio": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Net Expense Ratio", + "description": "Net expense ratio.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + }, + "volume_avg_30": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Volume Avg 30", + "description": "One month average daily volume." + }, + "one_month": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "One Month", + "description": "One month performance.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "title": "ProKeyMetrics", + "description": "Pro Key Metrics Data." + }, + "SecCikMapData": { + "properties": { + "cik": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." } }, "additionalProperties": true, "type": "object", - "title": "SecCikMap", + "title": "SecCikMapData", "description": "SEC CIK Mapping Data." }, - "SecCompanyFilings": { + "SecCompanyFilingsData": { "properties": { "filing_date": { "type": "string", @@ -58075,7 +65059,7 @@ "title": "Report Url", "description": "URL to the actual report." }, - "report_date": { + "reportDate": { "anyOf": [ { "type": "string", @@ -58085,7 +65069,7 @@ "type": "null" } ], - "title": "Report Date", + "title": "Reportdate", "description": "The date of the filing." }, "act": { @@ -58118,7 +65102,7 @@ "title": "Items", "description": "The SEC Item numbers." }, - "primary_doc_description": { + "primaryDocDescription": { "anyOf": [ { "type": "string" @@ -58127,10 +65111,10 @@ "type": "null" } ], - "title": "Primary Doc Description", + "title": "Primarydocdescription", "description": "The description of the primary document." }, - "primary_doc": { + "primaryDocument": { "anyOf": [ { "type": "string" @@ -58139,10 +65123,10 @@ "type": "null" } ], - "title": "Primary Doc", + "title": "Primarydocument", "description": "The filename of the primary document." }, - "accession_number": { + "accessionNumber": { "anyOf": [ { "type": "string" @@ -58154,10 +65138,10 @@ "type": "null" } ], - "title": "Accession Number", + "title": "Accessionnumber", "description": "The accession number." }, - "file_number": { + "fileNumber": { "anyOf": [ { "type": "string" @@ -58169,10 +65153,10 @@ "type": "null" } ], - "title": "File Number", + "title": "Filenumber", "description": "The file number." }, - "film_number": { + "filmNumber": { "anyOf": [ { "type": "string" @@ -58184,10 +65168,10 @@ "type": "null" } ], - "title": "Film Number", + "title": "Filmnumber", "description": "The film number." }, - "is_inline_xbrl": { + "isInlineXBRL": { "anyOf": [ { "type": "string" @@ -58199,10 +65183,10 @@ "type": "null" } ], - "title": "Is Inline Xbrl", + "title": "Isinlinexbrl", "description": "Whether the filing is an inline XBRL filing." }, - "is_xbrl": { + "isXBRL": { "anyOf": [ { "type": "string" @@ -58214,7 +65198,7 @@ "type": "null" } ], - "title": "Is Xbrl", + "title": "Isxbrl", "description": "Whether the filing is an XBRL filing." }, "size": { @@ -58232,7 +65216,7 @@ "title": "Size", "description": "The size of the filing." }, - "complete_submission_url": { + "completeSubmissionUrl": { "anyOf": [ { "type": "string" @@ -58241,10 +65225,10 @@ "type": "null" } ], - "title": "Complete Submission Url", + "title": "Completesubmissionurl", "description": "The URL to the complete filing submission." }, - "filing_detail_url": { + "filingDetailUrl": { "anyOf": [ { "type": "string" @@ -58253,7 +65237,7 @@ "type": "null" } ], - "title": "Filing Detail Url", + "title": "Filingdetailurl", "description": "The URL to the filing details." } }, @@ -58263,10 +65247,179 @@ "filing_date", "report_url" ], - "title": "SecCompanyFilings", + "title": "SecCompanyFilingsData", "description": "SEC Company Filings Data." }, - "SecEquityFtd": { + "SecCompareCompanyFactsData": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Symbol representing the entity requested in the data." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name of the entity." + }, + "value": { + "type": "number", + "title": "Value", + "description": "The reported value of the fact or concept." + }, + "reported_date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Reported Date", + "description": "The date when the report was filed." + }, + "period_beginning": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Beginning", + "description": "The start date of the reporting period." + }, + "period_ending": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Period Ending", + "description": "The end date of the reporting period." + }, + "fiscal_year": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Fiscal Year", + "description": "The fiscal year." + }, + "fiscal_period": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Fiscal Period", + "description": "The fiscal period of the fiscal year." + }, + "cik": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "title": "Cik", + "description": "Central Index Key (CIK) for the requested entity." + }, + "location": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Location", + "description": "Geographic location of the reporting entity." + }, + "form": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Form", + "description": "The SEC form associated with the fact or concept." + }, + "frame": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Frame", + "description": "The frame ID associated with the fact or concept, if applicable." + }, + "accession": { + "type": "string", + "title": "Accession", + "description": "SEC filing accession number associated with the reported fact or concept." + }, + "fact": { + "type": "string", + "title": "Fact", + "description": "The display name of the fact or concept." + }, + "unit": { + "type": "string", + "title": "Unit", + "description": "The unit of measurement for the fact or concept." + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "value", + "cik", + "accession", + "fact" + ], + "title": "SecCompareCompanyFactsData", + "description": "SEC Compare Company Facts Data." + }, + "SecEquityFtdData": { "properties": { "settlement_date": { "anyOf": [ @@ -58344,10 +65497,10 @@ }, "additionalProperties": true, "type": "object", - "title": "SecEquityFtd", + "title": "SecEquityFtdData", "description": "SEC Equity FTD Data." }, - "SecEquitySearch": { + "SecEquitySearchData": { "properties": { "symbol": { "anyOf": [ @@ -58370,7 +65523,8 @@ "type": "null" } ], - "title": "Name" + "title": "Name", + "description": "Name of the company." }, "cik": { "type": "string", @@ -58383,10 +65537,10 @@ "required": [ "cik" ], - "title": "SecEquitySearch", + "title": "SecEquitySearchData", "description": "SEC Equity Search Data." }, - "SecEtfHoldings": { + "SecEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ @@ -58472,7 +65626,7 @@ "title": "Balance", "description": "The balance of the holding." }, - "weight": { + "pctVal": { "anyOf": [ { "type": "number" @@ -58481,10 +65635,12 @@ "type": "null" } ], - "title": "Weight", - "description": "The weight of the holding in ETF in %." + "title": "Pctval", + "description": "The weight of the holding in ETF in %.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, - "value": { + "valUSD": { "anyOf": [ { "type": "number" @@ -58493,10 +65649,10 @@ "type": "null" } ], - "title": "Value", + "title": "Valusd", "description": "The value of the holding in USD." }, - "payoff_profile": { + "payoffProfile": { "anyOf": [ { "type": "string" @@ -58505,7 +65661,7 @@ "type": "null" } ], - "title": "Payoff Profile", + "title": "Payoffprofile", "description": "The payoff profile of the holding." }, "units": { @@ -58523,7 +65679,7 @@ "title": "Units", "description": "The units of the holding." }, - "currency": { + "curCd": { "anyOf": [ { "type": "string" @@ -58532,10 +65688,10 @@ "type": "null" } ], - "title": "Currency", + "title": "Curcd", "description": "The currency of the holding." }, - "asset_category": { + "assetCat": { "anyOf": [ { "type": "string" @@ -58544,10 +65700,10 @@ "type": "null" } ], - "title": "Asset Category", + "title": "Assetcat", "description": "The asset category of the holding." }, - "issuer_category": { + "issuerCat": { "anyOf": [ { "type": "string" @@ -58556,10 +65712,10 @@ "type": "null" } ], - "title": "Issuer Category", + "title": "Issuercat", "description": "The issuer category of the holding." }, - "country": { + "invCountry": { "anyOf": [ { "type": "string" @@ -58568,10 +65724,10 @@ "type": "null" } ], - "title": "Country", + "title": "Invcountry", "description": "The country of the holding." }, - "is_restricted": { + "isRestrictedSec": { "anyOf": [ { "type": "string" @@ -58580,10 +65736,10 @@ "type": "null" } ], - "title": "Is Restricted", + "title": "Isrestrictedsec", "description": "Whether the holding is restricted." }, - "fair_value_level": { + "fairValLevel": { "anyOf": [ { "type": "integer" @@ -58592,10 +65748,10 @@ "type": "null" } ], - "title": "Fair Value Level", + "title": "Fairvallevel", "description": "The fair value level of the holding." }, - "is_cash_collateral": { + "isCashCollateral": { "anyOf": [ { "type": "string" @@ -58604,10 +65760,10 @@ "type": "null" } ], - "title": "Is Cash Collateral", + "title": "Iscashcollateral", "description": "Whether the holding is cash collateral." }, - "is_non_cash_collateral": { + "isNonCashCollateral": { "anyOf": [ { "type": "string" @@ -58616,10 +65772,10 @@ "type": "null" } ], - "title": "Is Non Cash Collateral", + "title": "Isnoncashcollateral", "description": "Whether the holding is non-cash collateral." }, - "is_loan_by_fund": { + "isLoanByFund": { "anyOf": [ { "type": "string" @@ -58628,10 +65784,10 @@ "type": "null" } ], - "title": "Is Loan By Fund", + "title": "Isloanbyfund", "description": "Whether the holding is loan by fund." }, - "loan_value": { + "loanVal": { "anyOf": [ { "type": "number" @@ -58640,7 +65796,7 @@ "type": "null" } ], - "title": "Loan Value", + "title": "Loanval", "description": "The loan value of the holding." }, "issuer_conditional": { @@ -58714,7 +65870,9 @@ } ], "title": "Annualized Return", - "description": "The annualized return on the debt security." + "description": "The annualized return on the debt security.", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" }, "is_default": { "anyOf": [ @@ -58886,7 +66044,7 @@ } ], "title": "Rate Type Rec", - "description": "The type of rate for reveivable portion of the swap." + "description": "The type of rate for receivable portion of the swap." }, "receive_currency": { "anyOf": [ @@ -58922,7 +66080,7 @@ } ], "title": "Floating Rate Index Rec", - "description": "The floating rate index for reveivable portion of the swap." + "description": "The floating rate index for receivable portion of the swap." }, "floating_rate_spread_rec": { "anyOf": [ @@ -58946,7 +66104,7 @@ } ], "title": "Rate Tenor Rec", - "description": "The rate tenor for reveivable portion of the swap." + "description": "The rate tenor for receivable portion of the swap." }, "rate_tenor_unit_rec": { "anyOf": [ @@ -58961,7 +66119,7 @@ } ], "title": "Rate Tenor Unit Rec", - "description": "The rate tenor unit for reveivable portion of the swap." + "description": "The rate tenor unit for receivable portion of the swap." }, "reset_date_rec": { "anyOf": [ @@ -58973,7 +66131,7 @@ } ], "title": "Reset Date Rec", - "description": "The reset date for reveivable portion of the swap." + "description": "The reset date for receivable portion of the swap." }, "reset_date_unit_rec": { "anyOf": [ @@ -58988,7 +66146,7 @@ } ], "title": "Reset Date Unit Rec", - "description": "The reset date unit for reveivable portion of the swap." + "description": "The reset date unit for receivable portion of the swap." }, "rate_type_pmnt": { "anyOf": [ @@ -59311,10 +66469,10 @@ }, "additionalProperties": true, "type": "object", - "title": "SecEtfHoldings", + "title": "SecEtfHoldingsData", "description": "SEC ETF Holdings Data." }, - "SecForm13FHR": { + "SecForm13FHRData": { "properties": { "period_ending": { "type": "string", @@ -59434,12 +66592,12 @@ "value", "weight" ], - "title": "SecForm13FHR", + "title": "SecForm13FHRData", "description": "SEC Form 13F-HR Data." }, - "SecInstitutionsSearch": { + "SecInstitutionsSearchData": { "properties": { - "name": { + "Institution": { "anyOf": [ { "type": "string" @@ -59448,10 +66606,10 @@ "type": "null" } ], - "title": "Name", + "title": "Institution", "description": "The name of the institution." }, - "cik": { + "CIK Number": { "anyOf": [ { "type": "string" @@ -59463,21 +66621,21 @@ "type": "null" } ], - "title": "Cik", + "title": "Cik Number", "description": "Central Index Key (CIK)" } }, "additionalProperties": true, "type": "object", - "title": "SecInstitutionsSearch", + "title": "SecInstitutionsSearchData", "description": "SEC Institutions Search Data." }, - "SecRssLitigation": { + "SecRssLitigationData": { "properties": { - "published": { + "date": { "type": "string", "format": "date-time", - "title": "Published", + "title": "Date", "description": "The date of publication." }, "title": { @@ -59504,16 +66662,16 @@ "additionalProperties": true, "type": "object", "required": [ - "published", + "date", "title", "summary", "id", "link" ], - "title": "SecRssLitigation", + "title": "SecRssLitigationData", "description": "SEC Litigation RSS Feed Data." }, - "SecSchemaFiles": { + "SecSchemaFilesData": { "properties": { "files": { "items": { @@ -59529,22 +66687,22 @@ "required": [ "files" ], - "title": "SecSchemaFiles", + "title": "SecSchemaFilesData", "description": "SEC Schema Files List Data." }, - "SecSicSearch": { + "SecSicSearchData": { "properties": { - "sic": { + "SIC Code": { "type": "integer", - "title": "Sic", + "title": "Sic Code", "description": "Sector Industrial Code (SIC)" }, - "industry": { + "Industry Title": { "type": "string", - "title": "Industry", + "title": "Industry Title", "description": "Industry title." }, - "office": { + "Office": { "type": "string", "title": "Office", "description": "Reporting office within the Corporate Finance Office" @@ -59553,14 +66711,14 @@ "additionalProperties": true, "type": "object", "required": [ - "sic", - "industry", - "office" + "SIC Code", + "Industry Title", + "Office" ], - "title": "SecSicSearch", + "title": "SecSicSearchData", "description": "SEC Standard Industrial Classification Code (SIC) Data." }, - "SecSymbolMap": { + "SecSymbolMapData": { "properties": { "symbol": { "type": "string", @@ -59573,10 +66731,10 @@ "required": [ "symbol" ], - "title": "SecSymbolMap", + "title": "SecSymbolMapData", "description": "SEC symbol map Data." }, - "TEEconomicCalendar": { + "TEEconomicCalendarData": { "properties": { "date": { "anyOf": [ @@ -59603,6 +66761,18 @@ "title": "Country", "description": "Country of event." }, + "category": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Category", + "description": "Category of event." + }, "event": { "anyOf": [ { @@ -59615,7 +66785,7 @@ "title": "Event", "description": "Event name." }, - "reference": { + "importance": { "anyOf": [ { "type": "string" @@ -59624,8 +66794,8 @@ "type": "null" } ], - "title": "Reference", - "description": "Abbreviated period for which released data refers to." + "title": "Importance", + "description": "The importance level for the event." }, "source": { "anyOf": [ @@ -59639,7 +66809,7 @@ "title": "Source", "description": "Source of the data." }, - "sourceurl": { + "currency": { "anyOf": [ { "type": "string" @@ -59648,10 +66818,22 @@ "type": "null" } ], - "title": "Sourceurl", - "description": "Source URL." + "title": "Currency", + "description": "Currency of the data." }, - "actual": { + "unit": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Unit", + "description": "Unit of the data." + }, + "consensus": { "anyOf": [ { "type": "string" @@ -59663,8 +66845,8 @@ "type": "null" } ], - "title": "Actual", - "description": "Latest released value." + "title": "Consensus", + "description": "Average forecast among a representative group of economists." }, "previous": { "anyOf": [ @@ -59681,7 +66863,7 @@ "title": "Previous", "description": "Value for the previous period after the revision (if revision is applicable)." }, - "consensus": { + "revised": { "anyOf": [ { "type": "string" @@ -59693,8 +66875,23 @@ "type": "null" } ], - "title": "Consensus", - "description": "Average forecast among a representative group of economists." + "title": "Revised", + "description": "Revised previous value, if applicable." + }, + "actual": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Actual", + "description": "Latest released value." }, "forecast": { "anyOf": [ @@ -59709,9 +66906,9 @@ } ], "title": "Forecast", - "description": "Trading Economics projections" + "description": "TradingEconomics projections." }, - "url": { + "reference": { "anyOf": [ { "type": "string" @@ -59720,20 +66917,48 @@ "type": "null" } ], - "title": "Url", - "description": "Trading Economics URL" + "title": "Reference", + "description": "Abbreviated period for which released data refers to." }, - "importance": { + "reference_date": { "anyOf": [ { - "type": "integer", - "enum": [ - 0, - 1, - 2, - 3 - ] + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Reference Date", + "description": "Date for the reference period." + }, + "calendar_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Calendar Id", + "description": "TradingEconomics Calendar ID." + }, + "date_span": { + "anyOf": [ + { + "type": "integer" }, + { + "type": "null" + } + ], + "title": "Date Span", + "description": "Date span of the event." + }, + "symbol": { + "anyOf": [ { "type": "string" }, @@ -59741,10 +66966,10 @@ "type": "null" } ], - "title": "Importance", - "description": "Importance of the event. 1-Low, 2-Medium, 3-High" + "title": "Symbol", + "description": "TradingEconomics Symbol." }, - "currency": { + "ticker": { "anyOf": [ { "type": "string" @@ -59753,10 +66978,10 @@ "type": "null" } ], - "title": "Currency", - "description": "Currency of the data." + "title": "Ticker", + "description": "TradingEconomics Ticker symbol." }, - "unit": { + "te_url": { "anyOf": [ { "type": "string" @@ -59765,13 +66990,38 @@ "type": "null" } ], - "title": "Unit", - "description": "Unit of the data." + "title": "Te Url", + "description": "TradingEconomics URL path." + }, + "source_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Source Url", + "description": "Source URL." + }, + "last_updated": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Updated", + "description": "Last update of the data." } }, "additionalProperties": true, "type": "object", - "title": "TEEconomicCalendar", + "title": "TEEconomicCalendarData", "description": "Trading Economics Economic Calendar Data." }, "UDFSearchResult": { @@ -59919,17 +67169,6 @@ ], "title": "Description" }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, "full_name": { "anyOf": [ { @@ -60321,7 +67560,207 @@ "category", "message" ], - "title": "Warning_" + "title": "Warning_", + "description": "Model for Warning." + }, + "Watchlist": { + "properties": { + "symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Symbol", + "description": "Stock symbol." + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Stock name." + }, + "last_quote": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Last Quote", + "description": "Last quote." + }, + "day_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Change", + "description": "Day change." + }, + "day_change_percent": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Day Change Percent", + "description": "Day change percent." + }, + "day_volume": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Day Volume", + "description": "Day volume." + }, + "market_cap": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Market Cap", + "description": "Market cap." + }, + "pe": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Pe", + "description": "PE." + }, + "week_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Week Change", + "description": "Week change." + }, + "month_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Month Change", + "description": "Month change." + }, + "year_change": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Year Change", + "description": "Year change." + } + }, + "additionalProperties": true, + "type": "object", + "title": "Watchlist", + "description": "Watchlist Data." + }, + "openbb_fred__models__us_yield_curve__FREDYieldCurveData": { + "properties": { + "maturity": { + "type": "number", + "title": "Maturity", + "description": "Maturity of the treasury rate in years." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "Associated rate given in decimal form (0.05 is 5%)" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FREDYieldCurveData", + "description": "FRED US Yield Curve Data." + }, + "openbb_fred__models__yield_curve__FREDYieldCurveData": { + "properties": { + "date": { + "anyOf": [ + { + "type": "string", + "format": "date" + }, + { + "type": "null" + } + ], + "title": "Date", + "description": "The date of the data." + }, + "maturity": { + "type": "string", + "title": "Maturity", + "description": "Maturity length of the security." + }, + "rate": { + "type": "number", + "title": "Rate", + "description": "The yield as a normalized percent (0.05 is 5%)", + "x-frontend_multiply": 100, + "x-unit_measurement": "percent" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "maturity", + "rate" + ], + "title": "FREDYieldCurveData", + "description": "FRED Yield Curve Data." } }, "securitySchemes": { diff --git a/website/content/excel/openbb-functions.json b/website/content/excel/openbb-functions.json new file mode 100644 index 000000000000..58754cd3a0f6 --- /dev/null +++ b/website/content/excel/openbb-functions.json @@ -0,0 +1,173 @@ +{ + "CURRENCY.PRICE.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "CURRENCY.SNAPSHOTS": { + "providers": [ + "fmp" + ] + }, + "ECONOMY.CALENDAR": { + "providers": [ + "tradingeconomics" + ] + }, + "EQUITY.COMPARE.PEERS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.CONSENSUS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.ESTIMATES.PRICE_TARGET": { + "providers": [ + "benzinga", + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.BALANCE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.CASH": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.DIVIDENDS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.FILINGS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.HISTORICAL_EPS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.HISTORICAL_SPLITS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.INCOME": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.MANAGEMENT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.METRICS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.OVERVIEW": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.RATIOS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.REVENUE_PER_GEOGRAPHY": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.REVENUE_PER_SEGMENT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.FUNDAMENTAL.TRANSCRIPT": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.INSIDER_TRADING": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.INSTITUTIONAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.MAJOR_HOLDERS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.OWNERSHIP.SHARE_STATISTICS": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.HISTORICAL": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.PERFORMANCE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PRICE.QUOTE": { + "providers": [ + "fmp" + ] + }, + "EQUITY.PROFILE": { + "providers": [ + "fmp" + ] + }, + "ETF.HOLDINGS": { + "providers": [ + "intrinio" + ] + }, + "ETF.INFO": { + "providers": [ + "intrinio" + ] + }, + "INDEX.MARKET": { + "providers": [ + "fmp" + ] + }, + "NEWS.COMPANY": { + "providers": [ + "benzinga" + ] + }, + "NEWS.WORLD": { + "providers": [ + "benzinga" + ] + } +} \ No newline at end of file diff --git a/website/content/platform/developer_guide/index.mdx b/website/content/platform/developer_guide/index.mdx index 70b8518ec01b..6fd4bec06782 100644 --- a/website/content/platform/developer_guide/index.mdx +++ b/website/content/platform/developer_guide/index.mdx @@ -3,28 +3,28 @@ title: Developer Guide sidebar_position: 1 description: The OpenBB Platform supplies core architecture and services for connecting data providers and extensions, consumable through the Python client or the Fast API keywords: -- developer_guide -- OpenBB Platform -- Python client -- Fast API -- getting started -- authorization -- data providers -- OpenBB Hub -- local environment -- environment variables -- user settings -- command execution -- API response -- logging -- proxy networks -- data cleaning -- technical analysis -- quantitative analysis -- charting libraries + - developer_guide + - OpenBB Platform + - Python client + - Fast API + - getting started + - authorization + - data providers + - OpenBB Hub + - local environment + - environment variables + - user settings + - command execution + - API response + - logging + - proxy networks + - data cleaning + - technical analysis + - quantitative analysis + - charting libraries --- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; @@ -62,4 +62,4 @@ Optional extras are not included with the base installation, and these include: - Toolkit extensions - CLI Terminal -Refer to [Extensions](/platform/developer_guide/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently. +Refer to [Extensions](/platform/user_guides/extensions) for the list of extensions hosted in the OpenBB GitHub repository that can be installed independently. diff --git a/website/content/platform/installation.mdx b/website/content/platform/installation.mdx index 379ba93c54b3..263811896f2b 100644 --- a/website/content/platform/installation.mdx +++ b/website/content/platform/installation.mdx @@ -168,7 +168,6 @@ pip uninstall openbb[all] ### Docker
- You can install and run the Platform from [GitHub Container Registry](https://github.com/OpenBB-finance/OpenBBTerminal/pkgs/container/openbb-platform) with: ```bash diff --git a/website/content/platform/user_guides/add_toolkit_extension.mdx b/website/content/platform/user_guides/add_toolkit_extension.mdx index 9e8636a29637..4446f63bdccf 100644 --- a/website/content/platform/user_guides/add_toolkit_extension.mdx +++ b/website/content/platform/user_guides/add_toolkit_extension.mdx @@ -24,7 +24,7 @@ import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; -Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/developer_guide/extensions). +Before adding a new toolkit extension and router path to the OpenBB Platform using a supplied template, it is important to understand the difference between a toolkit and a provider extension. You can find more information on this [here](/platform/user_guides/extensions). ## How To Create A Router Extension diff --git a/website/content/platform/user_guides/basic_syntax.mdx b/website/content/platform/user_guides/basic_syntax.mdx index eb9db88c8a49..ee0e3cfd3e32 100644 --- a/website/content/platform/user_guides/basic_syntax.mdx +++ b/website/content/platform/user_guides/basic_syntax.mdx @@ -3,25 +3,25 @@ title: Basic Syntax sidebar_position: 1 description: This page provides comprehensive information about standardized command syntax for an open-source platform. Topics discussed include the structure of command syntax, use of standardized parameters, usage of provider and symbol parameters, handling of date and limit parameters, and more. Also explored, are the methods for selecting data sources, handling different list and ticker symbol formats, and dealing with command responses and warnings. keywords: -- tutorial -- command syntax -- standardized parameters -- date format -- provider parameter -- data source selection -- symbol parameter -- list formats -- ticker symbols -- date parameter -- time series -- limit parameter -- keyword arguments -- endpoint parameters -- command response -- data models + - tutorial + - command syntax + - standardized parameters + - date format + - provider parameter + - data source selection + - symbol parameter + - list formats + - ticker symbols + - date parameter + - time series + - limit parameter + - keyword arguments + - endpoint parameters + - command response + - data models --- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; @@ -80,7 +80,7 @@ Provider coverage can be ascertained with the command below: obb.coverage.providers ``` -Refer to, [Data Extensions](/platform/developer_guide/extensions), for instructions on installing data provider extensions. +Refer to, [Data Extensions](/platform/user_guides/extensions), for instructions on installing data provider extensions. ## Symbol @@ -101,9 +101,7 @@ With providers supporting market data from multiple jurisdictions, the most comm ### One Symbol
-```python -quote = obb.equity.price.quote(symbol="td", provider="fmp") -``` + ```python quote = obb.equity.price.quote(symbol="td", provider="fmp") ```
### Multiple Symbols @@ -190,7 +188,7 @@ Where, optional, `limit` parameters are supplied, they are likely to have sensib income = obb.equity.fa.income("AAPL", period="quarter", provider="fmp", limit=4) ``` -## **kwargs +## \*\*kwargs All endpoints accept additional keyword arguments, but non-existent parameters will be ignored. Invalid parameters are communicated via the `warnings` field in the command response. Parameters can be stored as a dictionary and fed to the command as `**kwargs`. If a provider, or function, has an undocumented parameter it can still be accessed by supplying the additional kwargs. @@ -210,6 +208,6 @@ data.warnings ## References -All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference). The data models for each provider source are described within the [Data Models](/platform/data_models) pages. +All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference). The data models for each provider source are described within the [Data Models](/platform/data_models) pages. These pages are a quick way to cross-reference differences between providers. The same information is provided in a function's signature and docstring. diff --git a/website/content/platform/user_guides/extensions.mdx b/website/content/platform/user_guides/extensions.mdx new file mode 100644 index 000000000000..28acc772175e --- /dev/null +++ b/website/content/platform/user_guides/extensions.mdx @@ -0,0 +1,311 @@ +--- +title: Extensions +sidebar_position: 3 +description: This page describes the toolkit extensions available for the OpenBB Platform. +keywords: +- OpenBB Platform +- Python client +- Fast API +- getting started +- extensions +- data providers +- data extensions +- toolkit extensions +- toolkits +- endpoints +- community +- technical analysis +- quantitative analysis +- charting libraries +- Plotly +- OpenBBFigure +- PyWry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + +The extension framework allows individual pieces to be installed and removed seamlessly within the environment, using only the desired data and toolkit extensions. + +There are two primary types of extensions for the OpenBB Platform: + +- Data +- Toolkits + +The OpenBB Core installation does not include any toolkit extensions. Install the OpenBB Platform with all data and toolkit extensions from PyPI with: + +```python +pip install openbb[all] +``` + +When installing from source, navigate into the `openbb_platform` folder from the root of the project and enter: + +```console +python dev_install.py -e +``` + +This installs all extensions in editable mode, and the Python interface is compiled in, `/openbb_platform/openbb/package`, instead of the environment's `site-packages` folder. The tables in the next pages lists extensions as either, Core or Community. The Core extensions are installed by default. + +A couple of notable differences between data and toolkit extension are: + +- In the OpenBB GitHub repo, extensions are all located under: + + ```console + ~/OpenBBTerminal/openbb_platform/extensions + ``` + +- An additional folder housing integration tests, with the `tests` folder staying empty. +- There is a `router` file, and there can be sub-folders with additional routers. +- Utility functions don't need their own sub-folder. +- `__init__.py` files are all empty. + +## Data Extensions + +
+ + +Data extensions will expand the breadth and coverage of the data available in the OpenBB Platform. Each source (provider) is its own independent extension, even if there is only one endpoint accessible. This allows every data source to be inserted or removed, at any time, without disturbing the operation of the Core components. + +Functions will appear in the Python Interface and Fast API only if a supported provider, for that specific endpoint, is installed. Additional Python libraries will be installed, where required, by the extension. + +## Provider Coverage + +The total installed coverage can be determined through the Python interface, as a dictionary. + +```python +from openbb import obb +obb.coverage.providers +``` + +## Installation + +All data extensions are installed with similar syntax. Published data extensions will have names beginning with `openbb`. For example, yFinance. + +```console +pip install openbb-yfinance +``` + +Additions and removals update the router automatically to reflect the changes when the Python interpreter is refreshed. Below is a list of data provider extensions. + +Uninstall any extension with `pip uninstall`. + +```console +pip uninstall openbb-yfinance +``` + +## Available Data Extensions + +### Core `openbb` Providers + +These packages are what will be installed when `pip install openbb` is run + +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +|----------------|-------------|----------------------|------------------------------------| +| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | +| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | +| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | +| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | +| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | +| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | +| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | None | +| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | +| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| openbb-yfinance | [Yahoo Finance](https://finance.yahoo.com/) data connector | pip install openbb-yfinance | None | + +### Community Providers + +These packages are not installed when `pip install openbb` is run. They are available for installation separately or by running `pip install openbb[all]` + +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +|----------------|-------------|----------------------|------------------------------------| +| openbb-alpha-vantage | [Alpha Vantage](https://www.alphavantage.co/) data connector | pip install openbb-alpha-vantage | Free | +| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free | +| openbb-cboe | [Cboe](https://www.cboe.com/delayed_quotes/) data connector | pip install openbb-cboe | None | +| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | None | +| openbb-federal-reserve | [Federal Reserve](https://www.federalreserve.gov/) data connector | pip install openbb-federal-reserve | None | +| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | None / Free | +| openbb-finviz | [Finviz](https://finviz.com) data connector | pip install openbb-finviz | None | +| openbb-government-us | [US Government](https://data.gov) data connector | pip install openbb-us-government | None | +| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector | pip install openbb-nasdaq | None / Free | +| openbb-seeking-alpha | [Seeking Alpha](https://seekingalpha.com/) data connector | pip install openbb-seeking-alpha | None | +| openbb-stockgrid | [Stockgrid](https://stockgrid.io) data connector | pip install openbb-stockgrid | None | +| openbb-tmx | [TMX](https://money.tmx.com) data connector | pip install openbb-tmx | None | +| openbb-tradier | [Tradier](https://tradier.com) data connector | pip install openbb-tradier | None | +| openbb-wsj | [Wall Street Journal](https://www.wsj.com/) data connector | pip install openbb-wsj | None | + +Have you published a data provider extension and want it featured on this list? Tell us about it! Open a pull request on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/) to submit an extension for inclusion. Code contributions, for new and existing, data providers are always welcome. + +Search [PyPI](https://pypi.org/search/?q=openbb-) to find more extensions. + + +
+ +## Toolkit Extensions +
+ +OpenBB Toolkit Extensions expand the Platform with functions for manipulating data and preparing it for display. The Core Platform installation does not install any toolkit extensions. The table below is the current list of toolkit extensions. + +| Extension Name | Description | Installation Command | Core/Community | Router Path | +|:-----------------|:-----------:|:-------------------:|:------------------:|-------------:| +| openbb-charting | Rest API charting service and Plotly library. | pip install openbb-charting | Community | N/A | +| openbb-devtools | Aggregates dependencies that facilitate a nice development experience for OpenBB. | pip install openbb-devtools | N/A | +| openbb-econometrics | Econometrics models for the Python interface only. | pip install openbb-econometrics | Community | obb.econometrics | +| openbb-quantitative | Functions for performing quantitative analysis. | pip install openbb-quantitative | Community | obb.quantitative | +| openbb-technical | Functions for performing technical analysis. | pip install openbb-technical | Community | obb.technical | + +The sections below outline any specific installation considerations for the extension. + +## Charting + +The OpenBB Charting Extension supplies charting infrastructure and services to the OpenBB Platform. Figure objects are served via REST API or Python Client. It utilizes [PyWry](https://github.com/OpenBB-finance/pywry) for handling the display of interactive charts and tables in a separate window, with a Plotly library. + +Functions with dedicated views return figures to the `chart` attribute of the `OBBject` response object. They are displayed with the class method, `show()`. + +:::tip +The `openbb-charting` is an [`OBBject` extension](platform/getting_started/add_obbject_extension), which means the general functionality is exposed in every command result. +::: + +The following packages are dependencies of the `openbb-charting` extension: + +- scipy +- plotly +- statsmodels +- reportlab +- pywry +- svglib +- nbformat +- pandas-ta + +### Installation + +Install from PyPI with: + +```console +pip install openbb-charting +``` + +For more information check the documentation of the openbb-charting extension. + +## Devtools + +Please refer to the following PyPI distributed [package](https://pypi.org/project/openbb-devtools/). + +This Python package, `openbb-devtools`, is designed for OpenBB Platform Developers and contains a range of dependencies essential for robust and efficient software development. + +These dependencies cater to various aspects like code formatting, security analysis, type checking, testing, and kernel management. + +The inclusion of these packages ensures that the development process is streamlined, the code quality is maintained, and the software is secure and reliable. + +Included dependencies: + +- `ruff`: A fast Python linter focused on performance and simplicity. +- `pylint`: A tool that checks for errors in Python code, enforces a coding standard, and looks for code smells. +- `mypy`: A static type checker for Python, helping catch type errors during development. +- `pydocstyle`: A linter for Python docstrings to ensure they meet certain style requirements. +- `black`: An uncompromising Python code formatter, ensuring consistent code style. +- `bandit`: A tool designed to find common security issues in Python code. +- `pre-commit`: Manages and maintains pre-commit hooks that run checks before each commit, ensuring code quality. +- `nox`: A generic virtualenv management and test command line tool for running tests in isolated environments. +- `pytest`: A mature full-featured Python testing tool that helps in writing better programs. +- `pytest-cov`: A plugin for pytest that measures code coverage during testing. +- `ipykernel`: A package that provides the IPython kernel for Jupyter. +- `types-python-dateutil`: Type stubs for python-dateutil, aiding in static type checking. +- `types-toml`: Type stubs for TOML, useful for static type checking in TOML parsing. +- `poetry`: A tool for dependency management and packaging in Python. + +Each dependency plays a critical role in ensuring the code is clean, efficient, and functional, ultimately leading to the development of high-quality software. + +While developing code for the OpenBB Platform, one should always install the DevTools packages so that the above development tooling is available out-of-the-box. + +### Installation + +Install from PyPI with: + +```console +pip install openbb-devtools +``` + +:::info +When setting up the environment using the `openbb_platform/dev_install.py` script, the DevTools will also be installed. +::: + +## Econometrics + +The `openbb-econometrics` extension installs a new router path (`obb.econometrics`) and additional Python libraries: + +- scipy +- statsmodels +- arch +- linearmodels + +:::note + +Statsmodels requires a C compiler be present on the system. Follow the instructions [here](https://cython.readthedocs.io/en/latest/src/quickstart/install.html) for system-specific methods. + +This extension is not accessible via REST API because `statsmodels` is not serializable. +::: + +### Installation + +Install from PyPI with: + +```console +pip install openbb-econometrics +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/econometrics`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. + +## Quantitative + +The `openbb-quantitative` extension installs a new router path (`obb.quantitative`) and a few additional Python libraries: + +- pandas-ta +- scipy +- statsmodels + +### Installation + +Install from PyPI with: + +```console +pip install openbb-quantitative +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/quantitative`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. + +## Technical + +The `openbb-technical` extension is for performing technical analysis on time series data. It installs a new router path (`obb.technical`) and some additional Python libraries: + +- pandas-ta +- scikit-learn +- scipy +- statsmodels + +### Installation + +Install from PyPI with: + +```console +pip install openbb-technical +``` + +To install from source in editable mode, navigate into the folder, `~/openbb_platform/extensions/technical`, and enter: + +```console +pip install -e . +``` + +After installation, the Python interface will automatically rebuild on initialization. +
diff --git a/website/generate_excel_markdown.py b/website/generate_excel_markdown.py index 0fefcb7f036b..8527de985e59 100644 --- a/website/generate_excel_markdown.py +++ b/website/generate_excel_markdown.py @@ -12,11 +12,13 @@ WEBSITE_PATH = Path(__file__).parent.absolute() CONTENT_PATH = WEBSITE_PATH / "content" XL_FUNCS_PATH = CONTENT_PATH / "excel" / "functions.json" +XL_OPENBB_FUNCS_PATH = CONTENT_PATH / "excel" / "openbb-functions.json" XL_PLATFORM_PATH = CONTENT_PATH / "excel" / "openapi.json" SEO_METADATA_PATH = WEBSITE_PATH / "metadata" / "platform_v4_seo_metadata.json" # URLs: the platform url should match the backend being used by excel.openbb.co XL_FUNCS_URL = "https://excel.openbb.co/assets/functions.json" +XL_OPENBB_FUNCS_URL = "https://excel.openbb.co/assets/openbb-functions.json" XL_PLATFORM_URL = "https://sdk.openbb.co/openapi.json" @@ -46,6 +48,7 @@ class CommandLib: def __init__(self): self.xl_funcs = self.read_xl_funcs() + self.xl_openbb_funcs = self.read_xl_openbb_funcs() self.openapi = self.read_openapi() self.seo_metadata = self.read_seo_metadata() @@ -56,6 +59,13 @@ def fetch_xl_funcs(): with open(XL_FUNCS_PATH, "w") as f: json.dump(r.json(), f, indent=2) + @staticmethod + def fetch_xl_openbb_funcs(): + """Fetch the openbb version of excel functions.""" + r = requests.get(XL_OPENBB_FUNCS_URL, timeout=10) + with open(XL_OPENBB_FUNCS_PATH, "w") as f: + json.dump(r.json(), f, indent=2) + @staticmethod def fetch_openapi(): """Fetch the openapi.json.""" @@ -89,6 +99,12 @@ def read_xl_funcs(self) -> Dict[str, dict]: for func in funcs["functions"] } + def read_xl_openbb_funcs(self) -> Dict[str, Any]: + """Read the Excel openbb functions file.""" + with open(XL_OPENBB_FUNCS_PATH) as f: + funcs = json.load(f) + return funcs + def read_openapi(self) -> dict: """Get the openapi.json.""" with open(XL_PLATFORM_PATH) as f: @@ -148,17 +164,39 @@ def _get_data(self, cmd: str) -> dict: ) ): models = self._traverse(["properties", "results", "anyOf"], inner_schema)[0] - if models.get("type") == "array": - models = models["items"] - - d = {} - for k, v in self._traverse(["discriminator", "mapping"], models).items(): - model_schema = self._traverse(v.split("/"), self.openapi, ["#"]) - d[k] = { - name: {"description": info.get("description", "").replace("\n", "")} - for name, info in model_schema["properties"].items() - } - return d + models = ( + models["items"].get("oneOf", [models["items"]]) + if models.get("type") == "array" + else [models] + ) + + # Get the available providers from the provider parameter enum + parameters = self._traverse( + [ + "paths", + self.API_PREFIX + cmd, + "get", + "parameters", + ], + self.openapi, + ) + providers = [] + for p in parameters: + if p.get("name") == "provider": + providers = p.get("schema", {}).get("enum", []) + if providers: + d = {} + for i, model in enumerate(models): + ref = model.get("$ref", "") + model_schema = self._traverse(ref.split("/"), self.openapi, ["#"]) + provider = providers[i] + d[provider] = { + name: { + "description": info.get("description", "").replace("\n", "") + } + for name, info in model_schema["properties"].items() + } + return d return {} def _get_examples( @@ -210,6 +248,7 @@ def get_info(self, cmd: str) -> Dict[str, Any]: data = self._get_data(cmd) return_ = self.xl_funcs[cmd].get("result", {}).get("dimensionality", "") examples = self._get_examples(cmd, parameters) + providers = self.xl_openbb_funcs.get(function, {}).get("providers", []) return { "name": name, "description": description, @@ -219,6 +258,7 @@ def get_info(self, cmd: str) -> Dict[str, Any]: "data": data, "return": return_, "examples": examples, + "providers": providers, } @@ -311,20 +351,25 @@ def get_parameters() -> str: def get_data() -> str: if data_schema := cmd_info["data"]: - data = "import Tabs from '@theme/Tabs';\n" - data += "import TabItem from '@theme/TabItem';\n\n" - data += "## Data\n\n" - data += "\n" - for provider, fields in data_schema.items(): - data += f"\n\n" - data += "| Name | Description |\n" - data += "| ---- | ----------- |\n" - for name, info in fields.items(): - description = info["description"] - data += f"| {name} | {description} |\n" - data += "\n" - data += "\n" - return data + providers = cmd_info["providers"] + filtered_data_schema = { + k: v for k, v in data_schema.items() if k in providers + } + if filtered_data_schema: + data = "import Tabs from '@theme/Tabs';\n" + data += "import TabItem from '@theme/TabItem';\n\n" + data += "## Data\n\n" + data += "\n" + for provider, fields in filtered_data_schema.items(): + data += f"\n\n" + data += "| Name | Description |\n" + data += "| ---- | ----------- |\n" + for name, info in fields.items(): + description = info["description"] + data += f"| {name} | {description} |\n" + data += "\n" + data += "\n" + return data return "" def get_examples() -> str: @@ -512,6 +557,7 @@ def go(self): pass else: CommandLib.fetch_xl_funcs() + CommandLib.fetch_xl_openbb_funcs() CommandLib.fetch_openapi() Editor(