{ "openapi": "3.1.0", "info": { "title": "OpenBB Platform API", "description": "Investment research for everyone, anywhere.", "termsOfService": "http://example.com/terms/", "contact": { "name": "OpenBB Team", "url": "https://openbb.co/", "email": "hello@openbb.co" }, "license": { "name": "MIT", "url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/LICENSE" }, "version": "4.2.1" }, "paths": { "/api/v1/crypto/price/historical": { "get": { "tags": [ "crypto" ], "summary": "Historical", "description": "Get historical price data for cryptocurrency pair(s) within a provider.", "operationId": "crypto_price_historical", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "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.", "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." }, { "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": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ], "type": "string" }, { "type": "string" } ], "title": "fmp,polygon", "description": "Time interval of the data to return. (provider: fmp);\n Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", "default": "1d" }, "description": "Time interval of the data to return. (provider: fmp);\n Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "title": "polygon", "description": "The number of data entries to return. (provider: polygon)", "default": 49999 }, "description": "The number of data entries to return. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CryptoHistorical" } } } }, "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": "CryptoHistorical", "examples": [ { "scope": "api", "parameters": { "symbol": "BTCUSD", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "BTCUSD", "start_date": "2024-01-01", "end_date": "2024-01-31", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "BTCUSD,ETHUSD", "start_date": "2024-01-01", "end_date": "2024-01-31", "provider": "polygon" }, "provider": "polygon" } ] } }, "/api/v1/crypto/search": { "get": { "tags": [ "crypto" ], "summary": "Search", "description": "Search available cryptocurrency pairs within a provider.", "operationId": "crypto_search", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search query.", "title": "Query" }, "description": "Search query." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CryptoSearch" } } } }, "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": "CryptoSearch", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "query": "BTCUSD", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/currency/price/historical": { "get": { "tags": [ "currency" ], "summary": "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.", "operationId": "currency_price_historical", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "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.", "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." }, { "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": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "1m", "5m", "15m", "30m", "1h", "4h", "1d" ], "type": "string" }, { "type": "string" } ], "title": "fmp,polygon", "description": "Time interval of the data to return. (provider: fmp);\n Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)", "default": "1d" }, "description": "Time interval of the data to return. (provider: fmp);\n Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y (provider: polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "title": "polygon", "description": "The number of data entries to return. (provider: polygon)", "default": 49999 }, "description": "The number of data entries to return. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CurrencyHistorical" } } } }, "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": "CurrencyHistorical", "examples": [ { "scope": "api", "parameters": { "symbol": "EURUSD", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Filter historical data with specific start and end date.", "parameters": { "symbol": "EURUSD", "start_date": "2023-01-01", "end_date": "2023-12-31", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Get data with different granularity.", "parameters": { "symbol": "EURUSD", "provider": "polygon", "interval": "15m" }, "provider": "polygon" } ] } }, "/api/v1/currency/search": { "get": { "tags": [ "currency" ], "summary": "Search", "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.", "operationId": "currency_search", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Query to search for currency pairs.", "title": "Query" }, "description": "Query to search for currency pairs." } ], "responses": { "200": { "description": "Successful Response", "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": "fmp" }, "provider": "fmp" }, { "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": { "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": true, "schema": { "enum": [ "fmp", "polygon" ], "type": "string", "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, polygon.", "fmp": { "multiple_items_allowed": true }, "polygon": { "multiple_items_allowed": true }, "default": "usd", "title": "Base" }, "description": "The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon." }, { "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": "string" }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "An optional list of counter currency symbols to filter for. None returns all.", "title": "Counter Currencies" }, "description": "An optional list of counter currency symbols to filter for. None returns all." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CurrencySnapshots" } } } }, "404": { "description": "Not found" }, "400": { "description": "No Results Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "model": "CurrencySnapshots", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.", "parameters": { "provider": "fmp", "base": "USD,XAU", "counter_currencies": "EUR,JPY,GBP", "quote_type": "indirect" }, "provider": "fmp" } ] } }, "/api/v1/derivatives/options/chains": { "get": { "tags": [ "derivatives" ], "summary": "Chains", "description": "Get the complete options chain for a ticker.", "operationId": "derivatives_options_chains", "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.", "title": "Symbol" }, "description": "Symbol to get data for." }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "The end-of-day date for options chains data. (provider: intrinio)" }, "description": "The end-of-day date for options chains data. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_OptionsChains" } } } }, "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": "OptionsChains", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Use the \"date\" parameter to get the end-of-day-data for a specific date, where supported.", "parameters": { "symbol": "AAPL", "date": "2023-01-25", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/derivatives/options/unusual": { "get": { "tags": [ "derivatives" ], "summary": "Unusual", "description": "Get the complete options chain for a ticker.", "operationId": "derivatives_options_unusual", "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. (the underlying symbol)", "title": "Symbol" }, "description": "Symbol to get data for. (the underlying symbol)" }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began. (provider: intrinio)" }, "description": "Start date of the data, in YYYY-MM-DD format. If no symbol is supplied, requests are only allowed for a single date. Use the start_date for the target date. Intrinio appears to have data beginning Feb/2022, but is unclear when it actually began. (provider: intrinio)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio)" }, "description": "End date of the data, in YYYY-MM-DD format. If a symbol is not supplied, do not include an end date. (provider: intrinio)" }, { "name": "trade_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "block", "sweep", "large" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The type of unusual activity to query for. (provider: intrinio)" }, "description": "The type of unusual activity to query for. (provider: intrinio)" }, { "name": "sentiment", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "bullish", "bearish", "neutral" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The sentiment type to query for. (provider: intrinio)" }, "description": "The sentiment type to query for. (provider: intrinio)" }, { "name": "min_value", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "intrinio", "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)" }, "description": "The inclusive minimum total value for the unusual activity. (provider: intrinio)" }, { "name": "max_value", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "intrinio", "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)" }, "description": "The inclusive maximum total value for the unusual activity. (provider: intrinio)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "title": "intrinio", "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio)", "default": 100000 }, "description": "The number of data entries to return. A typical day for all symbols will yield 50-80K records. The API will paginate at 1000 records. The high default limit (100K) is to be able to reliably capture the most days. The high absolute limit (1.25M) is to allow for outlier days. Queries at the absolute limit will take a long time, and might be unreliable. Apply filters to improve performance. (provider: intrinio)" }, { "name": "source", "in": "query", "required": false, "schema": { "enum": [ "delayed", "realtime" ], "type": "string", "title": "intrinio", "description": "The source of the data. Either realtime or delayed. (provider: intrinio)", "default": "delayed" }, "description": "The source of the data. Either realtime or delayed. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_OptionsUnusual" } } } }, "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": "OptionsUnusual", "examples": [ { "scope": "api", "parameters": { "symbol": "TSLA", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Use the 'symbol' parameter to get the most recent activity for a specific symbol.", "parameters": { "symbol": "TSLA", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/economy/gdp/forecast": { "get": { "tags": [ "economy" ], "summary": "Forecast", "description": "Get Forecasted GDP Data.", "operationId": "economy_gdp_forecast", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "title": "Provider" } }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "quarter", "annual" ], "type": "string", "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual.", "default": "annual", "title": "Period" }, "description": "Time period of the data to return. Units for nominal GDP period. Either quarter or annual." }, { "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": "type", "in": "query", "required": false, "schema": { "enum": [ "nominal", "real" ], "type": "string", "description": "Type of GDP to get forecast of. Either nominal or real.", "default": "real", "title": "Type" }, "description": "Type of GDP to get forecast of. Either nominal or real." }, { "name": "country", "in": "query", "required": false, "schema": { "enum": [ "argentina", "asia", "australia", "austria", "belgium", "brazil", "bulgaria", "canada", "chile", "china", "colombia", "costa_rica", "croatia", "czech_republic", "denmark", "estonia", "euro_area_17", "finland", "france", "germany", "greece", "hungary", "iceland", "india", "indonesia", "ireland", "israel", "italy", "japan", "korea", "latvia", "lithuania", "luxembourg", "mexico", "netherlands", "new_zealand", "non-oecd", "norway", "oecd_total", "peru", "poland", "portugal", "romania", "russia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "world" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_GdpForecast" } } } }, "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": "GdpForecast", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "period": "annual", "type": "real", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/gdp/nominal": { "get": { "tags": [ "economy" ], "summary": "Nominal", "description": "Get Nominal GDP Data.", "operationId": "economy_gdp_nominal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "title": "Provider" } }, { "name": "units", "in": "query", "required": false, "schema": { "enum": [ "usd", "usd_cap" ], "type": "string", "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita.", "default": "usd", "title": "Units" }, "description": "The unit of measurement for the data. Units to get nominal GDP in. Either usd or usd_cap indicating per capita." }, { "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": "country", "in": "query", "required": false, "schema": { "enum": [ "australia", "austria", "belgium", "brazil", "canada", "chile", "colombia", "costa_rica", "czech_republic", "denmark", "estonia", "euro_area", "european_union", "finland", "france", "germany", "greece", "hungary", "iceland", "indonesia", "ireland", "israel", "italy", "japan", "korea", "latvia", "lithuania", "luxembourg", "mexico", "netherlands", "new_zealand", "norway", "poland", "portugal", "russia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_GdpNominal" } } } }, "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": "GdpNominal", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "units": "usd", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/gdp/real": { "get": { "tags": [ "economy" ], "summary": "Real", "description": "Get Real GDP Data.", "operationId": "economy_gdp_real", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "title": "Provider" } }, { "name": "units", "in": "query", "required": false, "schema": { "enum": [ "idx", "qoq", "yoy" ], "type": "string", "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)", "default": "yoy", "title": "Units" }, "description": "The unit of measurement for the data. Either idx (indicating 2015=100), qoq (previous period) or yoy (same period, previous year).)" }, { "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": "country", "in": "query", "required": false, "schema": { "enum": [ "G20", "G7", "argentina", "australia", "austria", "belgium", "brazil", "bulgaria", "canada", "chile", "china", "colombia", "costa_rica", "croatia", "czech_republic", "denmark", "estonia", "euro_area_19", "europe", "european_union_27", "finland", "france", "germany", "greece", "hungary", "iceland", "india", "indonesia", "ireland", "israel", "italy", "japan", "korea", "latvia", "lithuania", "luxembourg", "mexico", "netherlands", "new_zealand", "norway", "oecd_total", "poland", "portugal", "romania", "russia", "saudi_arabia", "slovak_republic", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_GdpReal" } } } }, "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": "GdpReal", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "units": "yoy", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/calendar": { "get": { "tags": [ "economy" ], "summary": "Calendar", "description": "Get the upcoming, or historical, economic calendar of global events.", "operationId": "economy_calendar", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "tradingeconomics" ], "type": "string", "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": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "tradingeconomics", "description": "Country of the event. Multiple comma separated items allowed. (provider: 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)" }, { "name": "importance", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "low", "medium", "high" ], "type": "string" }, { "type": "null" } ], "title": "tradingeconomics", "description": "Importance of the event. (provider: tradingeconomics)", "choices": [ "low", "medium", "high" ] }, "description": "Importance of the event. (provider: tradingeconomics)" }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "interest_rate", "inflation", "bonds", "consumer", "gdp", "government", "housing", "labour", "markets", "money", "prices", "trade", "business" ], "type": "string" }, { "type": "null" } ], "title": "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)" }, { "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EconomicCalendar" } } } }, "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": "EconomicCalendar", "examples": [ { "scope": "api", "description": "By default, the calendar will be forward-looking.", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "provider": "fmp", "start_date": "2020-03-01", "end_date": "2020-03-31" }, "provider": "fmp" } ] } }, "/api/v1/economy/cpi": { "get": { "tags": [ "economy" ], "summary": "Cpi", "description": "Get Consumer Price Index (CPI).\n\nReturns either the rescaled index value, or a rate of change (inflation).", "operationId": "economy_cpi", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "title": "Provider" } }, { "name": "country", "in": "query", "required": true, "schema": { "type": "string", "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred.", "choices": [ "australia", "austria", "belgium", "brazil", "bulgaria", "canada", "chile", "china", "croatia", "cyprus", "czech_republic", "denmark", "estonia", "euro_area", "finland", "france", "germany", "greece", "hungary", "iceland", "india", "indonesia", "ireland", "israel", "italy", "japan", "korea", "latvia", "lithuania", "luxembourg", "malta", "mexico", "netherlands", "new_zealand", "norway", "poland", "portugal", "romania", "russian_federation", "slovak_republic", "slovakia", "slovenia", "south_africa", "spain", "sweden", "switzerland", "turkey", "united_kingdom", "united_states" ], "fred": { "multiple_items_allowed": true }, "title": "Country" }, "description": "The country to get data. Multiple comma separated items allowed for provider(s): fred." }, { "name": "units", "in": "query", "required": false, "schema": { "enum": [ "growth_previous", "growth_same", "index_2015" ], "type": "string", "description": "The unit of measurement for the data.\n Options:\n - `growth_previous`: Percent growth from the previous period.\n If monthly data, this is month-over-month, etc\n - `growth_same`: Percent growth from the same period in the previous year.\n If 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.", "default": "growth_same", "title": "Units" }, "description": "The unit of measurement for the data.\n Options:\n - `growth_previous`: Percent growth from the previous period.\n If monthly data, this is month-over-month, etc\n - `growth_same`: Percent growth from the same period in the previous year.\n If 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": "frequency", "in": "query", "required": false, "schema": { "enum": [ "monthly", "quarter", "annual" ], "type": "string", "description": "The frequency of the data.\n Options: `monthly`, `quarter`, and `annual`.", "default": "monthly", "title": "Frequency" }, "description": "The frequency of the data.\n Options: `monthly`, `quarter`, and `annual`." }, { "name": "harmonized", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether you wish to obtain harmonized data.", "default": false, "title": "Harmonized" }, "description": "Whether you wish to obtain harmonized data." }, { "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ConsumerPriceIndex" } } } }, "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": "ConsumerPriceIndex", "examples": [ { "scope": "api", "parameters": { "country": "japan,china,turkey", "provider": "fred" }, "provider": "fred" }, { "scope": "api", "description": "Use the `units` parameter to define the reference period for the change in values.", "parameters": { "country": "united_states,united_kingdom", "units": "growth_previous", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/economy/risk_premium": { "get": { "tags": [ "economy" ], "summary": "Risk Premium", "description": "Get Market Risk Premium by country.", "operationId": "economy_risk_premium", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "title": "Provider" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_RiskPremium" } } } }, "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": "RiskPremium", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/economy/balance_of_payments": { "get": { "tags": [ "economy" ], "summary": "Balance Of Payments", "description": "Balance of Payments Reports.", "operationId": "economy_balance_of_payments", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "ecb", "fred" ], "type": "string", "title": "Provider" } }, { "name": "report_type", "in": "query", "required": false, "schema": { "enum": [ "main", "summary", "services", "investment_income", "direct_investment", "portfolio_investment", "other_investment" ], "type": "string", "title": "ecb", "description": "The report type, the level of detail in the data. (provider: ecb)", "default": "main" }, "description": "The report type, the level of detail in the data. (provider: ecb)" }, { "name": "frequency", "in": "query", "required": false, "schema": { "enum": [ "monthly", "quarterly" ], "type": "string", "title": "ecb", "description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)", "default": "monthly" }, "description": "The frequency of the data. Monthly is valid only for ['main', 'summary']. (provider: ecb)" }, { "name": "country", "in": "query", "required": false, "schema": { "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,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": "End date of the data, in YYYY-MM-DD format. (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_BalanceOfPayments" } } } }, "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": "BalanceOfPayments", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "provider": "fred", "country": "brazil" }, "provider": "fred" }, { "scope": "api", "parameters": { "provider": "ecb" }, "provider": "ecb" }, { "scope": "api", "parameters": { "report_type": "summary", "provider": "ecb" }, "provider": "ecb" }, { "scope": "api", "description": "The `country` parameter will override the `report_type`.", "parameters": { "country": "united_states", "provider": "ecb" }, "provider": "ecb" } ] } }, "/api/v1/economy/fred_search": { "get": { "tags": [ "economy" ], "summary": "Fred Search", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The search word(s).", "title": "Query" }, "description": "The search word(s)." }, { "name": "is_release", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fred", "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)", "default": false }, "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": "release_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "fred", "description": "A specific release ID to target. (provider: fred)" }, "description": "A specific release ID to target. (provider: fred)" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fred", "description": "The number of data entries to return. (1-1000) (provider: fred)" }, "description": "The number of data entries to return. (1-1000) (provider: fred)" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "fred", "description": "Offset the results in conjunction with limit. (provider: fred)", "default": 0 }, "description": "Offset the results in conjunction with limit. (provider: fred)" }, { "name": "filter_variable", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "frequency", "units", "seasonal_adjustment" ], "type": "string" }, { "type": "null" } ], "title": "fred", "description": "Filter by an attribute. (provider: fred)" }, "description": "Filter by an attribute. (provider: fred)" }, { "name": "filter_value", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fred", "description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)" }, "description": "String value to filter the variable by. Used in conjunction with filter_variable. (provider: fred)" }, { "name": "tag_names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fred", "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)" }, "description": "A semicolon delimited list of tag names that series match all of. Example: 'japan;imports' (provider: fred)" }, { "name": "exclude_tag_names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fred", "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)" }, "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": "series_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fred", "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)" }, "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)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_FredSearch" } } } }, "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": "FredSearch", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/economy/fred_series": { "get": { "tags": [ "economy" ], "summary": "Fred Series", "description": "Get data by series ID from FRED.", "operationId": "economy_fred_series", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fred", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred.", "fred": { "multiple_items_allowed": true }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fred." }, { "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": 100000, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "frequency", "in": "query", "required": false, "schema": { "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)" }, "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)" }, { "name": "aggregation_method", "in": "query", "required": false, "schema": { "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)", "default": "eop" }, "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)" }, { "name": "transform", "in": "query", "required": false, "schema": { "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)" }, "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)" }, { "name": "all_pages", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "intrinio", "description": "Returns all pages of data from the API call at once. (provider: intrinio)", "default": false }, "description": "Returns all pages of data from the API call at once. (provider: intrinio)" }, { "name": "sleep", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "intrinio", "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)", "default": 1.0 }, "description": "Time to sleep between requests to avoid rate limiting. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_FredSeries" } } } }, "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": "FredSeries", "examples": [ { "scope": "api", "parameters": { "symbol": "NFCI", "provider": "fred" }, "provider": "fred" }, { "scope": "api", "description": "Multiple series can be passed in as a list.", "parameters": { "symbol": "NFCI,STLFSI4", "provider": "fred" }, "provider": "fred" }, { "scope": "api", "description": "Use the `transform` parameter to transform the data as change, log, or percent change.", "parameters": { "symbol": "CBBTCUSD", "transform": "pc1", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/economy/money_measures": { "get": { "tags": [ "economy" ], "summary": "Money Measures", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "federal_reserve" ], "const": "federal_reserve", "type": "string", "default": "federal_reserve", "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": "adjusted", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to return seasonally adjusted data.", "default": true, "title": "Adjusted" }, "description": "Whether to return seasonally adjusted data." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_MoneyMeasures" } } } }, "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": "MoneyMeasures", "examples": [ { "scope": "api", "parameters": { "provider": "federal_reserve" }, "provider": "federal_reserve" }, { "scope": "api", "parameters": { "adjusted": 0.0, "provider": "federal_reserve" }, "provider": "federal_reserve" } ] } }, "/api/v1/economy/unemployment": { "get": { "tags": [ "economy" ], "summary": "Unemployment", "description": "Get global unemployment data.", "operationId": "economy_unemployment", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "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": "country", "in": "query", "required": false, "schema": { "enum": [ "colombia", "new_zealand", "united_kingdom", "italy", "luxembourg", "euro_area19", "sweden", "oecd", "south_africa", "denmark", "canada", "switzerland", "slovakia", "hungary", "portugal", "spain", "france", "czech_republic", "costa_rica", "japan", "slovenia", "russia", "austria", "latvia", "netherlands", "israel", "iceland", "united_states", "ireland", "mexico", "germany", "greece", "turkey", "australia", "poland", "south_korea", "chile", "finland", "european_union27_2020", "norway", "lithuania", "euro_area20", "estonia", "belgium", "brazil", "indonesia", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" }, { "name": "sex", "in": "query", "required": false, "schema": { "enum": [ "total", "male", "female" ], "type": "string", "title": "oecd", "description": "Sex to get unemployment for. (provider: oecd)", "default": "total" }, "description": "Sex to get unemployment for. (provider: oecd)" }, { "name": "frequency", "in": "query", "required": false, "schema": { "enum": [ "monthly", "quarterly", "annual" ], "type": "string", "title": "oecd", "description": "Frequency to get unemployment for. (provider: oecd)", "default": "monthly" }, "description": "Frequency to get unemployment for. (provider: oecd)" }, { "name": "age", "in": "query", "required": false, "schema": { "enum": [ "total", "15-24", "15-64", "25-54", "55-64" ], "type": "string", "title": "oecd", "description": "Age group to get unemployment for. Total indicates 15 years or over (provider: oecd)", "default": "total" }, "description": "Age group to get unemployment for. Total indicates 15 years or over (provider: oecd)" }, { "name": "seasonal_adjustment", "in": "query", "required": false, "schema": { "type": "boolean", "title": "oecd", "description": "Whether to get seasonally adjusted unemployment. Defaults to False. (provider: oecd)", "default": false }, "description": "Whether to get seasonally adjusted unemployment. Defaults to False. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_Unemployment" } } } }, "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": "Unemployment", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "country": "all", "frequency": "quarterly", "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "description": "Demographics for the statistics are selected with the `age` parameter.", "parameters": { "country": "all", "frequency": "quarterly", "age": "25-54", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/composite_leading_indicator": { "get": { "tags": [ "economy" ], "summary": "Composite Leading Indicator", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "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": "country", "in": "query", "required": false, "schema": { "enum": [ "united_states", "united_kingdom", "japan", "mexico", "indonesia", "australia", "brazil", "canada", "italy", "germany", "turkey", "france", "south_africa", "south_korea", "spain", "india", "china", "g7", "g20", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CLI" } } } }, "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": "CLI", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "country": "all", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/short_term_interest_rate": { "get": { "tags": [ "economy" ], "summary": "Short Term Interest 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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "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": "country", "in": "query", "required": false, "schema": { "enum": [ "belgium", "ireland", "mexico", "indonesia", "new_zealand", "japan", "united_kingdom", "france", "chile", "canada", "netherlands", "united_states", "south_korea", "norway", "austria", "south_africa", "denmark", "switzerland", "hungary", "luxembourg", "australia", "germany", "sweden", "iceland", "turkey", "greece", "israel", "czech_republic", "latvia", "slovenia", "poland", "estonia", "lithuania", "portugal", "costa_rica", "slovakia", "finland", "spain", "russia", "euro_area19", "colombia", "italy", "india", "china", "croatia", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" }, { "name": "frequency", "in": "query", "required": false, "schema": { "enum": [ "monthly", "quarterly", "annual" ], "type": "string", "title": "oecd", "description": "Frequency to get interest rate for for. (provider: oecd)", "default": "monthly" }, "description": "Frequency to get interest rate for for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_STIR" } } } }, "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": "STIR", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "country": "all", "frequency": "quarterly", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/long_term_interest_rate": { "get": { "tags": [ "economy" ], "summary": "Long Term Interest Rate", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "oecd" ], "const": "oecd", "type": "string", "default": "oecd", "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": "country", "in": "query", "required": false, "schema": { "enum": [ "belgium", "ireland", "mexico", "indonesia", "new_zealand", "japan", "united_kingdom", "france", "chile", "canada", "netherlands", "united_states", "south_korea", "norway", "austria", "south_africa", "denmark", "switzerland", "hungary", "luxembourg", "australia", "germany", "sweden", "iceland", "turkey", "greece", "israel", "czech_republic", "latvia", "slovenia", "poland", "estonia", "lithuania", "portugal", "costa_rica", "slovakia", "finland", "spain", "russia", "euro_area19", "colombia", "italy", "india", "china", "croatia", "all" ], "type": "string", "title": "oecd", "description": "Country to get GDP for. (provider: oecd)", "default": "united_states" }, "description": "Country to get GDP for. (provider: oecd)" }, { "name": "frequency", "in": "query", "required": false, "schema": { "enum": [ "monthly", "quarterly", "annual" ], "type": "string", "title": "oecd", "description": "Frequency to get interest rate for for. (provider: oecd)", "default": "monthly" }, "description": "Frequency to get interest rate for for. (provider: oecd)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_LTIR" } } } }, "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": "LTIR", "examples": [ { "scope": "api", "parameters": { "provider": "oecd" }, "provider": "oecd" }, { "scope": "api", "parameters": { "country": "all", "frequency": "quarterly", "provider": "oecd" }, "provider": "oecd" } ] } }, "/api/v1/economy/fred_regional": { "get": { "tags": [ "economy" ], "summary": "Fred Regional", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "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": "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": 100000, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "is_series_group", "in": "query", "required": false, "schema": { "type": "boolean", "title": "fred", "description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)", "default": false }, "description": "When True, the symbol provided is for a series_group, else it is for a series ID. (provider: fred)" }, { "name": "region_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "bea", "msa", "frb", "necta", "state", "country", "county", "censusregion" ], "type": "string" }, { "type": "null" } ], "title": "fred", "description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)" }, "description": "The type of regional data. Parameter is only valid when `is_series_group` is True. (provider: fred)" }, { "name": "season", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "SA", "NSA", "SSA" ], "type": "string" }, { "type": "null" } ], "title": "fred", "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)", "default": "NSA" }, "description": "The seasonal adjustments to the data. Parameter is only valid when `is_series_group` is True. (provider: fred)" }, { "name": "units", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fred", "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)" }, "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": "frequency", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "d", "w", "bw", "m", "q", "sa", "a", "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 Parameter is only valid when `is_series_group` is True.\n a = Annual\n sa= Semiannual\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)" }, "description": "\n Frequency aggregation to convert high frequency data to lower frequency.\n Parameter is only valid when `is_series_group` is True.\n a = Annual\n sa= Semiannual\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)" }, { "name": "aggregation_method", "in": "query", "required": false, "schema": { "enum": [ "avg", "sum", "eop" ], "type": "string", "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 Only valid when `is_series_group` is True.\n avg = Average\n sum = Sum\n eop = End of Period\n (provider: fred)", "default": "avg" }, "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 Only valid when `is_series_group` is True.\n avg = Average\n sum = Sum\n eop = End of Period\n (provider: fred)" }, { "name": "transform", "in": "query", "required": false, "schema": { "enum": [ "lin", "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" ], "type": "string", "title": "fred", "description": "\n Transformation type. Only valid when `is_series_group` is True.\n lin = Levels (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)", "default": "lin" }, "description": "\n Transformation type. Only valid when `is_series_group` is True.\n lin = Levels (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)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_FredRegional" } } } }, "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": "FredRegional", "examples": [ { "scope": "api", "parameters": { "symbol": "NYICLAIMS", "provider": "fred" }, "provider": "fred" }, { "scope": "api", "description": "With a date, time series data is returned.", "parameters": { "symbol": "NYICLAIMS", "start_date": "2021-01-01", "end_date": "2021-12-31", "limit": 10, "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/economy/country_profile": { "get": { "tags": [ "economy" ], "summary": "Country Profile", "description": "Get a profile of country statistics and economic indicators.", "operationId": "economy_country_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "econdb" ], "const": "econdb", "type": "string", "default": "econdb", "title": "Provider" } }, { "name": "country", "in": "query", "required": true, "schema": { "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": "The country to get data. Multiple comma separated items allowed for provider(s): econdb." }, { "name": "latest", "in": "query", "required": false, "schema": { "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": "If True, return only the latest data. If False, return all available data for each indicator. (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_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" } } } }, "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": "CalendarIpo", "examples": [ { "scope": "api", "parameters": { "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Get all IPOs available.", "parameters": { "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/calendar/dividend": { "get": { "tags": [ "equity" ], "summary": "Dividend", "description": "Get historical and upcoming dividend payments. Includes dividend amount, ex-dividend and payment dates.", "operationId": "equity_calendar_dividend", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CalendarDividend" } } } }, "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": "CalendarDividend", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/calendar/splits": { "get": { "tags": [ "equity" ], "summary": "Splits", "description": "Get historical and upcoming stock split operations.", "operationId": "equity_calendar_splits", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CalendarSplits" } } } }, "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": "CalendarSplits", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Get stock splits calendar for specific dates.", "parameters": { "start_date": "2024-02-01", "end_date": "2024-02-07", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/calendar/earnings": { "get": { "tags": [ "equity" ], "summary": "Earnings", "description": "Get historical and upcoming company earnings releases. Includes earnings per share (EPS) and revenue data.", "operationId": "equity_calendar_earnings", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CalendarEarnings" } } } }, "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": "CalendarEarnings", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Get earnings calendar for specific dates.", "parameters": { "start_date": "2024-02-01", "end_date": "2024-02-07", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/compare/peers": { "get": { "tags": [ "equity" ], "summary": "Peers", "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.", "operationId": "equity_compare_peers", "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_EquityPeers" } } } }, "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": "EquityPeers", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/compare/company_facts": { "get": { "tags": [ "equity" ], "summary": "Company Facts", "description": "Copmare reported company facts and fundamental data points.", "operationId": "equity_compare_company_facts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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): sec." }, { "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": { "type": "integer", "description": "The number of data entries to return.", "default": 200, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "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)", "default": 0 }, "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": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "benzinga", "description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)" }, "description": "Date for calendar data, shorthand for date_from and date_to. (provider: benzinga)" }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "benzinga", "description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)" }, "description": "Start date of the data, in YYYY-MM-DD format. (provider: benzinga)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "benzinga", "description": "End date of the data, in YYYY-MM-DD format. (provider: benzinga)" }, "description": "End date of the data, in YYYY-MM-DD format. (provider: benzinga)" }, { "name": "updated", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "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)" }, "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": "importance", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)" }, "description": "Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga)" }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "downgrades", "maintains", "reinstates", "reiterates", "upgrades", "assumes", "initiates", "terminates", "removes", "suspends", "firm_dissolved" ], "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Filter by a specific action_company. (provider: benzinga)" }, "description": "Filter by a specific action_company. (provider: benzinga)" }, { "name": "analyst_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: 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)" }, { "name": "firm_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)", "benzinga": [ "multiple_items_allowed" ] }, "description": "Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga)" }, { "name": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: 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)" }, { "name": "with_grade", "in": "query", "required": false, "schema": { "type": "boolean", "title": "fmp", "description": "Include upgrades and downgrades in the response. (provider: fmp)", "default": false }, "description": "Include upgrades and downgrades in the response. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_PriceTarget" } } } }, "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": "PriceTarget", "examples": [ { "scope": "api", "parameters": { "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "description": "Get price targets for Microsoft using 'benzinga' as provider.", "parameters": { "start_date": "2020-01-01", "end_date": "2024-02-16", "limit": 10, "symbol": "msft", "provider": "benzinga", "action": "downgrades" }, "provider": "benzinga" } ] } }, "/api/v1/equity/estimates/historical": { "get": { "tags": [ "equity" ], "summary": "Historical", "description": "Get historical analyst estimates for earnings and revenue.", "operationId": "equity_estimates_historical", "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." }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "quarter", "annual" ], "type": "string", "title": "fmp", "description": "Time period of the data to return. (provider: fmp)", "default": "annual" }, "description": "Time period of the data to return. (provider: fmp)" }, { "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_AnalystEstimates" } } } }, "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": "AnalystEstimates", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/estimates/consensus": { "get": { "tags": [ "equity" ], "summary": "Consensus", "description": "Get consensus price target and recommendation.", "operationId": "equity_estimates_consensus", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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): 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." }, { "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_PriceTargetConsensus" } } } }, "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": "PriceTargetConsensus", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/estimates/analyst_search": { "get": { "tags": [ "equity" ], "summary": "Analyst Search", "description": "Search for specific analysts and get their forecast track record.", "operationId": "equity_estimates_analyst_search", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "benzinga" ], "const": "benzinga", "type": "string", "default": "benzinga", "title": "Provider" } }, { "name": "analyst_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): 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." }, { "name": "firm_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): 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." }, { "name": "analyst_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)", "benzinga": { "multiple_items_allowed": true } }, "description": "List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, { "name": "firm_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)", "benzinga": { "multiple_items_allowed": true } }, "description": "Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga)" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Number of results returned. Limit 1000. (provider: benzinga)", "default": 100 }, "description": "Number of results returned. Limit 1000. (provider: benzinga)" }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "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)", "default": 0 }, "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": "fields", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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)", "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)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_AnalystSearch" } } } }, "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": "AnalystSearch", "examples": [ { "scope": "api", "parameters": { "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "parameters": { "firm_name": "Wedbush", "provider": "benzinga" }, "provider": "benzinga" } ] } }, "/api/v1/equity/estimates/forward_sales": { "get": { "tags": [ "equity" ], "summary": "Forward Sales", "description": "Get forward sales estimates.", "operationId": "equity_estimates_forward_sales", "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. 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." }, { "name": "fiscal_year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { "name": "fiscal_period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "fy", "q1", "q2", "q3", "q4" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" }, "description": "The future fiscal period to retrieve estimates for. (provider: intrinio)" }, { "name": "calendar_year", "in": "query", "required": false, "schema": { "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 future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { "name": "calendar_period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "q1", "q2", "q3", "q4" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" }, "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ForwardSalesEstimates" } } } }, "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": "ForwardSalesEstimates", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "parameters": { "fiscal_year": 2025, "fiscal_period": "fy", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/estimates/forward_ebitda": { "get": { "tags": [ "equity" ], "summary": "Forward Ebitda", "description": "Get forward EBITDA estimates.", "operationId": "equity_estimates_forward_ebitda", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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): 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." }, { "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ForwardEbitdaEstimates" } } } }, "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": "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" } ] } }, "/api/v1/equity/estimates/forward_eps": { "get": { "tags": [ "equity" ], "summary": "Forward Eps", "description": "Get forward EPS estimates.", "operationId": "equity_estimates_forward_eps", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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): 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." }, { "name": "fiscal_period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "annual", "quarter" ], "type": "string" }, { "enum": [ "fy", "q1", "q2", "q3", "q4" ], "type": "string" }, { "type": "null" } ], "title": "fmp,intrinio", "description": "The future fiscal period to retrieve estimates for. (provider: fmp, intrinio)", "default": "annual" }, "description": "The future fiscal period to retrieve estimates for. (provider: fmp, 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": "fiscal_year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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": "The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { "name": "calendar_year", "in": "query", "required": false, "schema": { "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 future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio)" }, { "name": "calendar_period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "q1", "q2", "q3", "q4" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" }, "description": "The future calendar period to retrieve estimates for. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ForwardEpsEstimates" } } } }, "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": "ForwardEpsEstimates", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "parameters": { "fiscal_year": 2025, "fiscal_period": "fy", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/estimates/forward_pe": { "get": { "tags": [ "equity" ], "summary": "Forward Pe", "description": "Get forward PE estimates.", "operationId": "equity_estimates_forward_pe", "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. 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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ForwardPeEstimates" } } } }, "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": "ForwardPeEstimates", "examples": [ { "scope": "api", "parameters": { "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "parameters": { "symbol": "AAPL,MSFT,GOOG", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/discovery/filings": { "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.\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": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "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": "form_type", "in": "query", "required": false, "schema": { "anyOf": [ { "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" }, "description": "Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types." }, { "name": "limit", "in": "query", "required": false, "schema": { "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" }, { "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": "null" } ], "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": "period_of_report_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "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" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than the given date. (provider: polygon)" }, "description": "Period of report date less than the given date. (provider: polygon)" }, { "name": "period_of_report_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, { "name": "period_of_report_date_gt", "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)" }, "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": true }, "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_BalanceSheet" } } } }, "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": "BalanceSheet", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "limit": 5, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/balance_growth": { "get": { "tags": [ "equity" ], "summary": "Balance Growth", "description": "Get the growth of a company's balance sheet items over time.", "operationId": "equity_fundamental_balance_growth", "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." }, { "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_BalanceSheetGrowth" } } } }, "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": "BalanceSheetGrowth", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "limit": 10, "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/cash": { "get": { "tags": [ "equity" ], "summary": "Cash", "description": "Get the cash flow statement for a given company.", "operationId": "equity_fundamental_cash", "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" }, { "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": "null" } ], "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": "period_of_report_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "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" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than the given date. (provider: polygon)" }, "description": "Period of report date less than the given date. (provider: polygon)" }, { "name": "period_of_report_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, { "name": "period_of_report_date_gt", "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)" }, "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CashFlowStatement" } } } }, "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": "CashFlowStatement", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "limit": 5, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/reported_financials": { "get": { "tags": [ "equity" ], "summary": "Reported Financials", "description": "Get financial statements as reported by the company.", "operationId": "equity_fundamental_reported_financials", "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.", "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": "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, "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)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ReportedFinancials" } } } }, "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": "ReportedFinancials", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Get AAPL balance sheet with a limit of 10 items.", "parameters": { "symbol": "AAPL", "period": "annual", "statement_type": "balance", "limit": 10, "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Get reported income statement", "parameters": { "symbol": "AAPL", "statement_type": "income", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Get reported cash flow statement", "parameters": { "symbol": "AAPL", "statement_type": "cash", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/cash_growth": { "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", "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." }, { "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": { "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" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "model": "CashFlowStatementGrowth", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "limit": 10, "provider": "fmp" }, "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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": "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" } ], "title": "intrinio", "description": "The number of data entries to return. (provider: intrinio)", "default": 100 }, "description": "The number of data entries to return. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_HistoricalDividends" } } } }, "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": "HistoricalDividends", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/historical_eps": { "get": { "tags": [ "equity" ], "summary": "Historical Eps", "description": "Get historical earnings per share data for a given company.", "operationId": "equity_fundamental_historical_eps", "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." }, { "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." }, { "name": "tag", "in": "query", "required": true, "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", "intrinio": { "multiple_items_allowed": true }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_LatestAttributes" } } } }, "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": "LatestAttributes", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "tag": "ceo", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/historical_attributes": { "get": { "tags": [ "equity" ], "summary": "Historical Attributes", "description": "Get the historical values of a data tag from Intrinio.", "operationId": "equity_fundamental_historical_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." }, { "name": "tag", "in": "query", "required": true, "schema": { "type": "string", "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio.", "intrinio": { "multiple_items_allowed": true }, "title": "Tag" }, "description": "Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio." }, { "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": "frequency", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "daily", "weekly", "monthly", "quarterly", "yearly" ], "type": "string" }, { "type": "null" } ], "description": "The frequency of the data.", "default": "yearly", "title": "Frequency" }, "description": "The frequency of the data." }, { "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." }, { "name": "tag_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by type, when applicable.", "title": "Tag Type" }, "description": "Filter by type, when applicable." }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "description": "Sort order.", "default": "desc", "title": "Sort" }, "description": "Sort order." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_HistoricalAttributes" } } } }, "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": "HistoricalAttributes", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "tag": "ebitda", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/income": { "get": { "tags": [ "equity" ], "summary": "Income", "description": "Get the income statement for a given company.", "operationId": "equity_fundamental_income", "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" }, { "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": "null" } ], "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": "period_of_report_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "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" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than the given date. (provider: polygon)" }, "description": "Period of report date less than the given date. (provider: polygon)" }, { "name": "period_of_report_date_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "polygon", "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, "description": "Period of report date less than or equal to the given date. (provider: polygon)" }, { "name": "period_of_report_date_gt", "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)" }, "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": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "polygon", "description": "Whether to include the sources of the financial statement. (provider: polygon)" }, "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_IncomeStatement" } } } }, "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": "IncomeStatement", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "limit": 5, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/income_growth": { "get": { "tags": [ "equity" ], "summary": "Income Growth", "description": "Get the growth of a company's income statement items over time.", "operationId": "equity_fundamental_income_growth", "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." }, { "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." }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "annual", "quarter" ], "type": "string", "description": "Time period of the data to return.", "default": "annual", "title": "Period" }, "description": "Time period of the data to return." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_IncomeStatementGrowth" } } } }, "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": "IncomeStatementGrowth", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "limit": 10, "period": "annual", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/metrics": { "get": { "tags": [ "equity" ], "summary": "Metrics", "description": "Get fundamental metrics for a given company.", "operationId": "equity_fundamental_metrics", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." }, { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "annual", "quarter" ], "type": "string" }, { "type": "null" } ], "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" }, { "type": "null" } ], "description": "The number of data entries to return.", "default": 100, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "with_ttm", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "Include trailing twelve months (TTM) data. (provider: fmp)", "default": false }, "description": "Include trailing twelve months (TTM) data. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_KeyMetrics" } } } }, "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": "KeyMetrics", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "limit": 100, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/management": { "get": { "tags": [ "equity" ], "summary": "Management", "description": "Get executive management team data for a given company.", "operationId": "equity_fundamental_management", "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_KeyExecutives" } } } }, "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": "KeyExecutives", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/management_compensation": { "get": { "tags": [ "equity" ], "summary": "Management Compensation", "description": "Get executive management team compensation for a given company over time.", "operationId": "equity_fundamental_management_compensation", "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." }, { "name": "year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Year of the compensation. (provider: fmp)" }, "description": "Year of the compensation. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ExecutiveCompensation" } } } }, "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": "ExecutiveCompensation", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/overview": { "get": { "tags": [ "equity" ], "summary": "This endpoint is deprecated; use `/equity/profile` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3.", "description": "Get company general business and stock data for a given company.", "operationId": "equity_fundamental_overview", "deprecated": true, "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_CompanyOverview" } } } }, "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": "CompanyOverview", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/ratios": { "get": { "tags": [ "equity" ], "summary": "Ratios", "description": "Get an extensive set of financial and accounting ratios for a given company over time.", "operationId": "equity_fundamental_ratios", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.", "fmp": { "multiple_items_allowed": true }, "title": "Symbol" }, "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp." }, { "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", "description": "The number of data entries to return.", "default": 12, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "with_ttm", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "Include trailing twelve months (TTM) data. (provider: fmp)", "default": false }, "description": "Include trailing twelve months (TTM) data. (provider: fmp)" }, { "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_FinancialRatios" } } } }, "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": "FinancialRatios", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "limit": 12, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/fundamental/revenue_per_geography": { "get": { "tags": [ "equity" ], "summary": "Revenue Per Geography", "description": "Get the revenue geographic breakdown for a given company over time.", "operationId": "equity_fundamental_revenue_per_geography", "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." }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "quarter", "annual" ], "type": "string", "description": "Time period of the data to return.", "default": "annual", "title": "Period" }, "description": "Time period of the data to return." }, { "name": "structure", "in": "query", "required": false, "schema": { "enum": [ "hierarchical", "flat" ], "type": "string", "description": "Structure of the returned data.", "default": "flat", "title": "Structure" }, "description": "Structure of the returned data." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_RevenueGeographic" } } } }, "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": "RevenueGeographic", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "structure": "flat", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/revenue_per_segment": { "get": { "tags": [ "equity" ], "summary": "Revenue Per Segment", "description": "Get the revenue breakdown by business segment for a given company over time.", "operationId": "equity_fundamental_revenue_per_segment", "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." }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "quarter", "annual" ], "type": "string", "description": "Time period of the data to return.", "default": "annual", "title": "Period" }, "description": "Time period of the data to return." }, { "name": "structure", "in": "query", "required": false, "schema": { "enum": [ "hierarchical", "flat" ], "type": "string", "description": "Structure of the returned data.", "default": "flat", "title": "Structure" }, "description": "Structure of the returned data." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_RevenueBusinessLine" } } } }, "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": "RevenueBusinessLine", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "period": "annual", "structure": "flat", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/filings": { "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_fundamental_filings", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "sec" ], "type": "string", "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": "form_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by form type. Check the data provider for available types.", "title": "Form Type" }, "description": "Filter by form type. Check the data provider for available types." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "The number of data entries to return.", "default": 100, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, { "name": "thea_enabled", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "intrinio", "description": "Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)" }, "description": "Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)" }, { "name": "cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "sec", "description": "Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)" }, "description": "Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)" }, { "name": "use_cache", "in": "query", "required": false, "schema": { "type": "boolean", "title": "sec", "description": "Whether or not to use cache. If True, cache will store for one day. (provider: sec)", "default": true }, "description": "Whether or not to use cache. If True, cache will store for one day. (provider: sec)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CompanyFilings" } } } }, "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": "CompanyFilings", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "limit": 100, "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/historical_splits": { "get": { "tags": [ "equity" ], "summary": "Historical Splits", "description": "Get historical stock splits for a given company.", "operationId": "equity_fundamental_historical_splits", "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_HistoricalSplits" } } } }, "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": "HistoricalSplits", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/fundamental/transcript": { "get": { "tags": [ "equity" ], "summary": "Transcript", "description": "Get earnings call transcripts for a given company.", "operationId": "equity_fundamental_transcript", "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." }, { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "description": "Year of the earnings call transcript.", "title": "Year" }, "description": "Year of the earnings call transcript." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EarningsCallTranscript" } } } }, "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": "EarningsCallTranscript", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "year": 2020, "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/ownership/major_holders": { "get": { "tags": [ "equity" ], "summary": "Major Holders", "description": "Get data about major holders for a given company over time.", "operationId": "equity_ownership_major_holders", "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." }, { "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": "page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Page number of the data to fetch.", "default": 0, "title": "Page" }, "description": "Page number of the data to fetch." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityOwnership" } } } }, "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": "EquityOwnership", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "page": 0, "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/ownership/institutional": { "get": { "tags": [ "equity" ], "summary": "Institutional", "description": "Get data about institutional ownership for a given company over time.", "operationId": "equity_ownership_institutional", "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." }, { "name": "include_current_quarter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "Include current quarter data. (provider: fmp)", "default": false }, "description": "Include current quarter data. (provider: fmp)" }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "fmp", "description": "A specific date to get data for. (provider: fmp)" }, "description": "A specific date to get data for. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_InstitutionalOwnership" } } } }, "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": "InstitutionalOwnership", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/ownership/insider_trading": { "get": { "tags": [ "equity" ], "summary": "Insider Trading", "description": "Get data about trading by a company's management team and board of directors.", "operationId": "equity_ownership_insider_trading", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "The number of data entries to return.", "default": 500, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "transactionType", "in": "query", "required": false, "schema": { "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)" }, "description": "Type of the transaction. (provider: fmp)" }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, "description": "Start date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "intrinio", "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, "description": "End date of the data, in YYYY-MM-DD format. (provider: intrinio)" }, { "name": "ownership_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "D", "I" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "Type of ownership. (provider: intrinio)" }, "description": "Type of ownership. (provider: intrinio)" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "filing_date", "updated_on" ], "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "Field to sort by. (provider: intrinio)", "default": "updated_on" }, "description": "Field to sort by. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_InsiderTrading" } } } }, "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": "InsiderTrading", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "limit": 500, "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/ownership/share_statistics": { "get": { "tags": [ "equity" ], "summary": "Share Statistics", "description": "Get data about share float for a given company.", "operationId": "equity_ownership_share_statistics", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ShareStatistics" } } } }, "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": "ShareStatistics", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/ownership/form_13f": { "get": { "tags": [ "equity" ], "summary": "Form 13F", "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": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. A CIK or Symbol can be used.", "title": "Symbol" }, "description": "Symbol to get data for. A CIK or Symbol can be used." }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.", "title": "Date" }, "description": "A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.", "default": 1, "title": "Limit" }, "description": "The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_Form13FHR" } } } }, "404": { "description": "Not found" }, "400": { "description": "No Results Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "model": "Form13FHR", "examples": [ { "scope": "api", "parameters": { "symbol": "NVDA", "provider": "sec" }, "provider": "sec" }, { "scope": "api", "description": "Enter a date (calendar quarter ending) for a specific report.", "parameters": { "symbol": "BRK-A", "date": "2016-09-30", "provider": "sec" }, "provider": "sec" }, { "scope": "python", "description": "Example finding Michael Burry's filings.", "code": [ "cik = obb.regulators.sec.institutions_search(\"Scion Asset Management\").results[0].cik", "# Use the `limit` parameter to return N number of reports from the most recent.", "obb.equity.ownership.form_13f(cik, limit=2).to_df()" ] } ] } }, "/api/v1/equity/price/quote": { "get": { "tags": [ "equity" ], "summary": "Quote", "description": "Get the latest quote for a given stock. Quote includes price, volume, and other data.", "operationId": "equity_price_quote", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." }, { "name": "source", "in": "query", "required": false, "schema": { "enum": [ "iex", "bats", "bats_delayed", "utp_delayed", "cta_a_delayed", "cta_b_delayed", "intrinio_mx", "intrinio_mx_plus", "delayed_sip" ], "type": "string", "title": "intrinio", "description": "Source of the data. (provider: intrinio)", "default": "iex" }, "description": "Source of the data. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityQuote" } } } }, "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": "EquityQuote", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/price/nbbo": { "get": { "tags": [ "equity" ], "summary": "Nbbo", "description": "Get the National Best Bid and Offer for a given stock.", "operationId": "equity_price_nbbo", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "polygon" ], "const": "polygon", "type": "string", "default": "polygon", "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", "title": "polygon", "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)", "default": 50000 }, "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": "timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "polygon", "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon)" }, "description": "A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon)" }, { "name": "timestamp_lt", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "polygon", "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, "description": "Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, { "name": "timestamp_gt", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "polygon", "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, "description": "Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, { "name": "timestamp_lte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "polygon", "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, "description": "Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, { "name": "timestamp_gte", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "polygon", "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" }, "description": "Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityNBBO" } } } }, "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": "EquityNBBO", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "polygon" }, "provider": "polygon" } ] } }, "/api/v1/equity/price/historical": { "get": { "tags": [ "equity" ], "summary": "Historical", "description": "Get historical price data for a given stock. This includes open, high, low, close, and volume.", "operationId": "equity_price_historical", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", "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." }, { "name": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Time interval of the data to return.", "default": "1d", "title": "Interval" }, "description": "Time interval of the data to return." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Start date of the data, in YYYY-MM-DD format.", "title": "Start Date" }, "description": "Start date of the data, in YYYY-MM-DD format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "End date of the data, in YYYY-MM-DD format.", "title": "End Date" }, "description": "End date of the data, in YYYY-MM-DD format." }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "intrinio", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "intrinio", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, { "name": "timezone", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)", "default": "America/New_York" }, "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)" }, { "name": "source", "in": "query", "required": false, "schema": { "enum": [ "realtime", "delayed", "nasdaq_basic" ], "type": "string", "title": "intrinio", "description": "The source of the data. (provider: intrinio)", "default": "realtime" }, "description": "The source of the data. (provider: intrinio)" }, { "name": "adjustment", "in": "query", "required": false, "schema": { "enum": [ "splits_only", "unadjusted" ], "type": "string", "title": "polygon", "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)", "default": "splits_only" }, "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)" }, { "name": "extended_hours", "in": "query", "required": false, "schema": { "type": "boolean", "title": "polygon", "description": "Include Pre and Post market data. (provider: polygon)", "default": false }, "description": "Include Pre and Post market data. (provider: polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "title": "polygon", "description": "The number of data entries to return. (provider: polygon)", "default": 49999 }, "description": "The number of data entries to return. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityHistorical" } } } }, "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": "EquityHistorical", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "AAPL", "interval": "1d", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/price/performance": { "get": { "tags": [ "equity" ], "summary": "Performance", "description": "Get price performance data for a given stock. This includes price changes for different time periods.", "operationId": "equity_price_performance", "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_PricePerformance" } } } }, "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": "PricePerformance", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/shorts/fails_to_deliver": { "get": { "tags": [ "equity" ], "summary": "Fails To Deliver", "description": "Get reported Fail-to-deliver (FTD) data.", "operationId": "equity_shorts_fails_to_deliver", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for.", "title": "Symbol" }, "description": "Symbol to get data for." }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "sec", "description": "\n Limit the number of reports to parse, from most recent.\n Approximately 24 reports per year, going back to 2009.\n (provider: sec)", "default": 24 }, "description": "\n Limit the number of reports to parse, from most recent.\n Approximately 24 reports per year, going back to 2009.\n (provider: sec)" }, { "name": "skip_reports", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "sec", "description": "\n Skip N number of reports from current. A value of 1 will skip the most recent report.\n (provider: sec)", "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityFTD" } } } }, "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": "EquityFTD", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "sec" }, "provider": "sec" } ] } }, "/api/v1/equity/search": { "get": { "tags": [ "equity" ], "summary": "Search", "description": "Search for stock symbol, CIK, LEI, or company name.", "operationId": "equity_search", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "intrinio", "sec" ], "type": "string", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "description": "Search query.", "default": "", "title": "Query" }, "description": "Search query." }, { "name": "is_symbol", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to search by ticker symbol.", "default": false, "title": "Is Symbol" }, "description": "Whether to search by ticker symbol." }, { "name": "use_cache", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to use the cache or not.", "default": true, "title": "Use Cache" }, "description": "Whether to use the cache or not." }, { "name": "active", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "intrinio", "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)", "default": true }, "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": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "intrinio", "description": "The number of data entries to return. (provider: intrinio)", "default": 10000 }, "description": "The number of data entries to return. (provider: intrinio)" }, { "name": "is_fund", "in": "query", "required": false, "schema": { "type": "boolean", "title": "sec", "description": "Whether to direct the search to the list of mutual funds and ETFs. (provider: sec)", "default": false }, "description": "Whether to direct the search to the list of mutual funds and ETFs. (provider: sec)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquitySearch" } } } }, "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": "EquitySearch", "examples": [ { "scope": "api", "parameters": { "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/equity/screener": { "get": { "tags": [ "equity" ], "summary": "Screener", "description": "Screen for companies meeting various criteria.\n\nThese criteria include market cap, price, beta, volume, and dividend yield.", "operationId": "equity_screener", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "title": "Provider" } }, { "name": "mktcap_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Filter by market cap greater than this value. (provider: fmp)" }, "description": "Filter by market cap greater than this value. (provider: fmp)" }, { "name": "mktcap_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Filter by market cap less than this value. (provider: fmp)" }, "description": "Filter by market cap less than this value. (provider: fmp)" }, { "name": "price_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by price greater than this value. (provider: fmp)" }, "description": "Filter by price greater than this value. (provider: fmp)" }, { "name": "price_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by price less than this value. (provider: fmp)" }, "description": "Filter by price less than this value. (provider: fmp)" }, { "name": "beta_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by a beta greater than this value. (provider: fmp)" }, "description": "Filter by a beta greater than this value. (provider: fmp)" }, { "name": "beta_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by a beta less than this value. (provider: fmp)" }, "description": "Filter by a beta less than this value. (provider: fmp)" }, { "name": "volume_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Filter by volume greater than this value. (provider: fmp)" }, "description": "Filter by volume greater than this value. (provider: fmp)" }, { "name": "volume_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Filter by volume less than this value. (provider: fmp)" }, "description": "Filter by volume less than this value. (provider: fmp)" }, { "name": "dividend_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by dividend amount greater than this value. (provider: fmp)" }, "description": "Filter by dividend amount greater than this value. (provider: fmp)" }, { "name": "dividend_max", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "fmp", "description": "Filter by dividend amount less than this value. (provider: fmp)" }, "description": "Filter by dividend amount less than this value. (provider: fmp)" }, { "name": "is_etf", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "If true, returns only ETFs. (provider: fmp)", "default": false }, "description": "If true, returns only ETFs. (provider: fmp)" }, { "name": "is_active", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "If false, returns only inactive tickers. (provider: fmp)", "default": true }, "description": "If false, returns only inactive tickers. (provider: fmp)" }, { "name": "sector", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "consumer_cyclical", "energy", "technology", "industrials", "financial_services", "basic_materials", "communication_services", "consumer_defensive", "healthcare", "real_estate", "utilities", "industrial_goods", "financial", "services", "conglomerates" ], "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "Filter by sector. (provider: fmp)" }, "description": "Filter by sector. (provider: fmp)" }, { "name": "industry", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "Filter by industry. (provider: fmp)" }, "description": "Filter by industry. (provider: fmp)" }, { "name": "country", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "Filter by country, as a two-letter country code. (provider: fmp)" }, "description": "Filter by country, as a two-letter country code. (provider: fmp)" }, { "name": "exchange", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "amex", "ams", "ase", "asx", "ath", "bme", "bru", "bud", "bue", "cai", "cnq", "cph", "dfm", "doh", "etf", "euronext", "hel", "hkse", "ice", "iob", "ist", "jkt", "jnb", "jpx", "kls", "koe", "ksc", "kuw", "lse", "mex", "mutual_fund", "nasdaq", "neo", "nse", "nyse", "nze", "osl", "otc", "pnk", "pra", "ris", "sao", "sau", "set", "sgo", "shh", "shz", "six", "sto", "tai", "tlv", "tsx", "two", "vie", "wse", "xetra" ], "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "Filter by exchange. (provider: fmp)" }, "description": "Filter by exchange. (provider: fmp)" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Limit the number of results to return. (provider: fmp)", "default": 50000 }, "description": "Limit the number of results to return. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityScreener" } } } }, "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": "EquityScreener", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/profile": { "get": { "tags": [ "equity" ], "summary": "Profile", "description": "Get general information about a company. This includes company name, industry, sector and price data.", "operationId": "equity_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EquityInfo" } } } }, "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": "EquityInfo", "examples": [ { "scope": "api", "parameters": { "symbol": "AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/equity/market_snapshots": { "get": { "tags": [ "equity" ], "summary": "Market Snapshots", "description": "Get an updated equity market snapshot. This includes price data for thousands of stocks.", "operationId": "equity_market_snapshots", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "market", "in": "query", "required": false, "schema": { "enum": [ "amex", "ams", "ase", "asx", "ath", "bme", "bru", "bud", "bue", "cai", "cnq", "cph", "dfm", "doh", "etf", "euronext", "hel", "hkse", "ice", "iob", "ist", "jkt", "jnb", "jpx", "kls", "koe", "ksc", "kuw", "lse", "mex", "mutual_fund", "nasdaq", "neo", "nse", "nyse", "nze", "osl", "otc", "pnk", "pra", "ris", "sao", "sau", "set", "sgo", "shh", "shz", "six", "sto", "tai", "tlv", "tsx", "two", "vie", "wse", "xetra" ], "type": "string", "title": "fmp", "description": "The market to fetch data for. (provider: fmp)", "default": "nasdaq" }, "description": "The market to fetch data for. (provider: fmp)" }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio)" }, "description": "The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_MarketSnapshots" } } } }, "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": "MarketSnapshots", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/search": { "get": { "tags": [ "etf" ], "summary": "Search", "description": "Search for ETFs.\n\nAn empty query returns the full list of ETFs from the provider.", "operationId": "etf_search", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search query.", "default": "", "title": "Query" }, "description": "Search query." }, { "name": "exchange", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "AMEX", "NYSE", "NASDAQ", "ETF", "TSX", "EURONEXT" ], "type": "string" }, { "enum": [ "xnas", "arcx", "bats", "xnys", "bvmf", "xshg", "xshe", "xhkg", "xbom", "xnse", "xidx", "tase", "xkrx", "xkls", "xmex", "xses", "roco", "xtai", "xbkk", "xist" ], "type": "string" }, { "type": "null" } ], "title": "fmp,intrinio", "description": "The exchange code the ETF trades on. (provider: fmp);\n Target a specific exchange by providing the MIC code. (provider: intrinio)" }, "description": "The exchange code the ETF trades on. (provider: fmp);\n Target a specific exchange by providing the MIC code. (provider: intrinio)" }, { "name": "is_active", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ true, false ], "type": "boolean" }, { "type": "null" } ], "title": "fmp", "description": "Whether the ETF is actively trading. (provider: fmp)" }, "description": "Whether the ETF is actively trading. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfSearch" } } } }, "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": "EtfSearch", "examples": [ { "scope": "api", "description": "An empty query returns the full list of ETFs from the provider.", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "The query will return results from text-based fields containing the term.", "parameters": { "query": "commercial real estate", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/historical": { "get": { "tags": [ "etf" ], "summary": "Historical", "description": "ETF Historical Market Price.", "operationId": "etf_historical", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon.", "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." }, { "name": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Time interval of the data to return.", "default": "1d", "title": "Interval" }, "description": "Time interval of the data to return." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Start date of the data, in YYYY-MM-DD format.", "title": "Start Date" }, "description": "Start date of the data, in YYYY-MM-DD format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "End date of the data, in YYYY-MM-DD format.", "title": "End Date" }, "description": "End date of the data, in YYYY-MM-DD format." }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "intrinio", "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, "description": "Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "intrinio", "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, "description": "Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio)" }, { "name": "timezone", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "intrinio", "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)", "default": "America/New_York" }, "description": "Timezone of the data, in the IANA format (Continent/City). (provider: intrinio)" }, { "name": "source", "in": "query", "required": false, "schema": { "enum": [ "realtime", "delayed", "nasdaq_basic" ], "type": "string", "title": "intrinio", "description": "The source of the data. (provider: intrinio)", "default": "realtime" }, "description": "The source of the data. (provider: intrinio)" }, { "name": "adjustment", "in": "query", "required": false, "schema": { "enum": [ "splits_only", "unadjusted" ], "type": "string", "title": "polygon", "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)", "default": "splits_only" }, "description": "The adjustment factor to apply. Default is splits only. (provider: polygon)" }, { "name": "extended_hours", "in": "query", "required": false, "schema": { "type": "boolean", "title": "polygon", "description": "Include Pre and Post market data. (provider: polygon)", "default": false }, "description": "Include Pre and Post market data. (provider: polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "title": "polygon", "description": "The number of data entries to return. (provider: polygon)", "default": 49999 }, "description": "The number of data entries to return. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfHistorical" } } } }, "404": { "description": "Not found" }, "400": { "description": "No Results Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenBBErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "model": "EtfHistorical", "examples": [ { "scope": "api", "parameters": { "symbol": "SPY", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/info": { "get": { "tags": [ "etf" ], "summary": "Info", "description": "ETF Information Overview.", "operationId": "etf_info", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. (ETF) 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. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfInfo" } } } }, "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": "EtfInfo", "examples": [ { "scope": "api", "parameters": { "symbol": "SPY", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "This function accepts multiple tickers.", "parameters": { "symbol": "SPY,IWM,QQQ,DJIA", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/sectors": { "get": { "tags": [ "etf" ], "summary": "Sectors", "description": "ETF Sector weighting.", "operationId": "etf_sectors", "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. (ETF)", "title": "Symbol" }, "description": "Symbol to get data for. (ETF)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfSectors" } } } }, "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": "EtfSectors", "examples": [ { "scope": "api", "parameters": { "symbol": "SPY", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/countries": { "get": { "tags": [ "etf" ], "summary": "Countries", "description": "ETF Country weighting.", "operationId": "etf_countries", "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. (ETF) Multiple comma separated items allowed for provider(s): fmp.", "fmp": { "multiple_items_allowed": true }, "title": "Symbol" }, "description": "Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfCountries" } } } }, "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": "EtfCountries", "examples": [ { "scope": "api", "parameters": { "symbol": "VT", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/price_performance": { "get": { "tags": [ "etf" ], "summary": "Price Performance", "description": "Price performance as a return, over different periods.", "operationId": "etf_price_performance", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." }, { "name": "return_type", "in": "query", "required": false, "schema": { "enum": [ "trailing", "calendar" ], "type": "string", "title": "intrinio", "description": "The type of returns to return, a trailing or calendar window. (provider: intrinio)", "default": "trailing" }, "description": "The type of returns to return, a trailing or calendar window. (provider: intrinio)" }, { "name": "adjustment", "in": "query", "required": false, "schema": { "enum": [ "splits_only", "splits_and_dividends" ], "type": "string", "title": "intrinio", "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)", "default": "splits_and_dividends" }, "description": "The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfPricePerformance" } } } }, "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": "EtfPricePerformance", "examples": [ { "scope": "api", "parameters": { "symbol": "QQQ", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "symbol": "SPY,QQQ,IWM,DJIA", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/holdings": { "get": { "tags": [ "etf" ], "summary": "Holdings", "description": "Get the holdings for an individual ETF.", "operationId": "etf_holdings", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "sec" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. (ETF)", "title": "Symbol" }, "description": "Symbol to get data for. (ETF)" }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date" }, { "type": "null" } ], "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. (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", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)" }, "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)" }, { "name": "use_cache", "in": "query", "required": false, "schema": { "type": "boolean", "title": "sec", "description": "Whether or not to use cache for the request. (provider: sec)", "default": true }, "description": "Whether or not to use cache for the request. (provider: sec)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfHoldings" } } } }, "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": "EtfHoldings", "examples": [ { "scope": "api", "parameters": { "symbol": "XLK", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.", "parameters": { "symbol": "XLK", "date": "2022-03-31", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "The same data can be returned from the SEC directly.", "parameters": { "symbol": "XLK", "date": "2022-03-31", "provider": "sec" }, "provider": "sec" } ] } }, "/api/v1/etf/holdings_date": { "get": { "tags": [ "etf" ], "summary": "Holdings Date", "description": "Use this function to get the holdings dates, if available.", "operationId": "etf_holdings_date", "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. (ETF)", "title": "Symbol" }, "description": "Symbol to get data for. (ETF)" }, { "name": "cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "fmp", "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)" }, "description": "The CIK of the filing entity. Overrides symbol. (provider: fmp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfHoldingsDate" } } } }, "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": "EtfHoldingsDate", "examples": [ { "scope": "api", "parameters": { "symbol": "XLK", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/etf/equity_exposure": { "get": { "tags": [ "etf" ], "summary": "Equity Exposure", "description": "Get the exposure to ETFs for a specific stock.", "operationId": "etf_equity_exposure", "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. (Stock) Multiple comma separated items allowed for provider(s): fmp.", "fmp": { "multiple_items_allowed": true }, "title": "Symbol" }, "description": "Symbol to get data for. (Stock) Multiple comma separated items allowed for provider(s): fmp." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_EtfEquityExposure" } } } }, "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": "EtfEquityExposure", "examples": [ { "scope": "api", "parameters": { "symbol": "MSFT", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "This function accepts multiple tickers.", "parameters": { "symbol": "MSFT,AAPL", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/fixedincome/rate/ameribor": { "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", "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": [ "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_AMERIBOR" } } } }, "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": "AMERIBOR", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "parameter": "30_day_ma", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/sonia": { "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", "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": [ "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SONIA" } } } }, "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": "SONIA", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "parameter": "total_nominal_value", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/iorb": { "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", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_IORB" } } } }, "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": "IORB", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/effr": { "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", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "federal_reserve", "fred" ], "type": "string", "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": [ "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_FEDFUNDS" } } } }, "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": "FEDFUNDS", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "parameter": "daily", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/effr_forecast": { "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", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "title": "Provider" } }, { "name": "long_run", "in": "query", "required": false, "schema": { "type": "boolean", "title": "fred", "description": "Flag to show long run projections (provider: fred)", "default": false }, "description": "Flag to show long run projections (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_PROJECTIONS" } } } }, "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": "PROJECTIONS", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "long_run": 1.0, "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/estr": { "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", "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": [ "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": "Period of ESTR rate. (provider: fred)", "default": "volume_weighted_trimmed_mean_rate" }, "description": "Period of ESTR rate. (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ESTR" } } } }, "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": "ESTR", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "parameter": "number_of_active_banks", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/rate/ecb": { "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", "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": "interest_rate_type", "in": "query", "required": false, "schema": { "enum": [ "deposit", "lending", "refinancing" ], "type": "string", "description": "The type of interest rate.", "default": "lending", "title": "Interest Rate Type" }, "description": "The type of interest rate." } ], "responses": { "200": { "description": "Successful Response", "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" } } } }, "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": "DiscountWindowPrimaryCreditRate", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "start_date": "2023-02-01", "end_date": "2023-05-01", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/spreads/tcm": { "get": { "tags": [ "fixedincome" ], "summary": "Tcm", "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.", "operationId": "fixedincome_spreads_tcm", "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": "maturity", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "3m", "2y" ], "type": "string" }, { "type": "null" } ], "description": "The maturity", "default": "3m", "title": "Maturity" }, "description": "The maturity" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_TreasuryConstantMaturity" } } } }, "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": "TreasuryConstantMaturity", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "maturity": "2y", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/spreads/tcm_effr": { "get": { "tags": [ "fixedincome" ], "summary": "Tcm Effr", "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.", "operationId": "fixedincome_spreads_tcm_effr", "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": "maturity", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "10y", "5y", "1y", "6m", "3m" ], "type": "string" }, { "type": "null" } ], "description": "The maturity", "default": "10y", "title": "Maturity" }, "description": "The maturity" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SelectedTreasuryConstantMaturity" } } } }, "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": "SelectedTreasuryConstantMaturity", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "maturity": "10y", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/spreads/treasury_effr": { "get": { "tags": [ "fixedincome" ], "summary": "Treasury Effr", "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.", "operationId": "fixedincome_spreads_treasury_effr", "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": "maturity", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "3m", "6m" ], "type": "string" }, { "type": "null" } ], "description": "The maturity", "default": "3m", "title": "Maturity" }, "description": "The maturity" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SelectedTreasuryBill" } } } }, "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": "SelectedTreasuryBill", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "maturity": "6m", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/government/yield_curve": { "get": { "tags": [ "fixedincome" ], "summary": "Yield Curve", "description": "Get yield curve data by country and date.", "operationId": "fixedincome_government_yield_curve", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "ecb", "econdb", "federal_reserve", "fmp", "fred" ], "type": "string", "title": "Provider" } }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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. By default is the current data. Multiple comma separated items allowed for provider(s): ecb, econdb, federal_reserve, fmp, fred." }, { "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": [ { "enum": [ "spot_rate", "instantaneous_forward", "par_yield" ], "type": "string" }, { "enum": [ "nominal", "real", "breakeven", "corporate_spot", "corporate_par" ], "type": "string" } ], "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": "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_YieldCurve" } } } }, "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": "YieldCurve", "examples": [ { "scope": "api", "parameters": { "provider": "federal_reserve" }, "provider": "federal_reserve" }, { "scope": "api", "parameters": { "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/us_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": "US Yield Curve. Get United States yield curve.", "operationId": "fixedincome_government_us_yield_curve", "deprecated": true, "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "title": "Provider" } }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "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. Defaults to the most recent FRED entry." }, { "name": "inflation_adjusted", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Get inflation adjusted rates.", "default": false, "title": "Inflation Adjusted" }, "description": "Get inflation adjusted rates." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$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" } } } }, "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": "EUYieldCurve", "examples": [ { "scope": "api", "parameters": { "provider": "ecb" }, "provider": "ecb" }, { "scope": "api", "parameters": { "yield_curve_type": "spot_rate", "provider": "ecb" }, "provider": "ecb" } ] } }, "/api/v1/fixedincome/government/treasury_rates": { "get": { "tags": [ "fixedincome" ], "summary": "Treasury Rates", "description": "Government Treasury Rates.", "operationId": "fixedincome_government_treasury_rates", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "federal_reserve", "fmp" ], "type": "string", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_TreasuryRates" } } } }, "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": "TreasuryRates", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/fixedincome/corporate/ice_bofa": { "get": { "tags": [ "fixedincome" ], "summary": "Ice Bofa", "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.", "operationId": "fixedincome_corporate_ice_bofa", "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": "index_type", "in": "query", "required": false, "schema": { "enum": [ "yield", "yield_to_worst", "total_return", "spread" ], "type": "string", "description": "The type of series.", "default": "yield", "title": "Index Type" }, "description": "The type of series." }, { "name": "category", "in": "query", "required": false, "schema": { "enum": [ "all", "duration", "eur", "usd" ], "type": "string", "title": "fred", "description": "The type of category. (provider: fred)", "default": "all" }, "description": "The type of category. (provider: fred)" }, { "name": "area", "in": "query", "required": false, "schema": { "enum": [ "asia", "emea", "eu", "ex_g10", "latin_america", "us" ], "type": "string", "title": "fred", "description": "The type of area. (provider: fred)", "default": "us" }, "description": "The type of area. (provider: fred)" }, { "name": "grade", "in": "query", "required": false, "schema": { "enum": [ "a", "aa", "aaa", "b", "bb", "bbb", "ccc", "crossover", "high_grade", "high_yield", "non_financial", "non_sovereign", "private_sector", "public_sector" ], "type": "string", "title": "fred", "description": "The type of grade. (provider: fred)", "default": "non_sovereign" }, "description": "The type of grade. (provider: fred)" }, { "name": "options", "in": "query", "required": false, "schema": { "type": "boolean", "title": "fred", "description": "Whether to include options in the results. (provider: fred)", "default": false }, "description": "Whether to include options in the results. (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_ICEBofA" } } } }, "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": "ICEBofA", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "index_type": "yield_to_worst", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/corporate/moody": { "get": { "tags": [ "fixedincome" ], "summary": "Moody", "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.", "operationId": "fixedincome_corporate_moody", "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": "index_type", "in": "query", "required": false, "schema": { "enum": [ "aaa", "baa" ], "type": "string", "description": "The type of series.", "default": "aaa", "title": "Index Type" }, "description": "The type of series." }, { "name": "spread", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "treasury", "fed_funds" ], "type": "string" }, { "type": "null" } ], "title": "fred", "description": "The type of spread. (provider: fred)" }, "description": "The type of spread. (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_MoodyCorporateBondIndex" } } } }, "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": "MoodyCorporateBondIndex", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "index_type": "baa", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/corporate/hqm": { "get": { "tags": [ "fixedincome" ], "summary": "Hqm", "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.", "operationId": "fixedincome_corporate_hqm", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fred" ], "const": "fred", "type": "string", "default": "fred", "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": "yield_curve", "in": "query", "required": false, "schema": { "enum": [ "spot", "par" ], "type": "string", "description": "The yield curve type.", "default": "spot", "title": "Yield Curve" }, "description": "The yield curve type." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_HighQualityMarketCorporateBond" } } } }, "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": "HighQualityMarketCorporateBond", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "yield_curve": "par", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/corporate/spot_rates": { "get": { "tags": [ "fixedincome" ], "summary": "Spot Rates", "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.", "operationId": "fixedincome_corporate_spot_rates", "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": "maturity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred.", "fred": { "multiple_items_allowed": true }, "default": 10.0, "title": "Maturity" }, "description": "Maturities in years. Multiple comma separated items allowed for provider(s): fred." }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred.", "choices": [ "par_yield", "spot_rate" ], "fred": { "multiple_items_allowed": true }, "default": "spot_rate", "title": "Category" }, "description": "Rate category. Options: spot_rate, par_yield. Multiple comma separated items allowed for provider(s): fred." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SpotRate" } } } }, "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": "SpotRate", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "maturity": "10,20,30,50", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/corporate/commercial_paper": { "get": { "tags": [ "fixedincome" ], "summary": "Commercial Paper", "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.", "operationId": "fixedincome_corporate_commercial_paper", "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": "maturity", "in": "query", "required": false, "schema": { "enum": [ "overnight", "7d", "15d", "30d", "60d", "90d" ], "type": "string", "description": "The maturity.", "default": "30d", "title": "Maturity" }, "description": "The maturity." }, { "name": "category", "in": "query", "required": false, "schema": { "enum": [ "asset_backed", "financial", "nonfinancial" ], "type": "string", "description": "The category.", "default": "financial", "title": "Category" }, "description": "The category." }, { "name": "grade", "in": "query", "required": false, "schema": { "enum": [ "aa", "a2_p2" ], "type": "string", "description": "The grade.", "default": "aa", "title": "Grade" }, "description": "The grade." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CommercialPaper" } } } }, "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": "CommercialPaper", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "maturity": "15d", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/fixedincome/sofr": { "get": { "tags": [ "fixedincome" ], "summary": "Sofr", "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.", "operationId": "fixedincome_sofr", "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": "period", "in": "query", "required": false, "schema": { "enum": [ "overnight", "30_day", "90_day", "180_day", "index" ], "type": "string", "title": "fred", "description": "Period of SOFR rate. (provider: fred)", "default": "overnight" }, "description": "Period of SOFR rate. (provider: fred)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SOFR" } } } }, "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": "SOFR", "examples": [ { "scope": "api", "parameters": { "provider": "fred" }, "provider": "fred" }, { "scope": "api", "parameters": { "period": "overnight", "provider": "fred" }, "provider": "fred" } ] } }, "/api/v1/index/price/historical": { "get": { "tags": [ "index" ], "summary": "Historical", "description": "Historical Index Levels.", "operationId": "index_price_historical", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." }, { "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": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Time interval of the data to return.", "default": "1d", "title": "Interval" }, "description": "Time interval of the data to return." }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "intrinio,polygon", "description": "The number of data entries to return. (provider: intrinio, polygon)", "default": 10000 }, "description": "The number of data entries to return. (provider: intrinio, polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_IndexHistorical" } } } }, "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": "IndexHistorical", "examples": [ { "scope": "api", "parameters": { "symbol": "^GSPC", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Not all providers have the same symbols.", "parameters": { "symbol": "SPX", "provider": "intrinio" }, "provider": "intrinio" } ] } }, "/api/v1/index/market": { "get": { "tags": [ "index" ], "summary": "This endpoint is deprecated; use `/index/price/historical` instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3.", "description": "Get Historical Market Indices.", "operationId": "index_market", "deprecated": true, "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "fmp", "intrinio", "polygon" ], "type": "string", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, 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." }, { "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": "interval", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Time interval of the data to return.", "default": "1d", "title": "Interval" }, "description": "Time interval of the data to return." }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "intrinio,polygon", "description": "The number of data entries to return. (provider: intrinio, polygon)", "default": 10000 }, "description": "The number of data entries to return. (provider: intrinio, polygon)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "polygon", "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)", "default": "asc" }, "description": "Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. (provider: polygon)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_MarketIndices" } } } }, "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": "MarketIndices", "examples": [ { "scope": "api", "parameters": { "symbol": "^IBEX", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/index/constituents": { "get": { "tags": [ "index" ], "summary": "Constituents", "description": "Get Index Constituents.", "operationId": "index_constituents", "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_IndexConstituents" } } } }, "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": "IndexConstituents", "examples": [ { "scope": "api", "parameters": { "symbol": "dowjones", "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/index/available": { "get": { "tags": [ "index" ], "summary": "Available", "description": "All indices available from a given provider.", "operationId": "index_available", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "default": "fmp", "title": "Provider" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_AvailableIndices" } } } }, "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": "AvailableIndices", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" } ] } }, "/api/v1/news/world": { "get": { "tags": [ "news" ], "summary": "World", "description": "World News. Global news data.", "operationId": "news_world", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "benzinga", "fmp", "intrinio" ], "type": "string", "title": "Provider" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "The number of data entries to return. The number of articles to return.", "default": 2500, "title": "Limit" }, "description": "The number of data entries to return. The number of articles to return." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Start date of the data, in YYYY-MM-DD format.", "title": "Start Date" }, "description": "Start date of the data, in YYYY-MM-DD format." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "End date of the data, in YYYY-MM-DD format.", "title": "End Date" }, "description": "End date of the data, in YYYY-MM-DD format." }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "benzinga", "description": "A specific date to get data for. (provider: benzinga)" }, "description": "A specific date to get data for. (provider: benzinga)" }, { "name": "display", "in": "query", "required": false, "schema": { "enum": [ "headline", "abstract", "full" ], "type": "string", "title": "benzinga", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", "default": "full" }, "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)" }, { "name": "updated_since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Number of seconds since the news was updated. (provider: benzinga)" }, "description": "Number of seconds since the news was updated. (provider: benzinga)" }, { "name": "published_since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Number of seconds since the news was published. (provider: benzinga)" }, "description": "Number of seconds since the news was published. (provider: benzinga)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "id", "created", "updated" ], "type": "string", "title": "benzinga", "description": "Key to sort the news by. (provider: benzinga)", "default": "created" }, "description": "Key to sort the news by. (provider: benzinga)" }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "title": "benzinga", "description": "Order to sort the news by. (provider: benzinga)", "default": "desc" }, "description": "Order to sort the news by. (provider: benzinga)" }, { "name": "isin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "The ISIN of the news to retrieve. (provider: benzinga)" }, "description": "The ISIN of the news to retrieve. (provider: benzinga)" }, { "name": "cusip", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "The CUSIP of the news to retrieve. (provider: benzinga)" }, "description": "The CUSIP of the news to retrieve. (provider: benzinga)" }, { "name": "channels", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Channels of the news to retrieve. (provider: benzinga)" }, "description": "Channels of the news to retrieve. (provider: benzinga)" }, { "name": "topics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Topics of the news to retrieve. (provider: benzinga)" }, "description": "Topics of the news to retrieve. (provider: benzinga)" }, { "name": "authors", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Authors of the news to retrieve. (provider: benzinga)" }, "description": "Authors of the news to retrieve. (provider: benzinga)" }, { "name": "content_types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_WorldNews" } } } }, "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": "WorldNews", "examples": [ { "scope": "api", "parameters": { "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "parameters": { "limit": 100, "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Get news on the specified dates.", "parameters": { "start_date": "2024-02-01", "end_date": "2024-02-07", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Display the headlines of the news.", "parameters": { "display": "headline", "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "description": "Get news by topics.", "parameters": { "topics": "finance", "provider": "benzinga" }, "provider": "benzinga" } ] } }, "/api/v1/news/company": { "get": { "tags": [ "news" ], "summary": "Company", "description": "Company News. Get news for one or more companies.", "operationId": "news_company", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "enum": [ "benzinga", "fmp", "intrinio", "polygon" ], "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, 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." }, { "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", "minimum": 0 }, { "type": "null" } ], "description": "The number of data entries to return.", "default": 2500, "title": "Limit" }, "description": "The number of data entries to return." }, { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "benzinga", "description": "A specific date to get data for. (provider: benzinga)" }, "description": "A specific date to get data for. (provider: benzinga)" }, { "name": "display", "in": "query", "required": false, "schema": { "enum": [ "headline", "abstract", "full" ], "type": "string", "title": "benzinga", "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)", "default": "full" }, "description": "Specify headline only (headline), headline + teaser (abstract), or headline + full body (full). (provider: benzinga)" }, { "name": "updated_since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Number of seconds since the news was updated. (provider: benzinga)" }, "description": "Number of seconds since the news was updated. (provider: benzinga)" }, { "name": "published_since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "benzinga", "description": "Number of seconds since the news was published. (provider: benzinga)" }, "description": "Number of seconds since the news was published. (provider: benzinga)" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "id", "created", "updated" ], "type": "string", "title": "benzinga", "description": "Key to sort the news by. (provider: benzinga)", "default": "created" }, "description": "Key to sort the news by. (provider: benzinga)" }, { "name": "order", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "asc", "desc" ], "type": "string" }, { "type": "null" } ], "title": "benzinga,polygon", "description": "Order to sort the news by. (provider: benzinga);\n Sort order of the articles. (provider: polygon)", "default": "desc" }, "description": "Order to sort the news by. (provider: benzinga);\n Sort order of the articles. (provider: polygon)" }, { "name": "isin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "The company's ISIN. (provider: benzinga)" }, "description": "The company's ISIN. (provider: benzinga)" }, { "name": "cusip", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "The company's CUSIP. (provider: benzinga)" }, "description": "The company's CUSIP. (provider: benzinga)" }, { "name": "channels", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Channels of the news to retrieve. (provider: benzinga)" }, "description": "Channels of the news to retrieve. (provider: benzinga)" }, { "name": "topics", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Topics of the news to retrieve. (provider: benzinga)" }, "description": "Topics of the news to retrieve. (provider: benzinga)" }, { "name": "authors", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Authors of the news to retrieve. (provider: benzinga)" }, "description": "Authors of the news to retrieve. (provider: benzinga)" }, { "name": "content_types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "benzinga", "description": "Content types of the news to retrieve. (provider: benzinga)" }, "description": "Content types of the news to retrieve. (provider: benzinga)" }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "fmp", "description": "Page number of the results. Use in combination with limit. (provider: fmp)", "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": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_CompanyNews" } } } }, "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": "CompanyNews", "examples": [ { "scope": "api", "parameters": { "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "parameters": { "limit": 100, "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "description": "Get news on the specified dates.", "parameters": { "symbol": "AAPL", "start_date": "2024-02-01", "end_date": "2024-02-07", "provider": "intrinio" }, "provider": "intrinio" }, { "scope": "api", "description": "Display the headlines of the news.", "parameters": { "symbol": "AAPL", "display": "headline", "provider": "benzinga" }, "provider": "benzinga" }, { "scope": "api", "description": "Get news for multiple symbols.", "parameters": { "symbol": "aapl,tsla", "provider": "fmp" }, "provider": "fmp" }, { "scope": "api", "description": "Get news company's ISIN.", "parameters": { "symbol": "NVDA", "isin": "US0378331005", "provider": "benzinga" }, "provider": "benzinga" } ] } }, "/api/v1/pro/watchlist": { "get": { "tags": [ "pro" ], "summary": "Watchlist", "description": "Watchlist endpoint for pro users.", "operationId": "pro_watchlist", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "pro" ], "const": "pro", "type": "string", "default": "pro", "title": "Provider" } }, { "name": "data_provider", "in": "query", "required": false, "schema": { "enum": [ "fmp" ], "const": "fmp", "type": "string", "title": "pro", "description": "Provider name. (provider: pro)", "default": "fmp" }, "description": "Provider name. (provider: pro)" }, { "name": "symbol", "in": "query", "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)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_Watchlist" } } } }, "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": "Watchlist", "examples": [] } }, "/api/v1/pro/key_metrics": { "get": { "tags": [ "pro" ], "summary": "Key Metrics", "description": "Key metrics endpoint for pro users.", "operationId": "pro_key_metrics", "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": { "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": "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "pro", "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)", "pro": { "multiple_items_allowed": true } }, "description": "Symbol to get data for. Multiple comma separated items allowed. (provider: pro)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_GroupedComparisons" } } } }, "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": "GroupedComparisons", "examples": [] } }, "/api/v1/pro/grouped_financials": { "get": { "tags": [ "pro" ], "summary": "Grouped Financials", "description": "Grouped financials endpoint for pro users.", "operationId": "pro_grouped_financials", "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": { "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", "title": "pro", "description": "None", "default": "annual" }, "description": "None" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "pro", "description": "None", "default": 5 }, "description": "None" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_GroupedFinancials" } } } }, "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": "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": [ { "OAuth2PasswordBearer": [] } ], "model": "", "examples": [] } }, "/api/v1/regulators/sec/cik_map": { "get": { "tags": [ "regulators" ], "summary": "Cik Map", "description": "Map a ticker symbol to a CIK number.", "operationId": "regulators_sec_cik_map", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "description": "Symbol to get data for.", "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": { "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", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "description": "Search query.", "default": "", "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.", "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_InstitutionsSearch" } } } }, "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": "InstitutionsSearch", "examples": [ { "scope": "api", "parameters": { "provider": "sec" }, "provider": "sec" }, { "scope": "api", "parameters": { "query": "blackstone real estate", "provider": "sec" }, "provider": "sec" } ] } }, "/api/v1/regulators/sec/schema_files": { "get": { "tags": [ "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": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "description": "Search query.", "default": "", "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.", "default": true, "title": "Use Cache" }, "description": "Whether or not to use cache." }, { "name": "url", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "sec", "description": "Enter an optional URL path to fetch the next level. (provider: sec)" }, "description": "Enter an optional URL path to fetch the next level. (provider: sec)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OBBject_SchemaFiles" } } } }, "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": "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']" ] } ] } }, "/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": { "description": "Successful Response", "content": { "application/json": { "schema": { "$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" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "model": "SymbolMap", "examples": [ { "scope": "api", "parameters": { "query": "0000789019", "provider": "sec" }, "provider": "sec" } ] } }, "/api/v1/regulators/sec/rss_litigation": { "get": { "tags": [ "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": [] } ], "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "sec" ], "const": "sec", "type": "string", "default": "sec", "title": "Provider" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "description": "Search query.", "default": "", "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.", "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", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list.", "title": "Type" }, "description": "Filter by type(s). (stock, etf, index, indices, all) can be a comma separated list." }, { "name": "ignore_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma separated list of types to ignore. (stock, etf, index, indices)", "title": "Ignore Type" }, "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": "string" }, { "type": "null" } ], "description": "Search fred indices.", "title": "Q" }, "description": "Search fred indices." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FredIndex" }, "title": "Response Query Fred Indices" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/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" } } } }, "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" }, { "type": "null" } ], "title": "Firm Name", "description": "Firm name of the analyst." }, "name_first": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name First", "description": "Analyst first name." }, "name_last": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name Last", "description": "Analyst last name." }, "name_full": { "type": "string", "title": "Name Full", "description": "Analyst full name." }, "analyst_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Analyst Id", "description": "ID of the analyst." }, "firm_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firm Id", "description": "ID of the analyst firm." }, "smart_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Smart Score", "description": "A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate" }, "overall_success_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overall Success Rate", "description": "The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "overall_avg_return_percentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Overall Avg Return Percentile", "description": "The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts' overall average returns per rating.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "total_ratings_percentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Ratings Percentile", "description": "The percentile (normalized) of this analyst's total number of ratings in comparison to the total number of ratings published by all other analysts", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "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": "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 of the filing." }, "accepted_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted Date", "description": "The date the filing was accepted." }, "reported_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reported Currency", "description": "The currency in which the cash flow statement was reported." }, "net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income", "description": "Net income." }, "depreciation_and_amortization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation And Amortization", "description": "Depreciation and amortization." }, "deferred_income_tax": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Deferred Income Tax", "description": "Deferred income tax." }, "stock_based_compensation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stock Based Compensation", "description": "Stock-based compensation." }, "change_in_working_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Working Capital", "description": "Change in working capital." }, "change_in_account_receivables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Account Receivables", "description": "Change in account receivables." }, "change_in_inventory": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Inventory", "description": "Change in inventory." }, "change_in_account_payable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Account Payable", "description": "Change in account payable." }, "change_in_other_working_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Other Working Capital", "description": "Change in other working capital." }, "change_in_other_non_cash_items": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change In Other Non Cash Items", "description": "Change in other non-cash items." }, "net_cash_from_operating_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Operating Activities", "description": "Net cash from operating activities." }, "purchase_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Of Property Plant And Equipment", "description": "Purchase of property, plant and equipment." }, "acquisitions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Acquisitions", "description": "Acquisitions." }, "purchase_of_investment_securities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Of Investment Securities", "description": "Purchase of investment securities." }, "sale_and_maturity_of_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sale And Maturity Of Investments", "description": "Sale and maturity of investments." }, "other_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Investing Activities", "description": "Other investing activities." }, "net_cash_from_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Investing Activities", "description": "Net cash from investing activities." }, "repayment_of_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repayment Of Debt", "description": "Repayment of debt." }, "issuance_of_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Issuance Of Common Equity", "description": "Issuance of common equity." }, "repurchase_of_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repurchase Of Common Equity", "description": "Repurchase of common equity." }, "payment_of_dividends": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payment Of Dividends", "description": "Payment of dividends." }, "other_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Financing Activities", "description": "Other financing activities." }, "net_cash_from_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Financing Activities", "description": "Net cash from financing activities." }, "effect_of_exchange_rate_changes_on_cash": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Effect Of Exchange Rate Changes On Cash", "description": "Effect of exchange rate changes on cash." }, "net_change_in_cash_and_equivalents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Change In Cash And Equivalents", "description": "Net change in cash and equivalents." }, "cash_at_beginning_of_period": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash At Beginning Of Period", "description": "Cash at beginning of period." }, "cash_at_end_of_period": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash At End Of Period", "description": "Cash at end of period." }, "operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow", "description": "Operating cash flow." }, "capital_expenditure": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Expenditure", "description": "Capital expenditure." }, "free_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow" }, "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": "FMPCashFlowStatementData", "description": "FMP Cash Flow Statement Data." }, "FMPCashFlowStatementGrowthData": { "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": "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": "FMPCashFlowStatementGrowthData", "description": "FMP Cash Flow Statement Growth Data." }, "FMPCompanyFilingsData": { "properties": { "filing_date": { "type": "string", "format": "date", "title": "Filing Date", "description": "The date of the filing." }, "accepted_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted Date", "description": "Accepted date of the filing." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type", "description": "Type of filing." }, "filing_url": { "anyOf": [ { "type": "string" }, { "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": "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" }, { "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": "Images associated with the article." }, "url": { "type": "string", "title": "Url", "description": "URL to the article." }, "symbols": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbols", "description": "Symbols associated with the article." }, "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" }, { "type": "null" } ], "title": "Price", "description": "Price of the company." }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta", "description": "Beta of the company." }, "vol_avg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Vol Avg", "description": "Volume average of the company." }, "mkt_cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mkt Cap", "description": "Market capitalization of the company." }, "last_div": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Div", "description": "Last dividend of the company." }, "range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Range", "description": "Range of the company." }, "changes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Changes", "description": "Changes of the company." }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name", "description": "Company name of the company." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency of the company." }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin", "description": "ISIN of the company." }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip", "description": "CUSIP of the company." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "Exchange of the company." }, "exchange_short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange Short Name", "description": "Exchange short name of the company." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "Industry of the company." }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "Website of the company." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the company." }, "ceo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ceo", "description": "CEO of the company." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "Sector of the company." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country of the company." }, "full_time_employees": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Time Employees", "description": "Full time employees of the company." }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone", "description": "Phone of the company." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "Address of the company." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the company." }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State of the company." }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip", "description": "Zip of the company." }, "dcf_diff": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dcf Diff", "description": "Discounted cash flow difference of the company." }, "dcf": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dcf", "description": "Discounted cash flow of the company." }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image", "description": "Image of the company." }, "ipo_date": { "anyOf": [ { "type": "string", "format": "date" }, { "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": "FMPCompanyOverviewData", "description": "FMP Company Overview Data." }, "FMPCryptoHistoricalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "exclusiveMinimum": 0.0, "title": "Open", "description": "The open price." }, "high": { "type": "number", "exclusiveMinimum": 0.0, "title": "High", "description": "The high price." }, "low": { "type": "number", "exclusiveMinimum": 0.0, "title": "Low", "description": "The low price." }, "close": { "type": "number", "exclusiveMinimum": 0.0, "title": "Close", "description": "The close price." }, "volume": { "type": "number", "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "adj_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Close", "description": "The adjusted close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in the price from the previous close." }, "changeOverTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the crypto." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "The currency the crypto trades for." }, "stockExchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stockexchange", "description": "The exchange code the crypto trades on." }, "exchangeShortName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "exclusiveMinimum": 0.0, "title": "Open", "description": "The open price." }, "high": { "type": "number", "exclusiveMinimum": 0.0, "title": "High", "description": "The high price." }, "low": { "type": "number", "exclusiveMinimum": 0.0, "title": "Low", "description": "The low price." }, "close": { "type": "number", "exclusiveMinimum": 0.0, "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "adj_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Close", "description": "The adjusted close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in the price from the previous close." }, "changeOverTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the currency pair." }, "currency": { "type": "string", "title": "Currency", "description": "Base currency of the currency pair." }, "stock_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stock Exchange", "description": "Stock exchange of the currency pair." }, "exchange_short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "counter_currency": { "type": "string", "title": "Counter Currency", "description": "The counter, or foreign, currency." }, "last_rate": { "type": "number", "title": "Last Rate", "description": "The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in the price from the previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "The change in the price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ma_50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ma 50", "description": "The 50-day moving average." }, "ma_200": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ma 200", "description": "The 200-day moving average." }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The 52-week high." }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The 52-week low." }, "last_rate_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Rate Timestamp", "description": "The timestamp of the last rate." } }, "additionalProperties": true, "type": "object", "required": [ "base_currency", "counter_currency", "last_rate" ], "title": "FMPCurrencySnapshotsData", "description": "FMP Currency Snapshots Data." }, "FMPDiscoveryFilingsData": { "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." } }, "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": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country of event." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category of event." }, "event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event", "description": "Event name." }, "importance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Importance", "description": "The importance level for the event." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "Source of the data." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency of the data." }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit", "description": "Unit of the data." }, "consensus": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Consensus", "description": "Average forecast among a representative group of economists." }, "previous": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Previous", "description": "Value for the previous period after the revision (if revision is applicable)." }, "revised": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Revised", "description": "Revised previous value, if applicable." }, "actual": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Actual", "description": "Latest released value." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Value change since previous." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "Percentage change since previous." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Updated", "description": "Last updated timestamp." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "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": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "title": "Open", "description": "The open price." }, "high": { "type": "number", "title": "High", "description": "The high price." }, "low": { "type": "number", "title": "Low", "description": "The low price." }, "close": { "type": "number", "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol of the equity." }, "adj_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Close", "description": "The adjusted close price." }, "unadjusted_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unadjusted Volume", "description": "Unadjusted volume of the symbol." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in the price from the previous close." }, "changeOverTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lei", "description": "Legal Entity Identifier assigned to the company." }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Official legal name of the company." }, "stock_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stock Exchange", "description": "Stock exchange where the company is traded." }, "sic": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sic", "description": "Standard Industrial Classification code for the company." }, "short_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Description", "description": "Short description of the company." }, "long_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Description", "description": "Long description of the company." }, "ceo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ceo", "description": "Chief Executive Officer of the company." }, "company_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Url", "description": "URL of the company's website." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Address of the company's headquarters." }, "mailing_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing Address", "description": "Mailing address of the company." }, "business_phone_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Phone No", "description": "Phone number of the company's headquarters." }, "hq_address_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address 1", "description": "Address of the company's headquarters." }, "hq_address_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address 2", "description": "Address of the company's headquarters." }, "hq_address_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address City", "description": "City of the company's headquarters." }, "hq_address_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address Postal Code", "description": "Zip code of the company's headquarters." }, "hq_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq State", "description": "State of the company's headquarters." }, "hq_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Country", "description": "Country of the company's headquarters." }, "inc_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inc State", "description": "State in which the company is incorporated." }, "inc_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inc Country", "description": "Country in which the company is incorporated." }, "employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Employees", "description": "Number of employees working for the company." }, "entity_legal_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Legal Form", "description": "Legal form of the company." }, "entity_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Status", "description": "Status of the company." }, "latest_filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Latest Filing Date", "description": "Date of the company's latest filing." }, "irs_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Irs Number", "description": "IRS number assigned to the company." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "Sector in which the company operates." }, "industry_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry Category", "description": "Category of industry in which the company operates." }, "industry_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry Group", "description": "Group of industry in which the company operates." }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template", "description": "Template used to standardize the company's financial statements." }, "standardized_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Standardized Active", "description": "Whether the company is active or not." }, "first_fundamental_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "First Fundamental Date", "description": "Date of the company's first fundamental." }, "last_fundamental_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Last Fundamental Date", "description": "Date of the company's last fundamental." }, "first_stock_price_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "First Stock Price Date", "description": "Date of the company's first stock price." }, "last_stock_price_date": { "anyOf": [ { "type": "string", "format": "date" }, { "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." }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image", "description": "Image of the company." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency in which the stock is traded." }, "mktCap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mktcap", "description": "Market capitalization of the company." }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The last traded price." }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The one-year high of the price." }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The one-year low of the price." }, "volAvg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volavg", "description": "Average daily trading volume." }, "lastDiv": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lastdiv", "description": "The annualized dividend payment based on the most recent regular dividend payment." }, "beta": { "anyOf": [ { "type": "number" }, { "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": "FMPEquityProfileData", "description": "FMP Equity Profile Data." }, "FMPEquityQuoteData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Type", "description": "Type of asset - i.e, stock, ETF, etc." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the company or asset." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The name or symbol of the venue where the data is from." }, "bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid", "description": "Price of the top bid order." }, "bid_size": { "anyOf": [ { "type": "integer" }, { "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." }, "bid_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Exchange", "description": "The specific trading venue where the purchase order was placed." }, "ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask", "description": "Price of the top ask order." }, "ask_size": { "anyOf": [ { "type": "integer" }, { "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." }, "ask_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ask Exchange", "description": "The specific trading venue where the sale order was placed." }, "quote_conditions": { "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." }, "quote_indicators": { "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." }, "sales_conditions": { "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": "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": { "anyOf": [ { "type": "string" }, { "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." }, "trf_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Trf Timestamp", "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." }, "sip_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sip Timestamp", "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." }, "last_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Price", "description": "Price of the last trade." }, "last_tick": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Tick", "description": "Whether the last sale was an up or down tick." }, "last_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Size", "description": "Size of the last trade." }, "last_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Timestamp", "description": "Date and Time when the last price was recorded." }, "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": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "exchange_volume": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Exchange Volume", "description": "Volume of shares exchanged during the trading day on the specific exchange." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in price from previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "Change in price as a normalized percentage.", "x-frontendmultiply": 100 }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The one year high (52W High)." }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The one year low (52W Low)." }, "price_avg_50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Avg 50", "description": "50 day moving average price." }, "price_avg_200": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Avg 200", "description": "200 day moving average price." }, "avg_volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Avg Volume", "description": "Average volume over the last 10 trading days." }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "Market cap of the company." }, "shares_outstanding": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Outstanding", "description": "Number of shares outstanding." }, "eps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps", "description": "Earnings per share." }, "pe": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe", "description": "Price earnings ratio." }, "earnings_announcement": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Earnings Announcement", "description": "Upcoming earnings announcement date." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "FMPEquityQuoteData", "description": "FMP Equity Quote Data." }, "FMPEquityScreenerData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "name": { "type": "string", "title": "Name", "description": "Name of the company." }, "marketCap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Marketcap", "description": "The market cap of ticker." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "The sector the ticker belongs to." }, "industry": { "anyOf": [ { "type": "string" }, { "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." }, "lastAnnualDividend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lastannualdividend", "description": "The last annual amount dividend paid." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The current trading volume." }, "exchangeShortName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchangeshortname", "description": "The exchange code the asset trades on." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "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." }, "isEtf": { "anyOf": [ { "type": "boolean", "enum": [ true, false ] }, { "type": "null" } ], "title": "Isetf", "description": "Whether the ticker is an ETF." }, "isActivelyTrading": { "anyOf": [ { "type": "boolean", "enum": [ true, false ] }, { "type": "null" } ], "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." }, "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": "null" } ], "title": "Net Income Per Share Ttm", "description": "Net income per share calculated as trailing twelve months." }, "operating_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share Ttm", "description": "Operating cash flow per share calculated as trailing twelve months." }, "free_cash_flow_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share Ttm", "description": "Free cash flow per share calculated as trailing twelve months." }, "cash_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share Ttm", "description": "Cash per share calculated as trailing twelve months." }, "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." }, "tangible_book_value_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Book Value Per Share Ttm", "description": "Tangible book value per share calculated as trailing twelve months." }, "shareholders_equity_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shareholders Equity Per Share Ttm", "description": "Shareholders equity per share calculated as trailing twelve months." }, "interest_debt_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Debt Per Share Ttm", "description": "Interest debt per share calculated as trailing twelve months." }, "market_cap_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap Ttm", "description": "Market capitalization calculated as trailing twelve months." }, "enterprise_value_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Ttm", "description": "Enterprise value calculated as trailing twelve months." }, "pe_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio Ttm", "description": "Price-to-earnings ratio (P/E ratio) calculated as trailing twelve months." }, "price_to_sales_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales Ratio Ttm", "description": "Price-to-sales ratio calculated as trailing twelve months." }, "pocf_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pocf Ratio Ttm", "description": "Price-to-operating cash flow ratio calculated as trailing twelve months." }, "pfcf_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pfcf Ratio Ttm", "description": "Price-to-free cash flow ratio calculated as trailing twelve months." }, "pb_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pb Ratio Ttm", "description": "Price-to-book ratio calculated as trailing twelve months." }, "ptb_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ptb Ratio Ttm", "description": "Price-to-tangible book ratio calculated as trailing twelve months." }, "ev_to_sales_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Sales Ttm", "description": "Enterprise value-to-sales ratio calculated as trailing twelve months." }, "enterprise_value_over_ebitda_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Over Ebitda Ttm", "description": "Enterprise value-to-EBITDA ratio calculated as trailing twelve months." }, "ev_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Operating Cash Flow Ttm", "description": "Enterprise value-to-operating cash flow ratio calculated as trailing twelve months." }, "ev_to_free_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Free Cash Flow Ttm", "description": "Enterprise value-to-free cash flow ratio calculated as trailing twelve months." }, "earnings_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Yield Ttm", "description": "Earnings yield calculated as trailing twelve months." }, "free_cash_flow_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Yield Ttm", "description": "Free cash flow yield calculated as trailing twelve months." }, "debt_to_equity_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Equity Ttm", "description": "Debt-to-equity ratio calculated as trailing twelve months." }, "debt_to_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Assets Ttm", "description": "Debt-to-assets ratio calculated as trailing twelve months." }, "net_debt_to_ebitda_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Debt To Ebitda Ttm", "description": "Net debt-to-EBITDA ratio calculated as trailing twelve months." }, "current_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio Ttm", "description": "Current ratio calculated as trailing twelve months." }, "interest_coverage_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage Ttm", "description": "Interest coverage calculated as trailing twelve months." }, "income_quality_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Quality Ttm", "description": "Income quality calculated as trailing twelve months." }, "dividend_yield_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Yield Ttm", "description": "Dividend yield calculated as trailing twelve months." }, "dividend_yield_percentage_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Yield Percentage Ttm", "description": "Dividend yield percentage calculated as trailing twelve months." }, "dividend_to_market_cap_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend To Market Cap Ttm", "description": "Dividend to market capitalization ratio calculated as trailing twelve months." }, "dividend_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Per Share Ttm", "description": "Dividend per share calculated as trailing twelve months." }, "payout_ratio_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payout Ratio Ttm", "description": "Payout ratio calculated as trailing twelve months." }, "sales_general_and_administrative_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sales General And Administrative To Revenue Ttm", "description": "Sales general and administrative expenses-to-revenue ratio calculated as trailing twelve months." }, "research_and_development_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development To Revenue Ttm", "description": "Research and development expenses-to-revenue ratio calculated as trailing twelve months." }, "intangibles_to_total_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Intangibles To Total Assets Ttm", "description": "Intangibles-to-total assets ratio calculated as trailing twelve months." }, "capex_to_operating_cash_flow_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capex To Operating Cash Flow Ttm", "description": "Capital expenditures-to-operating cash flow ratio calculated as trailing twelve months." }, "capex_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capex To Revenue Ttm", "description": "Capital expenditures-to-revenue ratio calculated as trailing twelve months." }, "capex_to_depreciation_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capex To Depreciation Ttm", "description": "Capital expenditures-to-depreciation ratio calculated as trailing twelve months." }, "stock_based_compensation_to_revenue_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stock Based Compensation To Revenue Ttm", "description": "Stock-based compensation-to-revenue ratio calculated as trailing twelve months." }, "graham_number_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Number Ttm", "description": "Graham number calculated as trailing twelve months." }, "roic_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Roic Ttm", "description": "Return on invested capital calculated as trailing twelve months." }, "return_on_tangible_assets_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Tangible Assets Ttm", "description": "Return on tangible assets calculated as trailing twelve months." }, "graham_net_net_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Net Net Ttm", "description": "Graham net-net working capital calculated as trailing twelve months." }, "working_capital_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Working Capital Ttm", "description": "Working capital calculated as trailing twelve months." }, "tangible_asset_value_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Asset Value Ttm", "description": "Tangible asset value calculated as trailing twelve months." }, "net_current_asset_value_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Current Asset Value Ttm", "description": "Net current asset value calculated as trailing twelve months." }, "invested_capital_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Invested Capital Ttm", "description": "Invested capital calculated as trailing twelve months." }, "average_receivables_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Receivables Ttm", "description": "Average receivables calculated as trailing twelve months." }, "average_payables_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Payables Ttm", "description": "Average payables calculated as trailing twelve months." }, "average_inventory_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Inventory Ttm", "description": "Average inventory calculated as trailing twelve months." }, "days_sales_outstanding_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Sales Outstanding Ttm", "description": "Days sales outstanding calculated as trailing twelve months." }, "days_payables_outstanding_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Payables Outstanding Ttm", "description": "Days payables outstanding calculated as trailing twelve months." }, "days_of_inventory_on_hand_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Inventory On Hand Ttm", "description": "Days of inventory on hand calculated as trailing twelve months." }, "receivables_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover Ttm", "description": "Receivables turnover calculated as trailing twelve months." }, "payables_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover Ttm", "description": "Payables turnover calculated as trailing twelve months." }, "inventory_turnover_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover Ttm", "description": "Inventory turnover calculated as trailing twelve months." }, "roe_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Roe Ttm", "description": "Return on equity calculated as trailing twelve months." }, "capex_per_share_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capex Per Share Ttm", "description": "Capital expenditures per share calculated as trailing twelve months." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "FMPEquityValuationMultiplesData", "description": "FMP Equity Valuation Multiples Data." }, "FMPEtfCountriesData": { "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": "FMPEtfCountriesData", "description": "FMP ETF Countries Data." }, "FMPEtfEquityExposureData": { "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." }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares", "description": "The number of shares held in the ETF." }, "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": [ "equity_symbol", "etf_symbol" ], "title": "FMPEtfEquityExposureData", "description": "FMP ETF Equity Exposure Data." }, "FMPEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data. (ETF)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the ETF holding." }, "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" }, { "type": "null" } ], "title": "Balance", "description": "The balance of the holding, in shares or units." }, "units": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Units", "description": "The type of units." }, "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" }, { "type": "null" } ], "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)" }, "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." }, "etfCompany": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Etfcompany", "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." }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the ETF." }, "marketCap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Marketcap", "description": "The market cap of the ETF." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "The sector of the ETF." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "The industry of the ETF." }, "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 of the ETF." }, "lastAnnualDividend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Lastannualdividend", "description": "The last annual dividend paid." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume", "description": "The current trading volume of the ETF." }, "exchangeShortName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchangeshortname", "description": "The exchange code the ETF trades on." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The full name of the exchange the ETF trades on." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The country the ETF is registered in." }, "isActivelyTrading": { "anyOf": [ { "type": "boolean", "enum": [ true, false ] }, { "type": "null" } ], "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." }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name", "description": "The name of the company." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "The industry of the company." }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year", "description": "Year of the compensation." }, "name_and_position": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name And Position", "description": "Name and position." }, "salary": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Salary", "description": "Salary." }, "bonus": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Bonus", "description": "Bonus payments." }, "stock_award": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Stock Award", "description": "Stock awards." }, "incentive_plan_compensation": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Incentive Plan Compensation", "description": "Incentive plan compensation." }, "all_other_compensation": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "All Other Compensation", "description": "All other compensation." }, "total": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Total", "description": "Total compensation." }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date", "description": "Date of the filing." }, "accepted_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted Date", "description": "Date the filing was accepted." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "URL to the filing data." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "FMPExecutiveCompensationData", "description": "FMP Executive Compensation Data." }, "FMPFinancialRatiosData": { "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." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Fiscal year." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "current_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio", "description": "Current ratio." }, "quick_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quick Ratio", "description": "Quick ratio." }, "cash_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Ratio", "description": "Cash ratio." }, "days_of_sales_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Sales Outstanding", "description": "Days of sales outstanding." }, "days_of_inventory_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Inventory Outstanding", "description": "Days of inventory outstanding." }, "operating_cycle": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cycle", "description": "Operating cycle." }, "days_of_payables_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Payables Outstanding", "description": "Days of payables outstanding." }, "cash_conversion_cycle": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Conversion Cycle", "description": "Cash conversion cycle." }, "gross_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit Margin", "description": "Gross profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "operating_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Profit Margin", "description": "Operating profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "pretax_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pretax Profit Margin", "description": "Pretax profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "net_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Profit Margin", "description": "Net profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "effective_tax_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Effective Tax Rate", "description": "Effective tax rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Assets", "description": "Return on assets.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Equity", "description": "Return on equity.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_capital_employed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Capital Employed", "description": "Return on capital employed.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "net_income_per_ebt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Ebt", "description": "Net income per EBT." }, "ebt_per_ebit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebt Per Ebit", "description": "EBT per EBIT." }, "ebit_per_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit Per Revenue", "description": "EBIT per revenue." }, "debt_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt Ratio", "description": "Debt ratio." }, "debt_equity_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt Equity Ratio", "description": "Debt equity ratio." }, "long_term_debt_to_capitalization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Debt To Capitalization", "description": "Long term debt to capitalization." }, "total_debt_to_capitalization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Debt To Capitalization", "description": "Total debt to capitalization." }, "interest_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage Ratio", "description": "Interest coverage." }, "cash_flow_to_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Flow To Debt", "description": "Cash flow to debt ratio." }, "company_equity_multiplier": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Company Equity Multiplier", "description": "Company equity multiplier." }, "receivables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover", "description": "Receivables turnover." }, "payables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover", "description": "Payables turnover." }, "inventory_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover", "description": "Inventory turnover." }, "fixed_asset_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fixed Asset Turnover", "description": "Fixed asset turnover." }, "asset_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Asset Turnover", "description": "Asset turnover." }, "operating_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share", "description": "Operating cash flow per share." }, "free_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share", "description": "Free cash flow per share." }, "cash_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share", "description": "Cash per share." }, "payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payout Ratio", "description": "Payout ratio." }, "operating_cash_flow_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Sales Ratio", "description": "Operating cash flow sales ratio." }, "free_cash_flow_operating_cash_flow_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Operating Cash Flow Ratio", "description": "Free cash flow operating cash flow ratio." }, "cash_flow_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Flow Coverage Ratio", "description": "Cash flow coverage ratio." }, "short_term_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Coverage Ratio", "description": "Short term coverage ratio." }, "capital_expenditure_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Expenditure Coverage Ratio", "description": "Capital expenditure coverage ratio." }, "price_book_value_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Book Value Ratio", "description": "Price book value ratio." }, "price_to_book_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book Ratio", "description": "Price to book ratio." }, "price_to_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales Ratio", "description": "Price to sales ratio." }, "price_earnings_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Earnings Ratio", "description": "Price earnings ratio." }, "price_to_free_cash_flows_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Free Cash Flows Ratio", "description": "Price to free cash flows ratio." }, "price_to_operating_cash_flows_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Operating Cash Flows Ratio", "description": "Price to operating cash flows ratio." }, "price_cash_flow_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Cash Flow Ratio", "description": "Price cash flow ratio." }, "price_earnings_to_growth_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Earnings To Growth Ratio", "description": "Price earnings to growth ratio." }, "price_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Sales Ratio", "description": "Price sales ratio." }, "dividend_paid_and_capex_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Paid And Capex Coverage Ratio", "description": "Dividend paid and capex coverage ratio." }, "dividend_payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Payout Ratio", "description": "Dividend payout ratio." }, "dividend_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Yield", "description": "Dividend yield.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "dividend_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Per Share", "description": "Dividend per share." }, "enterprise_value_multiple": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Multiple", "description": "Enterprise value multiple." }, "price_fair_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Fair Value", "description": "Price fair value." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", "fiscal_period" ], "title": "FMPFinancialRatiosData", "description": "FMP Financial Ratios Data." }, "FMPForwardEbitdaEstimatesData": { "properties": { "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." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Last Updated", "description": "The date of the last update." }, "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": "Fiscal year for the estimate." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "Fiscal quarter for the estimate." }, "calendar_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calendar Year", "description": "Calendar year for the estimate." }, "calendar_period": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Calendar Period", "description": "Calendar quarter for the estimate." }, "low_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Low Estimate", "description": "The EBITDA estimate low for the period." }, "high_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "High Estimate", "description": "The EBITDA estimate high for the period." }, "mean": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mean", "description": "The EBITDA estimate mean for the period." }, "median": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Median", "description": "The EBITDA estimate median for the period." }, "standard_deviation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Standard Deviation", "description": "The EBITDA estimate standard deviation for the period." }, "number_of_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the entity." }, "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Fiscal year for the estimate." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "Fiscal quarter for the estimate." }, "calendar_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calendar Year", "description": "Calendar year for the estimate." }, "calendar_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Period", "description": "Calendar quarter for the estimate." }, "low_estimate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low Estimate", "description": "Estimated EPS low for the period." }, "high_estimate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High Estimate", "description": "Estimated EPS high for the period." }, "mean": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mean", "description": "Estimated EPS mean for the period." }, "median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Median", "description": "Estimated EPS median for the period." }, "standard_deviation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Standard Deviation", "description": "Estimated EPS standard deviation for the period." }, "number_of_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "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": "string", "format": "date" }, { "type": "null" } ], "title": "Record Date", "description": "Record date of the historical dividends." }, "payment_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Payment Date", "description": "Payment date of the historical dividends." }, "declaration_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Declaration Date", "description": "Declaration date of the historical dividends." } }, "additionalProperties": true, "type": "object", "required": [ "ex_dividend_date", "amount", "label", "adj_dividend" ], "title": "FMPHistoricalDividendsData", "description": "FMP Historical Dividends Data." }, "FMPHistoricalEmployeesData": { "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": { "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." }, "source": { "type": "string", "title": "Source", "description": "Source URL which retrieves this data for the company." } }, "additionalProperties": true, "type": "object", "required": [ "symbol", "cik", "acceptance_time", "period_of_report", "company_name", "form_type", "filing_date", "employee_count", "source" ], "title": "FMPHistoricalEmployeesData", "description": "FMP Historical Employees Data." }, "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." }, "announce_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Announce Time", "description": "Timing of the earnings announcement." }, "eps_actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Actual", "description": "Actual EPS from the earnings date." }, "eps_estimated": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Estimated", "description": "Estimated EPS for the earnings date." }, "revenueEstimated": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenueestimated", "description": "Estimated consensus revenue for the reporting period." }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue", "description": "The actual reported revenue." }, "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 when the data was last updated." }, "fiscalDateEnding": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "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." }, "numerator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Numerator", "description": "Numerator of the split." }, "denominator": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Denominator", "description": "Denominator of the split." }, "split_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "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." }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue", "description": "Total revenue." }, "cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue", "description": "Cost of revenue." }, "gross_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit", "description": "Gross profit." }, "gross_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit Margin", "description": "Gross profit margin." }, "general_and_admin_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "General And Admin Expense", "description": "General and administrative expenses." }, "research_and_development_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development Expense", "description": "Research and development expenses." }, "selling_and_marketing_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Selling And Marketing Expense", "description": "Selling and marketing expenses." }, "selling_general_and_admin_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Selling General And Admin Expense", "description": "Selling, general and administrative expenses." }, "other_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Expenses", "description": "Other expenses." }, "total_operating_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Operating Expenses", "description": "Total operating expenses." }, "cost_and_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost And Expenses", "description": "Cost and expenses." }, "interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Income", "description": "Interest income." }, "total_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Interest Expense", "description": "Total interest expenses." }, "depreciation_and_amortization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation And Amortization", "description": "Depreciation and amortization." }, "ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda", "description": "EBITDA." }, "ebitda_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda Margin", "description": "EBITDA margin." }, "total_operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Operating Income", "description": "Total operating income." }, "operating_income_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Income Margin", "description": "Operating income margin." }, "total_other_income_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Other Income Expenses", "description": "Total other income and expenses." }, "total_pre_tax_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pre Tax Income", "description": "Total pre-tax income." }, "pre_tax_income_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pre Tax Income Margin", "description": "Pre-tax income margin." }, "income_tax_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Tax Expense", "description": "Income tax expense." }, "consolidated_net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Consolidated Net Income", "description": "Consolidated net income." }, "net_income_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Margin", "description": "Net income margin." }, "basic_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Basic Earnings Per Share", "description": "Basic earnings per share." }, "diluted_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diluted Earnings Per Share", "description": "Diluted earnings per share." }, "weighted_average_basic_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Basic Shares Outstanding", "description": "Weighted average basic shares outstanding." }, "weighted_average_diluted_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Diluted Shares Outstanding", "description": "Weighted average diluted shares outstanding." }, "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": "FMPIncomeStatementData", "description": "FMP Income Statement Data." }, "FMPIncomeStatementGrowthData": { "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": "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" }, { "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." }, "sub_sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Sector", "description": "Sub-sector the constituent company in the index belongs to." }, "headquarter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Headquarter", "description": "Location of the headquarter of the constituent company in the index." }, "date_first_added": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date First Added", "description": "Date the constituent company was added to the index." }, "cik": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cik", "description": "Central Index Key (CIK) for the requested entity." }, "founded": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date" }, { "type": "null" } ], "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", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in the price from the previous close." }, "changeOverTime": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "company_cik": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Company Cik", "description": "CIK number of the company." }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Date", "description": "Filing date of the trade." }, "transaction_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Transaction Date", "description": "Date of the transaction." }, "owner_cik": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Owner Cik", "description": "Reporting individual's CIK." }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name", "description": "Name of the reporting individual." }, "owner_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Title", "description": "The title held by the reporting individual." }, "transaction_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Type", "description": "Type of transaction being reported." }, "acquisition_or_disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acquisition Or Disposition", "description": "Acquisition or disposition of the shares." }, "security_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Security Type", "description": "The type of security transacted." }, "securities_owned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Securities Owned", "description": "Number of securities owned by the reporting individual." }, "securities_transacted": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Securities Transacted", "description": "Number of securities transacted by the reporting individual." }, "transaction_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Transaction Price", "description": "The price of the transaction." }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url", "description": "Link to the filing." }, "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": "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." }, "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." }, "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" ], "title": "FMPInstitutionalOwnershipData", "description": "FMP Institutional Ownership Data." }, "FMPKeyExecutivesData": { "properties": { "title": { "type": "string", "title": "Title", "description": "Designation of the key executive." }, "name": { "type": "string", "title": "Name", "description": "Name of the key executive." }, "pay": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pay", "description": "Pay of the key executive." }, "currency_pay": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Pay", "description": "Currency of the pay." }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender of the key executive." }, "year_born": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year Born", "description": "Birth year of the key executive." }, "title_since": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Title Since", "description": "Date the tile was held since." } }, "additionalProperties": true, "type": "object", "required": [ "title", "name" ], "title": "FMPKeyExecutivesData", "description": "FMP Key Executives Data." }, "FMPKeyMetricsData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "Market capitalization" }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, "period_ending": { "type": "string", "format": "date", "title": "Period Ending", "description": "Period ending date." }, "fiscal_period": { "type": "string", "title": "Fiscal Period", "description": "Period of the data." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Calendar year for the fiscal period." }, "revenue_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Share", "description": "Net income per share" }, "operating_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share", "description": "Operating cash flow per share" }, "free_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share", "description": "Free cash flow per share" }, "cash_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share", "description": "Cash per share" }, "book_value_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Book Value Per Share", "description": "Book value per share" }, "tangible_book_value_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Book Value Per Share", "description": "Tangible book value per share" }, "shareholders_equity_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shareholders Equity Per Share", "description": "Shareholders equity per share" }, "interest_debt_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Debt Per Share", "description": "Interest debt per share" }, "price_to_sales": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales", "description": "Price-to-sales ratio" }, "price_to_operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Operating Cash Flow", "description": "Price-to-operating cash flow ratio" }, "price_to_free_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Free Cash Flow", "description": "Price-to-free cash flow ratio" }, "price_to_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book", "description": "Price-to-book ratio" }, "price_to_tangible_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Tangible Book", "description": "Price-to-tangible book ratio" }, "ev_to_sales": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Sales", "description": "Enterprise value-to-sales ratio" }, "ev_to_ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Ebitda", "description": "Enterprise value-to-EBITDA ratio" }, "ev_to_operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Operating Cash Flow", "description": "Enterprise value-to-operating cash flow ratio" }, "ev_to_free_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Free Cash Flow", "description": "Enterprise value-to-free cash flow ratio" }, "earnings_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Yield", "description": "Earnings yield", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "free_cash_flow_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "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": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Equity", "description": "Debt-to-equity ratio" }, "debt_to_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Assets", "description": "Debt-to-assets ratio" }, "net_debt_to_ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Debt To Ebitda", "description": "Net debt-to-EBITDA ratio" }, "current_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio", "description": "Current ratio" }, "interest_coverage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage", "description": "Interest coverage" }, "income_quality": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Quality", "description": "Income quality" }, "payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payout Ratio", "description": "Payout ratio" }, "sales_general_and_administrative_to_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sales General And Administrative To Revenue", "description": "Sales general and administrative expenses-to-revenue ratio" }, "research_and_development_to_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development To Revenue", "description": "Research and development expenses-to-revenue ratio" }, "intangibles_to_total_assets": { "anyOf": [ { "type": "number" }, { "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" }, "working_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Working Capital", "description": "Working capital" }, "tangible_asset_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Asset Value", "description": "Tangible asset value" }, "net_current_asset_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": [ { "type": "number" }, { "type": "null" } ], "title": "Invested Capital", "description": "Invested capital" }, "average_receivables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Receivables", "description": "Average receivables" }, "average_payables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Payables", "description": "Average payables" }, "average_inventory": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Inventory", "description": "Average inventory" }, "days_sales_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Sales Outstanding", "description": "Days sales outstanding" }, "days_payables_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Payables Outstanding", "description": "Days payables outstanding" }, "days_of_inventory_on_hand": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Inventory On Hand", "description": "Days of inventory on hand" }, "receivables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover", "description": "Receivables turnover" }, "payables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover", "description": "Payables turnover" }, "inventory_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover", "description": "Inventory turnover" }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Equity", "description": "Return on equity", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_invested_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Invested Capital", "description": "Return on invested capital", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_tangible_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Tangible Assets", "description": "Return on tangible assets", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "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" }, "graham_number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Number", "description": "Graham number" }, "graham_net_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Net Net", "description": "Graham net-net working capital" } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", "fiscal_period" ], "title": "FMPKeyMetricsData", "description": "FMP Key Metrics Data." }, "FMPMarketSnapshotsData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in price from the previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "The change in price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "last_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Price", "description": "The last price of the stock." }, "last_price_timestamp": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Price Timestamp", "description": "The timestamp of the last price." }, "priceAvg50": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Priceavg50", "description": "The 50-day moving average." }, "priceAvg200": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Priceavg200", "description": "The 200-day moving average." }, "yearHigh": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Yearhigh", "description": "The 52-week high." }, "yearLow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Yearlow", "description": "The 52-week low." }, "volume_avg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume Avg", "description": "Average daily trading volume." }, "marketCap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Marketcap", "description": "Market cap of the stock." }, "eps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps", "description": "Earnings per share." }, "pe": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe", "description": "Price to earnings ratio." }, "shares_outstanding": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Outstanding", "description": "Number of shares outstanding." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The company name associated with the symbol." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange of the stock." }, "earningsAnnouncement": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Earningsannouncement", "description": "The upcoming earnings announcement date." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "FMPMarketSnapshotsData", "description": "FMP Market Snapshots Data." }, "FMPPricePerformanceData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "The ticker symbol." }, "one_day": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Day", "description": "One-day return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "wtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Wtd", "description": "Week to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_week": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Week", "description": "One-week return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "mtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mtd", "description": "Month to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Month", "description": "One-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "qtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Qtd", "description": "Quarter to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "three_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Three Month", "description": "Three-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "six_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Six Month", "description": "Six-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ytd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ytd", "description": "Year to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Year", "description": "One-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "two_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Two Year", "description": "Two-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "three_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Three Year", "description": "Three-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "four_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Four Year", "description": "Four-year", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "five_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Five Year", "description": "Five-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ten_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ten Year", "description": "Ten-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max", "description": "Return from the beginning of the time series.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "FMPPricePerformanceData", "description": "FMP Price Performance Data." }, "FMPPriceTargetConsensusData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The company name" }, "target_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target High", "description": "High target of the price target consensus." }, "target_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Low", "description": "Low target of the price target consensus." }, "target_consensus": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Consensus", "description": "Consensus target of the price target consensus." }, "target_median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action", "description": "Description of the change in rating from firm's last rating." }, "news_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Url", "description": "News URL of the price target." }, "news_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Title", "description": "News title of the price target." }, "news_publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Publisher", "description": "News publisher of the price target." }, "news_base_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "The fiscal period of the reporting period." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "business_line": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Business Line", "description": "Dictionary containing the revenue of the business line." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", "business_line" ], "title": "FMPRevenueBusinessLineData", "description": "FMP Revenue by Business Line Data." }, "FMPRevenueGeographicData": { "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 reporting period." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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": "FMPRevenueGeographicData", "description": "FMP Revenue Geographic Data." }, "FMPRiskPremiumData": { "properties": { "country": { "type": "string", "title": "Country", "description": "Market country." }, "continent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Continent", "description": "Continent of the country." }, "total_equity_risk_premium": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Total Equity Risk Premium", "description": "Total equity risk premium for the country." }, "country_risk_premium": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "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." }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "free_float": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Float", "description": "Percentage of unrestricted shares of a publicly-traded company." }, "float_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Float Shares", "description": "Number of shares available for trading by the general public." }, "outstanding_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Outstanding Shares", "description": "Total number of shares of a publicly-traded company." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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": "string" }, { "type": "null" } ], "title": "Symbol" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange" }, "exchange_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange Name" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "market_cap_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Cap Range" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik" }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin" }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip" }, "type": { "anyOf": [ { "type": "string" }, { "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." }, "FMPTreasuryRatesData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "week_4": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 4", "description": "4 week Treasury bills rate (secondary market).", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 1", "description": "1 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_2": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 2", "description": "2 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 3", "description": "3 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_6": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 6", "description": "6 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 1", "description": "1 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_2": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 2", "description": "2 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 3", "description": "3 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_5": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 5", "description": "5 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_7": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 7", "description": "7 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_10": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 10", "description": "10 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_20": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 20", "description": "20 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_30": { "anyOf": [ { "type": "number" }, { "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": "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." }, "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." }, "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": "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": "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" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "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": "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" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "range_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Range High", "description": "High projection of rates." }, "central_tendency_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Central Tendency High", "description": "Central tendency of high projection of rates." }, "median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Median", "description": "Median projection of rates." }, "range_midpoint": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Range Midpoint", "description": "Midpoint projection of rates." }, "central_tendency_midpoint": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Central Tendency Midpoint", "description": "Central tendency of midpoint projection of rates." }, "range_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Range Low", "description": "Low projection of rates." }, "central_tendency_low": { "anyOf": [ { "type": "number" }, { "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": "FREDPROJECTIONData", "description": "FRED PROJECTION Data." }, "FREDSOFRData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rate", "description": "SelectedTreasuryBill Rate." } }, "additionalProperties": true, "type": "object", "required": [ "date", "rate" ], "title": "FREDSelectedTreasuryBillData", "description": "FRED Selected Treasury Bill Data." }, "FREDSelectedTreasuryConstantMaturityData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rate", "description": "Selected Treasury Constant Maturity Rate." } }, "additionalProperties": true, "type": "object", "required": [ "date", "rate" ], "title": "FREDSelectedTreasuryConstantMaturityData", "description": "FRED Selected Treasury Constant Maturity Data." }, "FREDSpotRateData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "currency": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Currency", "description": "Value of currency in circulation in billions." }, "demand_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Demand Deposits", "description": "Value of demand deposits in billions." }, "retail_money_market_funds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Retail Money Market Funds", "description": "Value of retail money market funds in billions." }, "other_liquid_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Liquid Deposits", "description": "Value of other liquid deposits in billions." }, "small_denomination_time_deposits": { "anyOf": [ { "type": "number" }, { "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": "FederalReserveMoneyMeasuresData", "description": "FederalReserve Money Measures Data." }, "FederalReserveTreasuryRatesData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "week_4": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Week 4", "description": "4 week Treasury bills rate (secondary market).", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 1", "description": "1 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_2": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 2", "description": "2 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 3", "description": "3 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "month_6": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month 6", "description": "6 month Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 1", "description": "1 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_2": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 2", "description": "2 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 3", "description": "3 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_5": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 5", "description": "5 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_7": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 7", "description": "7 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_10": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 10", "description": "10 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_20": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 20", "description": "20 year Treasury rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "year_30": { "anyOf": [ { "type": "number" }, { "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": "FederalReserveTreasuryRatesData", "description": "FederalReserve Treasury Rates Data." }, "FederalReserveYieldCurveData": { "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": "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" }, { "type": "null" } ], "title": "Balance Percent Of Gdp", "description": "Current Account Balance as Percent of GDP", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "balance_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance Total", "description": "Current Account Total Balance (USD)" }, "balance_total_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance Total Services", "description": "Current Account Total Services Balance (USD)" }, "balance_total_secondary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance Total Secondary Income", "description": "Current Account Total Secondary Income Balance (USD)" }, "balance_total_goods": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance Total Goods", "description": "Current Account Total Goods Balance (USD)" }, "balance_total_primary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance Total Primary Income", "description": "Current Account Total Primary Income Balance (USD)" }, "credits_services_percent_of_goods_and_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "credits_services_percent_of_current_account": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "credits_total_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Total Services", "description": "Current Account Credits Total Services (USD)" }, "credits_total_goods": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Total Goods", "description": "Current Account Credits Total Goods (USD)" }, "credits_total_primary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Total Primary Income", "description": "Current Account Credits Total Primary Income (USD)" }, "credits_total_secondary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Total Secondary Income", "description": "Current Account Credits Total Secondary Income (USD)" }, "credits_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Total", "description": "Current Account Credits Total (USD)" }, "debits_services_percent_of_goods_and_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "debits_services_percent_of_current_account": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "debits_total_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debits Total Services", "description": "Current Account Debits Total Services (USD)" }, "debits_total_goods": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debits Total Goods", "description": "Current Account Debits Total Goods (USD)" }, "debits_total_primary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debits Total Primary Income", "description": "Current Account Debits Total Primary Income (USD)" }, "debits_total": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debits Total", "description": "Current Account Debits Total (USD)" }, "debits_total_secondary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": "string" }, { "type": "null" } ], "title": "Symbol" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "continent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Continent" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "update_frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Update Frequency" }, "frequency_short": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency Short" }, "observation_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Observation Start" }, "observation_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Observation End" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Units" }, "units_short": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "region": { "type": "string", "title": "Region", "description": "The name of the region." }, "code": { "anyOf": [ { "type": "string" }, { "type": "integer" } ], "title": "Code", "description": "The code of the region." }, "value": { "anyOf": [ { "type": "integer" }, { "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." } }, "additionalProperties": true, "type": "object", "required": [ "date", "region", "code", "series_id" ], "title": "FredRegionalData", "description": "FRED Regional Data." }, "FredSearchData": { "properties": { "release_id": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Release Id", "description": "The release ID for queries." }, "series_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Series Id", "description": "The series ID for the item in the release." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the release." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the series." }, "observation_start": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Observation Start", "description": "The date of the first observation in the series." }, "observation_end": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Observation End", "description": "The date of the last observation in the series." }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency", "description": "The frequency of the data." }, "frequency_short": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency Short", "description": "Short form of the data frequency." }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Units", "description": "The units of the data." }, "units_short": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Units Short", "description": "Short form of the data units." }, "seasonal_adjustment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seasonal Adjustment", "description": "The seasonal adjustment of the data." }, "seasonal_adjustment_short": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seasonal Adjustment Short", "description": "Short form of the data seasonal adjustment." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Updated", "description": "The datetime of the last update to the data." }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes", "description": "Description of the release." }, "press_release": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Press Release", "description": "If the release is a press release." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "URL to the release." }, "popularity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Popularity", "description": "Popularity of the series" }, "group_popularity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Group Popularity", "description": "Group popularity of the release" }, "region_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region Type", "description": "The region type of the series." }, "series_group": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "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": "FredSearchData", "description": "FRED Search Data." }, "FredSeriesData": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." } }, "additionalProperties": true, "type": "object", "required": [ "date" ], "title": "FredSeriesData", "description": "FRED Series Data." }, "GroupedComparisons": { "properties": { "financial_ratios": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GroupedRatios" }, "type": "array" }, { "type": "null" } ], "title": "Financial Ratios", "description": "Ratios data." }, "valuation_multiples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/GroupedMetrics" }, "type": "array" }, { "type": "null" } ], "title": "Valuation Multiples", "description": "Metrics data." }, "available": { "anyOf": [ { "$ref": "#/components/schemas/AvailableComparisonData" }, { "type": "null" } ], "description": "Available financial data." }, "tickers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPTicker" }, "type": "array" }, { "type": "null" } ], "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." }, "cash_flow_statement": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/FMPCashFlowStatementData" }, { "$ref": "#/components/schemas/IntrinioCashFlowStatementData" } ] }, "type": "array" }, { "type": "null" } ], "title": "Cash Flow Statement", "description": "Cash flow statement data." }, "income_statement": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/FMPIncomeStatementData" }, { "$ref": "#/components/schemas/IntrinioIncomeStatementData" } ] }, "type": "array" }, { "type": "null" } ], "title": "Income Statement", "description": "Income statement data." } }, "additionalProperties": true, "type": "object", "title": "GroupedFinancials", "description": "Grouped Financials Data." }, "GroupedMetrics": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Stock symbol." }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "Market capitalization" }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, "period_ending": { "type": "string", "format": "date", "title": "Period Ending", "description": "Period ending date." }, "fiscal_period": { "type": "string", "title": "Fiscal Period", "description": "Period of the data." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Calendar year for the fiscal period." }, "revenue_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Share", "description": "Net income per share" }, "operating_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share", "description": "Operating cash flow per share" }, "free_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share", "description": "Free cash flow per share" }, "cash_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share", "description": "Cash per share" }, "book_value_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Book Value Per Share", "description": "Book value per share" }, "tangible_book_value_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Book Value Per Share", "description": "Tangible book value per share" }, "shareholders_equity_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shareholders Equity Per Share", "description": "Shareholders equity per share" }, "interest_debt_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Debt Per Share", "description": "Interest debt per share" }, "price_to_sales": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales", "description": "Price-to-sales ratio" }, "price_to_operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Operating Cash Flow", "description": "Price-to-operating cash flow ratio" }, "price_to_free_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Free Cash Flow", "description": "Price-to-free cash flow ratio" }, "price_to_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book", "description": "Price-to-book ratio" }, "price_to_tangible_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Tangible Book", "description": "Price-to-tangible book ratio" }, "ev_to_sales": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Sales", "description": "Enterprise value-to-sales ratio" }, "ev_to_ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Ebitda", "description": "Enterprise value-to-EBITDA ratio" }, "ev_to_operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Operating Cash Flow", "description": "Enterprise value-to-operating cash flow ratio" }, "ev_to_free_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ev To Free Cash Flow", "description": "Enterprise value-to-free cash flow ratio" }, "earnings_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Yield", "description": "Earnings yield", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "free_cash_flow_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "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": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Equity", "description": "Debt-to-equity ratio" }, "debt_to_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt To Assets", "description": "Debt-to-assets ratio" }, "net_debt_to_ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Debt To Ebitda", "description": "Net debt-to-EBITDA ratio" }, "current_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio", "description": "Current ratio" }, "interest_coverage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage", "description": "Interest coverage" }, "income_quality": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Quality", "description": "Income quality" }, "payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payout Ratio", "description": "Payout ratio" }, "sales_general_and_administrative_to_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sales General And Administrative To Revenue", "description": "Sales general and administrative expenses-to-revenue ratio" }, "research_and_development_to_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development To Revenue", "description": "Research and development expenses-to-revenue ratio" }, "intangibles_to_total_assets": { "anyOf": [ { "type": "number" }, { "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" }, "working_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Working Capital", "description": "Working capital" }, "tangible_asset_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tangible Asset Value", "description": "Tangible asset value" }, "net_current_asset_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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": [ { "type": "number" }, { "type": "null" } ], "title": "Invested Capital", "description": "Invested capital" }, "average_receivables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Receivables", "description": "Average receivables" }, "average_payables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Payables", "description": "Average payables" }, "average_inventory": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average Inventory", "description": "Average inventory" }, "days_sales_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Sales Outstanding", "description": "Days sales outstanding" }, "days_payables_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Payables Outstanding", "description": "Days payables outstanding" }, "days_of_inventory_on_hand": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Inventory On Hand", "description": "Days of inventory on hand" }, "receivables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover", "description": "Receivables turnover" }, "payables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover", "description": "Payables turnover" }, "inventory_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover", "description": "Inventory turnover" }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Equity", "description": "Return on equity", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_invested_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Invested Capital", "description": "Return on invested capital", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_tangible_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Tangible Assets", "description": "Return on tangible assets", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "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" }, "graham_number": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Number", "description": "Graham number" }, "graham_net_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Graham Net Net", "description": "Graham net-net working capital" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "fiscal_period": { "type": "string", "title": "Fiscal Period", "description": "Period of the financial ratios." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Fiscal year." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Stock symbol." }, "current_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Ratio", "description": "Current ratio." }, "quick_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quick Ratio", "description": "Quick ratio." }, "cash_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Ratio", "description": "Cash ratio." }, "days_of_sales_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Sales Outstanding", "description": "Days of sales outstanding." }, "days_of_inventory_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Inventory Outstanding", "description": "Days of inventory outstanding." }, "operating_cycle": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cycle", "description": "Operating cycle." }, "days_of_payables_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days Of Payables Outstanding", "description": "Days of payables outstanding." }, "cash_conversion_cycle": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Conversion Cycle", "description": "Cash conversion cycle." }, "gross_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit Margin", "description": "Gross profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "operating_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Profit Margin", "description": "Operating profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "pretax_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pretax Profit Margin", "description": "Pretax profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "net_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Profit Margin", "description": "Net profit margin.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "effective_tax_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Effective Tax Rate", "description": "Effective tax rate.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Assets", "description": "Return on assets.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Equity", "description": "Return on equity.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_capital_employed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Capital Employed", "description": "Return on capital employed.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "net_income_per_ebt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Per Ebt", "description": "Net income per EBT." }, "ebt_per_ebit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebt Per Ebit", "description": "EBT per EBIT." }, "ebit_per_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit Per Revenue", "description": "EBIT per revenue." }, "debt_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt Ratio", "description": "Debt ratio." }, "debt_equity_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Debt Equity Ratio", "description": "Debt equity ratio." }, "long_term_debt_to_capitalization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Debt To Capitalization", "description": "Long term debt to capitalization." }, "total_debt_to_capitalization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Debt To Capitalization", "description": "Total debt to capitalization." }, "interest_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Coverage Ratio", "description": "Interest coverage." }, "cash_flow_to_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Flow To Debt", "description": "Cash flow to debt ratio." }, "company_equity_multiplier": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Company Equity Multiplier", "description": "Company equity multiplier." }, "receivables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Receivables Turnover", "description": "Receivables turnover." }, "payables_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payables Turnover", "description": "Payables turnover." }, "inventory_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory Turnover", "description": "Inventory turnover." }, "fixed_asset_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fixed Asset Turnover", "description": "Fixed asset turnover." }, "asset_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Asset Turnover", "description": "Asset turnover." }, "operating_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Per Share", "description": "Operating cash flow per share." }, "free_cash_flow_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Per Share", "description": "Free cash flow per share." }, "cash_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Per Share", "description": "Cash per share." }, "payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payout Ratio", "description": "Payout ratio." }, "operating_cash_flow_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow Sales Ratio", "description": "Operating cash flow sales ratio." }, "free_cash_flow_operating_cash_flow_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow Operating Cash Flow Ratio", "description": "Free cash flow operating cash flow ratio." }, "cash_flow_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Flow Coverage Ratio", "description": "Cash flow coverage ratio." }, "short_term_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Coverage Ratio", "description": "Short term coverage ratio." }, "capital_expenditure_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Expenditure Coverage Ratio", "description": "Capital expenditure coverage ratio." }, "price_book_value_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Book Value Ratio", "description": "Price book value ratio." }, "price_to_book_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book Ratio", "description": "Price to book ratio." }, "price_to_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Sales Ratio", "description": "Price to sales ratio." }, "price_earnings_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Earnings Ratio", "description": "Price earnings ratio." }, "price_to_free_cash_flows_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Free Cash Flows Ratio", "description": "Price to free cash flows ratio." }, "price_to_operating_cash_flows_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Operating Cash Flows Ratio", "description": "Price to operating cash flows ratio." }, "price_cash_flow_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Cash Flow Ratio", "description": "Price cash flow ratio." }, "price_earnings_to_growth_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Earnings To Growth Ratio", "description": "Price earnings to growth ratio." }, "price_sales_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Sales Ratio", "description": "Price sales ratio." }, "dividend_paid_and_capex_coverage_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Paid And Capex Coverage Ratio", "description": "Dividend paid and capex coverage ratio." }, "dividend_payout_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Payout Ratio", "description": "Dividend payout ratio." }, "dividend_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Yield", "description": "Dividend yield.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "dividend_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend Per Share", "description": "Dividend per share." }, "enterprise_value_multiple": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Enterprise Value Multiple", "description": "Enterprise value multiple." }, "price_fair_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Fair Value", "description": "Price fair value." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Stock name." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", "fiscal_period" ], "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." }, "IntrinioBalanceSheetData": { "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." }, "reported_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reported Currency", "description": "The currency in which the balance sheet is reported." }, "cash_and_cash_equivalents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash And Cash Equivalents", "description": "Cash and cash equivalents." }, "cash_and_due_from_banks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash And Due From Banks", "description": "Cash and due from banks." }, "restricted_cash": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Restricted Cash", "description": "Restricted cash." }, "short_term_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Investments", "description": "Short term investments." }, "federal_funds_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Federal Funds Sold", "description": "Federal funds sold." }, "accounts_receivable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accounts Receivable", "description": "Accounts receivable." }, "note_and_lease_receivable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Note And Lease Receivable", "description": "Note and lease receivable. (Vendor non-trade receivables)" }, "inventories": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventories", "description": "Net Inventories." }, "customer_and_other_receivables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Customer And Other Receivables", "description": "Customer and other receivables." }, "interest_bearing_deposits_at_other_banks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Bearing Deposits At Other Banks", "description": "Interest bearing deposits at other banks." }, "time_deposits_placed_and_other_short_term_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Time Deposits Placed And Other Short Term Investments", "description": "Time deposits placed and other short term investments." }, "trading_account_securities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Trading Account Securities", "description": "Trading account securities." }, "loans_and_leases": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loans And Leases", "description": "Loans and leases." }, "allowance_for_loan_and_lease_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Allowance For Loan And Lease Losses", "description": "Allowance for loan and lease losses." }, "current_deferred_refundable_income_taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Deferred Refundable Income Taxes", "description": "Current deferred refundable income taxes." }, "other_current_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Current Assets", "description": "Other current assets." }, "loans_and_leases_net_of_allowance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loans And Leases Net Of Allowance", "description": "Loans and leases net of allowance." }, "accrued_investment_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accrued Investment Income", "description": "Accrued investment income." }, "other_current_non_operating_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Current Non Operating Assets", "description": "Other current non-operating assets." }, "loans_held_for_sale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loans Held For Sale", "description": "Loans held for sale." }, "prepaid_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prepaid Expenses", "description": "Prepaid expenses." }, "total_current_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Current Assets", "description": "Total current assets." }, "plant_property_equipment_gross": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Plant Property Equipment Gross", "description": "Plant property equipment gross." }, "accumulated_depreciation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accumulated Depreciation", "description": "Accumulated depreciation." }, "premises_and_equipment_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Premises And Equipment Net", "description": "Net premises and equipment." }, "plant_property_equipment_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Plant Property Equipment Net", "description": "Net plant property equipment." }, "long_term_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Investments", "description": "Long term investments." }, "mortgage_servicing_rights": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mortgage Servicing Rights", "description": "Mortgage servicing rights." }, "unearned_premiums_asset": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unearned Premiums Asset", "description": "Unearned premiums asset." }, "non_current_note_lease_receivables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Current Note Lease Receivables", "description": "Non-current note lease receivables." }, "deferred_acquisition_cost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Deferred Acquisition Cost", "description": "Deferred acquisition cost." }, "goodwill": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Goodwill", "description": "Goodwill." }, "separate_account_business_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Separate Account Business Assets", "description": "Separate account business assets." }, "non_current_deferred_refundable_income_taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Current Deferred Refundable Income Taxes", "description": "Noncurrent deferred refundable income taxes." }, "intangible_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Intangible Assets", "description": "Intangible assets." }, "employee_benefit_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Employee Benefit Assets", "description": "Employee benefit assets." }, "other_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Assets", "description": "Other assets." }, "other_non_current_operating_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Non Current Operating Assets", "description": "Other noncurrent operating assets." }, "other_non_current_non_operating_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Non Current Non Operating Assets", "description": "Other noncurrent non-operating assets." }, "interest_bearing_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Bearing Deposits", "description": "Interest bearing deposits." }, "total_non_current_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Non Current Assets", "description": "Total noncurrent assets." }, "total_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Assets", "description": "Total assets." }, "non_interest_bearing_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Interest Bearing Deposits", "description": "Non interest bearing deposits." }, "federal_funds_purchased_and_securities_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Federal Funds Purchased And Securities Sold", "description": "Federal funds purchased and securities sold." }, "bankers_acceptance_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bankers Acceptance Outstanding", "description": "Bankers acceptance outstanding." }, "short_term_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Debt", "description": "Short term debt." }, "accounts_payable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accounts Payable", "description": "Accounts payable." }, "current_deferred_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Deferred Revenue", "description": "Current deferred revenue." }, "current_deferred_payable_income_tax_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Deferred Payable Income Tax Liabilities", "description": "Current deferred payable income tax liabilities." }, "accrued_interest_payable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accrued Interest Payable", "description": "Accrued interest payable." }, "accrued_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accrued Expenses", "description": "Accrued expenses." }, "other_short_term_payables": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Short Term Payables", "description": "Other short term payables." }, "customer_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Customer Deposits", "description": "Customer deposits." }, "dividends_payable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividends Payable", "description": "Dividends payable." }, "claims_and_claim_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Claims And Claim Expense", "description": "Claims and claim expense." }, "future_policy_benefits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Future Policy Benefits", "description": "Future policy benefits." }, "current_employee_benefit_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Employee Benefit Liabilities", "description": "Current employee benefit liabilities." }, "unearned_premiums_liability": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unearned Premiums Liability", "description": "Unearned premiums liability." }, "other_taxes_payable": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Taxes Payable", "description": "Other taxes payable." }, "policy_holder_funds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Policy Holder Funds", "description": "Policy holder funds." }, "other_current_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Current Liabilities", "description": "Other current liabilities." }, "other_current_non_operating_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Current Non Operating Liabilities", "description": "Other current non-operating liabilities." }, "separate_account_business_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Separate Account Business Liabilities", "description": "Separate account business 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." }, "other_long_term_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Long Term Liabilities", "description": "Other long term liabilities." }, "non_current_deferred_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Current Deferred Revenue", "description": "Non-current deferred revenue." }, "non_current_deferred_payable_income_tax_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Current Deferred Payable Income Tax Liabilities", "description": "Non-current deferred payable income tax liabilities." }, "non_current_employee_benefit_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Current Employee Benefit Liabilities", "description": "Non-current employee benefit liabilities." }, "other_non_current_operating_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Non Current Operating Liabilities", "description": "Other non-current operating liabilities." }, "other_non_current_non_operating_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Non Current Non Operating Liabilities", "description": "Other non-current, non-operating liabilities." }, "total_non_current_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Non Current Liabilities", "description": "Total non-current liabilities." }, "capital_lease_obligations": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Lease Obligations", "description": "Capital lease obligations." }, "asset_retirement_reserve_litigation_obligation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Asset Retirement Reserve Litigation Obligation", "description": "Asset retirement reserve litigation obligation." }, "total_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Liabilities", "description": "Total liabilities." }, "commitments_contingencies": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Commitments Contingencies", "description": "Commitments contingencies." }, "redeemable_non_controlling_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Redeemable Non Controlling Interest", "description": "Redeemable non-controlling interest." }, "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." }, "treasury_stock": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Treasury Stock", "description": "Treasury stock." }, "accumulated_other_comprehensive_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Accumulated Other Comprehensive Income", "description": "Accumulated other comprehensive income." }, "participating_policy_holder_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Participating Policy Holder Equity", "description": "Participating policy holder equity." }, "other_equity_adjustments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Equity Adjustments", "description": "Other equity adjustments." }, "total_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Common Equity", "description": "Total common equity." }, "total_preferred_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Preferred Common Equity", "description": "Total preferred common equity." }, "non_controlling_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Controlling Interest", "description": "Non-controlling interest." }, "total_equity_non_controlling_interests": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Equity Non Controlling Interests", "description": "Total equity non-controlling interests." }, "total_liabilities_shareholders_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Liabilities Shareholders Equity", "description": "Total liabilities and shareholders equity." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending" ], "title": "IntrinioBalanceSheetData", "description": "Intrinio Balance Sheet Data." }, "IntrinioCalendarIpoData": { "properties": { "symbol": { "anyOf": [ { "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": "Ipo Date", "description": "The date of the IPO, when the stock first trades on a major exchange." }, "status": { "anyOf": [ { "type": "string", "enum": [ "upcoming", "priced", "withdrawn" ] }, { "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." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ." }, "offer_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Offer Amount", "description": "The total dollar amount of shares offered in the IPO. Typically this is share price * share count" }, "share_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Price", "description": "The price per share at which the IPO was offered." }, "share_price_lowest": { "anyOf": [ { "type": "number" }, { "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)." }, "share_price_highest": { "anyOf": [ { "type": "number" }, { "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)." }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "The number of shares offered in the IPO." }, "share_count_lowest": { "anyOf": [ { "type": "integer" }, { "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)." }, "share_count_highest": { "anyOf": [ { "type": "integer" }, { "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)." }, "announcement_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Announcement Url", "description": "The URL to the company's announcement of the IPO" }, "sec_report_url": { "anyOf": [ { "type": "string" }, { "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." }, "open_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open Price", "description": "The opening price at the beginning of the first trading day (only available for priced IPOs)." }, "close_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close Price", "description": "The closing price at the end of the first trading day (only available for priced IPOs)." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The volume at the end of the first trading day (only available for priced IPOs)." }, "day_change": { "anyOf": [ { "type": "number" }, { "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)." }, "week_change": { "anyOf": [ { "type": "number" }, { "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)." }, "month_change": { "anyOf": [ { "type": "number" }, { "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)." }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "The Intrinio ID of the IPO." }, "company": { "anyOf": [ { "$ref": "#/components/schemas/IntrinioCompany" }, { "type": "null" } ], "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", "title": "IntrinioCalendarIpoData", "description": "Intrinio IPO Calendar Data." }, "IntrinioCashFlowStatementData": { "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." }, "reported_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reported Currency", "description": "The currency in which the balance sheet is reported." }, "net_income_continuing_operations": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Continuing Operations", "description": "Net Income (Continuing Operations)" }, "net_income_discontinued_operations": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Discontinued Operations", "description": "Net Income (Discontinued Operations)" }, "net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income", "description": "Consolidated Net Income." }, "provision_for_loan_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Provision For Loan Losses", "description": "Provision for Loan Losses" }, "provision_for_credit_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Provision For Credit Losses", "description": "Provision for credit losses" }, "depreciation_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation Expense", "description": "Depreciation Expense." }, "amortization_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amortization Expense", "description": "Amortization Expense." }, "share_based_compensation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Share Based Compensation", "description": "Share-based compensation." }, "non_cash_adjustments_to_reconcile_net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Cash Adjustments To Reconcile Net Income", "description": "Non-Cash Adjustments to Reconcile Net Income." }, "changes_in_operating_assets_and_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Changes In Operating Assets And Liabilities", "description": "Changes in Operating Assets and Liabilities (Net)" }, "net_cash_from_continuing_operating_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Continuing Operating Activities", "description": "Net Cash from Continuing Operating Activities" }, "net_cash_from_discontinued_operating_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Discontinued Operating Activities", "description": "Net Cash from Discontinued Operating Activities" }, "net_cash_from_operating_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Operating Activities", "description": "Net Cash from Operating Activities" }, "divestitures": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Divestitures", "description": "Divestitures" }, "sale_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sale Of Property Plant And Equipment", "description": "Sale of Property, Plant, and Equipment" }, "acquisitions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Acquisitions", "description": "Acquisitions" }, "purchase_of_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Of Investments", "description": "Purchase of Investments" }, "purchase_of_investment_securities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Of Investment Securities", "description": "Purchase of Investment Securities" }, "sale_and_maturity_of_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sale And Maturity Of Investments", "description": "Sale and Maturity of Investments" }, "loans_held_for_sale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loans Held For Sale", "description": "Loans Held for Sale (Net)" }, "purchase_of_property_plant_and_equipment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Purchase Of Property Plant And Equipment", "description": "Purchase of Property, Plant, and Equipment" }, "other_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Investing Activities", "description": "Other Investing Activities (Net)" }, "net_cash_from_continuing_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Continuing Investing Activities", "description": "Net Cash from Continuing Investing Activities" }, "net_cash_from_discontinued_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Discontinued Investing Activities", "description": "Net Cash from Discontinued Investing Activities" }, "net_cash_from_investing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Investing Activities", "description": "Net Cash from Investing Activities" }, "payment_of_dividends": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Payment Of Dividends", "description": "Payment of Dividends" }, "repurchase_of_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repurchase Of Common Equity", "description": "Repurchase of Common Equity" }, "repurchase_of_preferred_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repurchase Of Preferred Equity", "description": "Repurchase of Preferred Equity" }, "issuance_of_common_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Issuance Of Common Equity", "description": "Issuance of Common Equity" }, "issuance_of_preferred_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Issuance Of Preferred Equity", "description": "Issuance of Preferred Equity" }, "issuance_of_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Issuance Of Debt", "description": "Issuance of Debt" }, "repayment_of_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repayment Of Debt", "description": "Repayment of Debt" }, "other_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Financing Activities", "description": "Other Financing Activities (Net)" }, "cash_interest_received": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Interest Received", "description": "Cash Interest Received" }, "net_change_in_deposits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Change In Deposits", "description": "Net Change in Deposits" }, "net_increase_in_fed_funds_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Increase In Fed Funds Sold", "description": "Net Increase in Fed Funds Sold" }, "net_cash_from_continuing_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Continuing Financing Activities", "description": "Net Cash from Continuing Financing Activities" }, "net_cash_from_discontinued_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Discontinued Financing Activities", "description": "Net Cash from Discontinued Financing Activities" }, "net_cash_from_financing_activities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Cash From Financing Activities", "description": "Net Cash from Financing Activities" }, "effect_of_exchange_rate_changes": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Effect Of Exchange Rate Changes", "description": "Effect of Exchange Rate Changes" }, "other_net_changes_in_cash": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Net Changes In Cash", "description": "Other Net Changes in Cash" }, "net_change_in_cash_and_equivalents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Change In Cash And Equivalents", "description": "Net Change in Cash and Equivalents" }, "cash_income_taxes_paid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Income Taxes Paid", "description": "Cash Income Taxes Paid" }, "cash_interest_paid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker", "description": "The stock market ticker symbol associated with the company's common stock securities" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The company's common name." }, "lei": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lei", "description": "The Legal Entity Identifier (LEI) of the company." }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "accepted_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted Date", "description": "Accepted date of the filing." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type", "description": "Type of filing." }, "filing_url": { "anyOf": [ { "type": "string" }, { "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." }, "period_end_date": { "anyOf": [ { "type": "string", "format": "date" }, { "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." }, "instance_url": { "anyOf": [ { "type": "string" }, { "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": "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": "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": "Images associated with the article." }, "url": { "type": "string", "title": "Url", "description": "URL to the article." }, "symbols": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbols", "description": "Symbols associated with the article." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The source of the news article." }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary", "description": "The summary of the news article." }, "topics": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topics", "description": "The topics related to the news article." }, "word_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Word Count", "description": "The word count of the news article." }, "business_relevance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Business Relevance", "description": " \tHow strongly correlated the news article is to the business" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment", "description": "The sentiment of the news article - i.e, negative, positive." }, "sentiment_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment Confidence", "description": "The confidence score of the sentiment rating." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "The language of the news article." }, "spam": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spam", "description": "Whether the news article is spam." }, "copyright": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Copyright", "description": "The copyright notice of the news article." }, "id": { "type": "string", "title": "Id", "description": "Article ID." }, "security": { "anyOf": [ { "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the currency pair." }, "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": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "title": "Open", "description": "The open price." }, "high": { "type": "number", "title": "High", "description": "The high price." }, "low": { "type": "number", "title": "Low", "description": "The low price." }, "close": { "type": "number", "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "average": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Average", "description": "Average trade price of an individual equity during the interval." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in the price of the symbol from the previous day." }, "percent_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Percent Change", "description": "Percent change in the price of the symbol from the previous day.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "adj_open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Open", "description": "The adjusted open price." }, "adj_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj High", "description": "The adjusted high price." }, "adj_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Low", "description": "The adjusted low price." }, "adj_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Close", "description": "The adjusted close price." }, "adj_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adj Volume", "description": "The adjusted volume." }, "fifty_two_week_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fifty Two Week High", "description": "52 week high price for the symbol." }, "fifty_two_week_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fifty Two Week Low", "description": "52 week low price for the symbol." }, "factor": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Factor", "description": "factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices." }, "split_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Split Ratio", "description": "Ratio of the equity split, if a split occurred." }, "dividend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividend", "description": "Dividend amount, if a dividend was paid." }, "close_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Close Time", "description": "The timestamp that represents the end of the interval span." }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency", "description": "The data time frequency." }, "intraperiod": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "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": [ "date", "open", "high", "low", "close" ], "title": "IntrinioEquityHistoricalData", "description": "Intrinio Equity Historical Price Data." }, "IntrinioEquityInfoData": { "properties": { "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lei", "description": "Legal Entity Identifier assigned to the company." }, "legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Name", "description": "Official legal name of the company." }, "stock_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stock Exchange", "description": "Stock exchange where the company is traded." }, "sic": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sic", "description": "Standard Industrial Classification code for the company." }, "short_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Description", "description": "Short description of the company." }, "long_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Long Description", "description": "Long description of the company." }, "ceo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ceo", "description": "Chief Executive Officer of the company." }, "company_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Url", "description": "URL of the company's website." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Address of the company's headquarters." }, "mailing_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing Address", "description": "Mailing address of the company." }, "business_phone_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Phone No", "description": "Phone number of the company's headquarters." }, "hq_address_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address 1", "description": "Address of the company's headquarters." }, "hq_address_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address 2", "description": "Address of the company's headquarters." }, "hq_address_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address City", "description": "City of the company's headquarters." }, "hq_address_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Address Postal Code", "description": "Zip code of the company's headquarters." }, "hq_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq State", "description": "State of the company's headquarters." }, "hq_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hq Country", "description": "Country of the company's headquarters." }, "inc_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inc State", "description": "State in which the company is incorporated." }, "inc_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inc Country", "description": "Country in which the company is incorporated." }, "employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Employees", "description": "Number of employees working for the company." }, "entity_legal_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Legal Form", "description": "Legal form of the company." }, "entity_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Status", "description": "Status of the company." }, "latest_filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Latest Filing Date", "description": "Date of the company's latest filing." }, "irs_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Irs Number", "description": "IRS number assigned to the company." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "Sector in which the company operates." }, "industry_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry Category", "description": "Category of industry in which the company operates." }, "industry_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry Group", "description": "Group of industry in which the company operates." }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template", "description": "Template used to standardize the company's financial statements." }, "standardized_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Standardized Active", "description": "Whether the company is active or not." }, "first_fundamental_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "First Fundamental Date", "description": "Date of the company's first fundamental." }, "last_fundamental_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Last Fundamental Date", "description": "Date of the company's last fundamental." }, "first_stock_price_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "First Stock Price Date", "description": "Date of the company's first stock price." }, "last_stock_price_date": { "anyOf": [ { "type": "string", "format": "date" }, { "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." }, "thea_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "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." }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Type", "description": "Type of asset - i.e, stock, ETF, etc." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the company or asset." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The name or symbol of the venue where the data is from." }, "bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid", "description": "Price of the top bid order." }, "bid_size": { "anyOf": [ { "type": "integer" }, { "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." }, "bid_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bid Exchange", "description": "The specific trading venue where the purchase order was placed." }, "ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask", "description": "Price of the top ask order." }, "ask_size": { "anyOf": [ { "type": "integer" }, { "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." }, "ask_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ask Exchange", "description": "The specific trading venue where the sale order was placed." }, "quote_conditions": { "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." }, "quote_indicators": { "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." }, "sales_conditions": { "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": "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": { "anyOf": [ { "type": "string" }, { "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." }, "trf_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Trf Timestamp", "description": "Timestamp for when the TRF (Trade Reporting Facility) received the message." }, "sip_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sip Timestamp", "description": "Timestamp for when the SIP (Security Information Processor) received the message from the exchange." }, "last_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Price", "description": "Price of the last trade." }, "last_tick": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Tick", "description": "Whether the last sale was an up or down tick." }, "last_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Size", "description": "Size of the last trade." }, "last_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Timestamp", "description": "Date and Time when the last price was recorded." }, "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": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "exchange_volume": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Exchange Volume", "description": "Volume of shares exchanged during the trading day on the specific exchange." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "Change in price from previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "Change in price as a normalized percentage.", "x-frontendmultiply": 100 }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The one year high (52W High)." }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The one year low (52W Low)." }, "is_darkpool": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Darkpool", "description": "Whether or not the current trade is from a darkpool." }, "source": { "anyOf": [ { "type": "string" }, { "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." }, "security": { "anyOf": [ { "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], "description": "Security details related to the quote." } }, "additionalProperties": true, "type": "object", "required": [ "symbol", "updated_on" ], "title": "IntrinioEquityQuoteData", "description": "Intrinio Equity Quote Data." }, "IntrinioEquitySearchData": { "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 company." }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik", "description": "" }, "lei": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lei", "description": "The Legal Entity Identifier (LEI) of the company." }, "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" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data. (ETF)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The common name for the holding." }, "security_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Security Type", "description": "The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')" }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin", "description": "The International Securities Identification Number." }, "ric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ric", "description": "The Reuters Instrument Code." }, "sedol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sedol", "description": "The Stock Exchange Daily Official List." }, "share_class_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Class Figi", "description": "The OpenFIGI symbol for the holding." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "The country or region of the holding." }, "maturity_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Maturity Date", "description": "The maturity date for the debt security, if available." }, "contract_expiry_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Contract Expiry Date", "description": "Expiry date for the futures contract held, if available." }, "coupon": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Coupon", "description": "The coupon rate of the debt security, if available." }, "balance": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Balance", "description": "The number of units of the security held, if available." }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit", "description": "The units of the 'balance' field." }, "units_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Units Per Share", "description": "Number of units of the security held per share outstanding of the ETF, if available." }, "face_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Face Value", "description": "The face value of the debt security, if available." }, "derivatives_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Derivatives Value", "description": "The notional value of derivatives contracts held." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "The market value of the holding, on the 'as_of' date." }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight", "description": "The weight of the holding, as a normalized percent." }, "updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Updated", "description": "The 'as_of' date for the holding." } }, "additionalProperties": true, "type": "object", "title": "IntrinioEtfHoldingsData", "description": "Intrinio ETF Holdings Data." }, "IntrinioEtfInfoData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data. (ETF)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the ETF." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the fund." }, "inception_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inception Date", "description": "Inception date of the ETF." }, "fund_listing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Fund Listing Date", "description": "The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange." }, "data_change_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Data Change Date", "description": "The last date on which there was a change in a classifications data field for this ETF." }, "etn_maturity_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Etn Maturity Date", "description": "If the product is an ETN, this field identifies the maturity date for the ETN." }, "is_listed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Listed", "description": "If true, the ETF is still listed on an exchange." }, "close_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Close Date", "description": "The date on which the ETF was de-listed if it is no longer listed." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange Market Identifier Code (MIC)." }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin", "description": "International Securities Identification Number (ISIN)." }, "ric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ric", "description": "Reuters Instrument Code (RIC)." }, "sedol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sedol", "description": "Stock Exchange Daily Official List (SEDOL)." }, "figi_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Figi Symbol", "description": "Financial Instrument Global Identifier (FIGI) symbol." }, "share_class_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Class Figi", "description": "Financial Instrument Global Identifier (FIGI)." }, "firstbridge_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstbridge Id", "description": "The FirstBridge unique identifier for the Exchange Traded Fund (ETF)." }, "firstbridge_parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Firstbridge Parent Id", "description": "The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable." }, "intrinio_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intrinio Id", "description": "Intrinio unique identifier for the security." }, "intraday_nav_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intraday Nav Symbol", "description": "Intraday Net Asset Value (NAV) symbol." }, "primary_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Symbol", "description": "The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes." }, "etp_structure_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Etp Structure Type", "description": "Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure." }, "legal_structure": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Structure", "description": "Legal structure of the fund." }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer", "description": "Issuer of the ETF." }, "etn_issuing_bank": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Etn Issuing Bank", "description": "If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank." }, "fund_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fund Family", "description": "This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor." }, "investment_style": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Investment Style", "description": "Investment style of the ETF." }, "derivatives_based": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Derivatives Based", "description": "This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio." }, "income_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Income Category", "description": "Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income" }, "asset_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Class", "description": "Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)." }, "other_asset_types": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Other Asset Types", "description": "If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets." }, "single_category_designation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Single Category Designation", "description": "This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market." }, "beta_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Beta Type", "description": "This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately." }, "beta_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Beta Details", "description": "This field provides further detail within the traditional and smart beta categories." }, "market_cap_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Cap Range", "description": "Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)" }, "market_cap_weighting_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Market Cap Weighting Type", "description": "For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type." }, "index_weighting_scheme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Weighting Scheme", "description": "For ETFs that track an underlying index, this field provides detail on the index weighting type." }, "index_linked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Linked", "description": "This field identifies whether an ETF is index linked or active." }, "index_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Name", "description": "This field identifies the name of the underlying index tracked by the ETF, if applicable." }, "index_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Symbol", "description": "This field identifies the OpenFIGI ticker for the Index underlying the ETF." }, "parent_index": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Index", "description": "This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable." }, "index_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Family", "description": "This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider." }, "broader_index_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Broader Index Family", "description": "This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider." }, "index_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Provider", "description": "This field identifies the Index provider for the index underlying the ETF, if applicable." }, "index_provider_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Provider Code", "description": "This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable." }, "replication_structure": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Replication Structure", "description": "The replication structure of the Exchange Traded Product (ETP)." }, "growth_value_tilt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Growth Value Tilt", "description": "Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'." }, "growth_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Growth Type", "description": "For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores." }, "value_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value Type", "description": "For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores." }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector", "description": "For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to." }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry", "description": "For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to." }, "industry_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry Group", "description": "For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to." }, "cross_sector_theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cross Sector Theme", "description": "For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)" }, "natural_resources_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Natural Resources Type", "description": "For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure." }, "us_or_excludes_us": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Us Or Excludes Us", "description": "Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US." }, "developed_emerging": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Developed Emerging", "description": "This field identifies the stage of development of the markets that the ETF provides exposure to." }, "specialized_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Specialized Region", "description": "This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)" }, "continent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Continent", "description": "This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent." }, "latin_america_sub_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latin America Sub Group", "description": "For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure." }, "europe_sub_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Europe Sub Group", "description": "For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure." }, "asia_sub_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asia Sub Group", "description": "For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure." }, "specific_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Specific Country", "description": "This field is populated if the ETF provides targeted exposure to a specific country." }, "china_listing_location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "China Listing Location", "description": "For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities." }, "us_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Us State", "description": "Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies." }, "real_estate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Real Estate", "description": "For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market." }, "fundamental_weighting_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fundamental Weighting Type", "description": "For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology." }, "dividend_weighting_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dividend Weighting Type", "description": "For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology." }, "bond_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bond Type", "description": "For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF." }, "government_bond_types": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Government Bond Types", "description": "For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure." }, "municipal_bond_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Municipal Bond Region", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure." }, "municipal_vrdo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Municipal Vrdo", "description": "For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations." }, "mortgage_bond_types": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mortgage Bond Types", "description": "For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities." }, "bond_tax_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bond Tax Status", "description": "For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities." }, "credit_quality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credit Quality", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range." }, "average_maturity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Average Maturity", "description": "For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range." }, "specific_maturity_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Specific Maturity Year", "description": "For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year." }, "commodity_types": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commodity Types", "description": "For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF." }, "energy_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Energy Type", "description": "For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF." }, "agricultural_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agricultural Type", "description": "For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF." }, "livestock_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Livestock Type", "description": "For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF." }, "metal_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metal Type", "description": "For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF." }, "inverse_leveraged": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Inverse Leveraged", "description": "This field is populated if the ETF provides inverse or leveraged exposure." }, "target_date_multi_asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Date Multi Asset Type", "description": "For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF." }, "currency_pair": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Pair", "description": "This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure." }, "social_environmental_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Social Environmental Type", "description": "This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme." }, "clean_energy_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Clean Energy Type", "description": "This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field." }, "dividend_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dividend Type", "description": "This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus." }, "regular_dividend_payor_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regular Dividend Payor Type", "description": "This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field." }, "quant_strategies_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quant Strategies Type", "description": "This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy." }, "other_quant_models": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Other Quant Models", "description": "For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF." }, "hedge_fund_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hedge Fund Type", "description": "For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy." }, "excludes_financials": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Excludes Financials", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective." }, "excludes_technology": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Excludes Technology", "description": "For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective." }, "holds_only_nyse_stocks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Only Nyse Stocks", "description": "If true, the ETF is an equity ETF and holds only stocks listed on NYSE." }, "holds_only_nasdaq_stocks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Only Nasdaq Stocks", "description": "If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq." }, "holds_mlp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Mlp", "description": "If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy." }, "holds_preferred_stock": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Preferred Stock", "description": "If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy." }, "holds_closed_end_funds": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Closed End Funds", "description": "If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy." }, "holds_adr": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Holds Adr", "description": "If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy." }, "laddered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Laddered", "description": "For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure." }, "zero_coupon": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Zero Coupon", "description": "For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills." }, "floating_rate": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Floating Rate", "description": "For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds." }, "build_america_bonds": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Build America Bonds", "description": "For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds." }, "dynamic_futures_roll": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dynamic Futures Roll", "description": "If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs." }, "currency_hedged": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Currency Hedged", "description": "This field is populated if the ETF's strategy involves hedging currency exposure." }, "includes_short_exposure": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Includes Short Exposure", "description": "This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF." }, "ucits": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ucits", "description": "If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant" }, "registered_countries": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registered Countries", "description": "The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe." }, "issuer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Country", "description": "2 letter ISO country code for the country where the issuer is located." }, "domicile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domicile", "description": "2 letter ISO country code for the country where the ETP is domiciled." }, "listing_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Listing Country Code", "description": "2 letter ISO country code for the country of the primary listing." }, "listing_region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Listing Region", "description": "Geographic region in the country of the primary listing falls." }, "bond_currency_denomination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bond Currency Denomination", "description": "For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities." }, "base_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Currency", "description": "Base currency in which NAV is reported." }, "listing_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Listing Currency", "description": "Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code." }, "number_of_holdings": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Holdings", "description": "The number of holdings in the ETF." }, "month_end_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Month End Assets", "description": "Net assets in millions of dollars as of the most recent month end." }, "net_expense_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Expense Ratio", "description": "Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "etf_portfolio_turnover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Etf Portfolio Turnover", "description": "The percentage of positions turned over in the last 12 months.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" } }, "additionalProperties": true, "type": "object", "required": [ "symbol", "name", "inception_date" ], "title": "IntrinioEtfInfoData", "description": "Intrinio ETF Info Data." }, "IntrinioEtfPricePerformanceData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "one_day": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Day", "description": "One-day return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "wtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Wtd", "description": "Week to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_week": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Week", "description": "One-week return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "mtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mtd", "description": "Month to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Month", "description": "One-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "qtd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Qtd", "description": "Quarter to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "three_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Three Month", "description": "Three-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "six_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Six Month", "description": "Six-month return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ytd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ytd", "description": "Year to date return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "one_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "One Year", "description": "One-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "two_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Two Year", "description": "Two-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "three_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Three Year", "description": "Three-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "four_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Four Year", "description": "Four-year", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "five_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Five Year", "description": "Five-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ten_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ten Year", "description": "Ten-year return.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max", "description": "Return from the beginning of the time series.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "max_annualized": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Annualized", "description": "Annualized rate of return from inception.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "volatility_one_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volatility One Year", "description": "Trailing one-year annualized volatility.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "volatility_three_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volatility Three Year", "description": "Trailing three-year annualized volatility.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "volatility_five_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volatility Five Year", "description": "Trailing five-year annualized volatility.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "volume_avg_30": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume Avg 30", "description": "The one-month average daily volume." }, "volume_avg_90": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume Avg 90", "description": "The three-month average daily volume." }, "volume_avg_180": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume Avg 180", "description": "The six-month average daily volume." }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta", "description": "Beta compared to the S&P 500." }, "nav": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Nav", "description": "Net asset value per share." }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "The 52-week high price." }, "year_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year Low", "description": "The 52-week low price." }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "The market capitalization." }, "shares_outstanding": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Outstanding", "description": "The number of shares outstanding." }, "updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Updated", "description": "The date of the data." } }, "additionalProperties": true, "type": "object", "title": "IntrinioEtfPricePerformanceData", "description": "Intrinio ETF Performance Data." }, "IntrinioEtfSearchData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data.(ETF)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the ETF." }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange", "description": "The exchange MIC code." }, "figi_ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Figi Ticker", "description": "The OpenFIGI ticker." }, "ric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ric", "description": "The Reuters Instrument Code." }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin", "description": "The International Securities Identification Number." }, "sedol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sedol", "description": "The Stock Exchange Daily Official List." }, "intrinio_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intrinio Id", "description": "The unique Intrinio ID for the security." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "IntrinioEtfSearchData", "description": "Intrinio ETF Search Data." }, "IntrinioFinancialRatiosData": { "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." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the entity." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Last Updated", "description": "The date of the last update." }, "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": "Fiscal year for the estimate." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "Fiscal quarter for the estimate." }, "calendar_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calendar Year", "description": "Calendar year for the estimate." }, "calendar_period": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Calendar Period", "description": "Calendar quarter for the estimate." }, "low_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Low Estimate", "description": "The EBITDA estimate low for the period." }, "high_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "High Estimate", "description": "The EBITDA estimate high for the period." }, "mean": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mean", "description": "The EBITDA estimate mean for the period." }, "median": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Median", "description": "The EBITDA estimate median for the period." }, "standard_deviation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Standard Deviation", "description": "The EBITDA estimate standard deviation for the period." }, "number_of_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Analysts", "description": "Number of analysts providing estimates for the period." }, "conensus_type": { "anyOf": [ { "type": "string", "enum": [ "ebitda", "ebit", "enterprise_value", "cash_flow_per_share", "pretax_income" ] }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the entity." }, "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Fiscal year for the estimate." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "Fiscal quarter for the estimate." }, "calendar_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calendar Year", "description": "Calendar year for the estimate." }, "calendar_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Period", "description": "Calendar quarter for the estimate." }, "low_estimate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low Estimate", "description": "Estimated EPS low for the period." }, "high_estimate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High Estimate", "description": "Estimated EPS high for the period." }, "mean": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mean", "description": "Estimated EPS mean for the period." }, "median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Median", "description": "Estimated EPS median for the period." }, "standard_deviation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Standard Deviation", "description": "Estimated EPS standard deviation for the period." }, "number_of_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Analysts", "description": "Number of analysts providing estimates for the period." }, "revisions_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "mean_1w": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mean 1W", "description": "The mean estimate for the period one week ago." }, "mean_1m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mean 1M", "description": "The mean estimate for the period one month ago." }, "mean_2m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mean 2M", "description": "The mean estimate for the period two months ago." }, "mean_3m": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the entity." }, "year_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 1", "description": "Estimated PE ratio for the next fiscal year." }, "year_2": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 2", "description": "Estimated PE ratio two fiscal years from now." }, "year_3": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 3", "description": "Estimated PE ratio three fiscal years from now." }, "year_4": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 4", "description": "Estimated PE ratio four fiscal years from now." }, "year_5": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year 5", "description": "Estimated PE ratio five fiscal years from now." }, "peg_ratio_year_1": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Peg Ratio Year 1", "description": "Estimated Forward PEG ratio for the next fiscal year." }, "eps_ttm": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Ttm", "description": "The latest trailing twelve months earnings per share." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "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." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the entity." }, "date": { "type": "string", "format": "date", "title": "Date", "description": "The date of the data." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year", "description": "Fiscal year for the estimate." }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period", "description": "Fiscal quarter for the estimate." }, "calendar_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calendar Year", "description": "Calendar year for the estimate." }, "calendar_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Calendar Period", "description": "Calendar quarter for the estimate." }, "low_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Low Estimate", "description": "The sales estimate low for the period." }, "high_estimate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "High Estimate", "description": "The sales estimate high for the period." }, "mean": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mean", "description": "The sales estimate mean for the period." }, "median": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Median", "description": "The sales estimate median for the period." }, "standard_deviation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Standard Deviation", "description": "The sales estimate standard deviation for the period." }, "number_of_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Analysts", "description": "Number of analysts providing estimates for the period." }, "revisions_1w_up": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 1W Up", "description": "Number of revisions up in the last week." }, "revisions_1w_down": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 1W Down", "description": "Number of revisions down in the last week." }, "revisions_1w_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "revisions_1m_up": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 1M Up", "description": "Number of revisions up in the last month." }, "revisions_1m_down": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 1M Down", "description": "Number of revisions down in the last month." }, "revisions_1m_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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" }, "revisions_3m_up": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 3M Up", "description": "Number of revisions up in the last 3 months." }, "revisions_3m_down": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revisions 3M Down", "description": "Number of revisions down in the last 3 months." }, "revisions_3m_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "The value of the data." } }, "additionalProperties": true, "type": "object", "required": [ "date", "symbol" ], "title": "IntrinioHistoricalAttributesData", "description": "Intrinio Historical Attributes Data." }, "IntrinioHistoricalDividendsData": { "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." }, "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" }, { "type": "null" } ], "title": "Currency", "description": "The currency in which the dividend is paid." }, "split_ratio": { "anyOf": [ { "type": "number" }, { "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": "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." }, "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." }, "reported_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reported Currency", "description": "The currency in which the balance sheet is reported." }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue", "description": "Total revenue" }, "operating_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Revenue", "description": "Total operating revenue" }, "cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue", "description": "Total cost of revenue" }, "operating_cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cost Of Revenue", "description": "Total operating cost of revenue" }, "gross_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit", "description": "Total gross profit" }, "gross_profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit Margin", "description": "Gross margin ratio." }, "provision_for_credit_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Provision For Credit Losses", "description": "Provision for credit losses" }, "research_and_development_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development Expense", "description": "Research and development expense" }, "selling_general_and_admin_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Selling General And Admin Expense", "description": "Selling, general, and admin expense" }, "salaries_and_employee_benefits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Salaries And Employee Benefits", "description": "Salaries and employee benefits" }, "marketing_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Marketing Expense", "description": "Marketing expense" }, "net_occupancy_and_equipment_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Occupancy And Equipment Expense", "description": "Net occupancy and equipment expense" }, "other_operating_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Operating Expenses", "description": "Other operating expenses" }, "depreciation_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation Expense", "description": "Depreciation expense" }, "amortization_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amortization Expense", "description": "Amortization expense" }, "amortization_of_deferred_policy_acquisition_costs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amortization Of Deferred Policy Acquisition Costs", "description": "Amortization of deferred policy acquisition costs" }, "exploration_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Exploration Expense", "description": "Exploration expense" }, "depletion_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depletion Expense", "description": "Depletion expense" }, "total_operating_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Operating Expenses", "description": "Total operating expenses" }, "total_operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Operating Income", "description": "Total operating income" }, "deposits_and_money_market_investments_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Deposits And Money Market Investments Interest Income", "description": "Deposits and money market investments interest income" }, "federal_funds_sold_and_securities_borrowed_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Federal Funds Sold And Securities Borrowed Interest Income", "description": "Federal funds sold and securities borrowed interest income" }, "investment_securities_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Investment Securities Interest Income", "description": "Investment securities interest income" }, "loans_and_leases_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loans And Leases Interest Income", "description": "Loans and leases interest income" }, "trading_account_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Trading Account Interest Income", "description": "Trading account interest income" }, "other_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Interest Income", "description": "Other interest income" }, "total_non_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Non Interest Income", "description": "Total non-interest income" }, "interest_and_investment_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest And Investment Income", "description": "Interest and investment income" }, "short_term_borrowings_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Short Term Borrowings Interest Expense", "description": "Short-term borrowings interest expense" }, "long_term_debt_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Debt Interest Expense", "description": "Long-term debt interest expense" }, "capitalized_lease_obligations_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capitalized Lease Obligations Interest Expense", "description": "Capitalized lease obligations interest expense" }, "deposits_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Deposits Interest Expense", "description": "Deposits interest expense" }, "federal_funds_purchased_and_securities_sold_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Federal Funds Purchased And Securities Sold Interest Expense", "description": "Federal funds purchased and securities sold interest expense" }, "other_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Interest Expense", "description": "Other interest expense" }, "total_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Interest Expense", "description": "Total interest expense" }, "net_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Interest Income", "description": "Net interest income" }, "other_non_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Non Interest Income", "description": "Other non-interest income" }, "investment_banking_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Investment Banking Income", "description": "Investment banking income" }, "trust_fees_by_commissions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Trust Fees By Commissions", "description": "Trust fees by commissions" }, "premiums_earned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Premiums Earned", "description": "Premiums earned" }, "insurance_policy_acquisition_costs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Insurance Policy Acquisition Costs", "description": "Insurance policy acquisition costs" }, "current_and_future_benefits": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current And Future Benefits", "description": "Current and future benefits" }, "property_and_liability_insurance_claims": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Property And Liability Insurance Claims", "description": "Property and liability insurance claims" }, "total_non_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Non Interest Expense", "description": "Total non-interest expense" }, "net_realized_and_unrealized_capital_gains_on_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Realized And Unrealized Capital Gains On Investments", "description": "Net realized and unrealized capital gains on investments" }, "other_gains": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Gains", "description": "Other gains" }, "non_operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Operating Income", "description": "Non-operating income" }, "other_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Income", "description": "Other income" }, "other_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Revenue", "description": "Other revenue" }, "extraordinary_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Extraordinary Income", "description": "Extraordinary income" }, "total_other_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Other Income", "description": "Total other income" }, "ebitda": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda", "description": "Earnings Before Interest, Taxes, Depreciation and Amortization." }, "ebitda_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda Margin", "description": "Margin on Earnings Before Interest, Taxes, Depreciation and Amortization." }, "total_pre_tax_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pre Tax Income", "description": "Total pre-tax income" }, "ebit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit", "description": "Earnings Before Interest and Taxes." }, "pre_tax_income_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pre Tax Income Margin", "description": "Pre-Tax Income Margin." }, "income_tax_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Tax Expense", "description": "Income tax expense" }, "impairment_charge": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Impairment Charge", "description": "Impairment charge" }, "restructuring_charge": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Restructuring Charge", "description": "Restructuring charge" }, "service_charges_on_deposit_accounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Service Charges On Deposit Accounts", "description": "Service charges on deposit accounts" }, "other_service_charges": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Service Charges", "description": "Other service charges" }, "other_special_charges": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Special Charges", "description": "Other special charges" }, "other_cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Cost Of Revenue", "description": "Other cost of revenue" }, "net_income_continuing_operations": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Continuing Operations", "description": "Net income (continuing operations)" }, "net_income_discontinued_operations": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Discontinued Operations", "description": "Net income (discontinued operations)" }, "consolidated_net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Consolidated Net Income", "description": "Consolidated net income" }, "other_adjustments_to_consolidated_net_income": { "anyOf": [ { "type": "number" }, { "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": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Adjustment To Net Income Attributable To Common Shareholders", "description": "Other adjustment to net income attributable to common shareholders" }, "net_income_attributable_to_noncontrolling_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Attributable To Noncontrolling Interest", "description": "Net income attributable to noncontrolling interest" }, "net_income_attributable_to_common_shareholders": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Attributable To Common Shareholders", "description": "Net income attributable to common shareholders" }, "basic_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Basic Earnings Per Share", "description": "Basic earnings per share" }, "diluted_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diluted Earnings Per Share", "description": "Diluted earnings per share" }, "basic_and_diluted_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Basic And Diluted Earnings Per Share", "description": "Basic and diluted earnings per share" }, "cash_dividends_to_common_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Dividends To Common Per Share", "description": "Cash dividends to common per share" }, "preferred_stock_dividends_declared": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Preferred Stock Dividends Declared", "description": "Preferred stock dividends declared" }, "weighted_average_basic_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Basic Shares Outstanding", "description": "Weighted average basic shares outstanding" }, "weighted_average_diluted_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Diluted Shares Outstanding", "description": "Weighted average diluted shares outstanding" }, "weighted_average_basic_and_diluted_shares_outstanding": { "anyOf": [ { "type": "number" }, { "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": "IntrinioIncomeStatementData", "description": "Intrinio Income Statement Data." }, "IntrinioIndexHistoricalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." } }, "additionalProperties": true, "type": "object", "required": [ "date" ], "title": "IntrinioIndexHistoricalData", "description": "Intrinio Index Historical Data." }, "IntrinioInsiderTradingData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "company_cik": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Company Cik", "description": "CIK number of the company." }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Date", "description": "Filing date of the trade." }, "transaction_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Transaction Date", "description": "Date of the transaction." }, "owner_cik": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "title": "Owner Cik", "description": "Reporting individual's CIK." }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name", "description": "Name of the reporting individual." }, "owner_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Title", "description": "The title held by the reporting individual." }, "transaction_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Type", "description": "Type of transaction being reported." }, "acquisition_or_disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acquisition Or Disposition", "description": "Acquisition or disposition of the shares." }, "security_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Security Type", "description": "The type of security transacted." }, "securities_owned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Securities Owned", "description": "Number of securities owned by the reporting individual." }, "securities_transacted": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Securities Transacted", "description": "Number of securities transacted by the reporting individual." }, "transaction_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Transaction Price", "description": "The price of the transaction." }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url", "description": "URL of the filing." }, "company_name": { "type": "string", "title": "Company Name", "description": "Name of the company." }, "conversion_exercise_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Conversion Exercise Price", "description": "Conversion/Exercise price of the shares." }, "deemed_execution_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Deemed Execution Date", "description": "Deemed execution date of the trade." }, "exercise_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Exercise Date", "description": "Exercise date of the trade." }, "expiration_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Expiration Date", "description": "Expiration date of the derivative." }, "underlying_security_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Underlying Security Title", "description": "Name of the underlying non-derivative security related to this derivative transaction." }, "underlying_shares": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Underlying Shares", "description": "Number of underlying shares related to this derivative transaction." }, "nature_of_ownership": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nature Of Ownership", "description": "Nature of ownership of the insider trading." }, "director": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Director", "description": "Whether the owner is a director." }, "officer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Officer", "description": "Whether the owner is an officer." }, "ten_percent_owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ten Percent Owner", "description": "Whether the owner is a 10% owner." }, "other_relation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Other Relation", "description": "Whether the owner is having another relation." }, "derivative_transaction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Derivative Transaction", "description": "Whether the owner is having a derivative transaction." }, "report_line_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Market Cap", "description": "Market capitalization" }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pe Ratio", "description": "Price-to-earnings ratio (P/E ratio)" }, "price_to_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Book", "description": "Price to book ratio." }, "price_to_tangible_book": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Tangible Book", "description": "Price to tangible book ratio." }, "price_to_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price To Revenue", "description": "Price to revenue ratio." }, "quick_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quick Ratio", "description": "Quick ratio." }, "gross_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Margin", "description": "Gross margin, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ebit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit Margin", "description": "EBIT margin, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "profit_margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Profit Margin", "description": "Profit margin, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "eps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps", "description": "Basic earnings per share." }, "eps_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Eps Growth", "description": "EPS growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "revenue_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue Growth", "description": "Revenue growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ebitda_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebitda Growth", "description": "EBITDA growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ebit_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ebit Growth", "description": "EBIT growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "net_income_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Growth", "description": "Net income growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "free_cash_flow_to_firm_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Cash Flow To Firm Growth", "description": "Free cash flow to firm growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "invested_capital_growth": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Invested Capital Growth", "description": "Invested capital growth, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Assets", "description": "Return on assets, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Equity", "description": "Return on equity, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "return_on_invested_capital": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Return On Invested Capital", "description": "Return on invested capital, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "ebitda": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ebitda", "description": "Earnings before interest, taxes, depreciation, and amortization." }, "ebit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ebit", "description": "Earnings before interest and taxes." }, "long_term_debt": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Long Term Debt", "description": "Long-term debt." }, "total_debt": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Debt", "description": "Total debt." }, "total_capital": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Capital", "description": "The sum of long-term debt and total shareholder equity." }, "enterprise_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Enterprise Value", "description": "Enterprise value." }, "free_cash_flow_to_firm": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Free Cash Flow To Firm", "description": "Free cash flow to firm." }, "altman_z_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Altman Z Score", "description": "Altman Z-score." }, "beta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Beta", "description": "Beta relative to the broad market (rolling three-year)." }, "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" }, "earnings_yield": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Yield", "description": "Earnings yield, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "last_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Price", "description": "Last price of the stock." }, "year_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Year High", "description": "52 week high" }, "year_low": { "type": "number", "title": "Year Low", "description": "52 week low" }, "volume_avg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume Avg", "description": "Average daily volume." }, "short_interest": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Short Interest", "description": "Number of shares reported as sold short." }, "shares_outstanding": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares Outstanding", "description": "Weighted average shares outstanding (TTM)." }, "days_to_cover": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Days To Cover", "description": "Days to cover short interest, based on average daily volume." } }, "additionalProperties": true, "type": "object", "title": "IntrinioKeyMetricsData", "description": "Intrinio Key Metrics Data." }, "IntrinioLatestAttributesData": { "properties": { "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." }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "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." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in price from the previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "The change in price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "last_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Price", "description": "The last trade price." }, "last_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Size", "description": "The last trade size." }, "last_volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Volume", "description": "The last trade volume." }, "last_trade_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Trade Timestamp", "description": "The timestamp of the last trade." }, "bid_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bid Size", "description": "The size of the last bid price. Bid price and size is not always available." }, "bid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid Price", "description": "The last bid price. Bid price and size is not always available." }, "ask_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask Price", "description": "The last ask price. Ask price and size is not always available." }, "ask_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ask Size", "description": "The size of the last ask price. Ask price and size is not always available." }, "last_bid_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Bid Timestamp", "description": "The timestamp of the last bid price. Bid price and size is not always available." }, "last_ask_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Ask Timestamp", "description": "The timestamp of the last ask price. Ask price and size is not always available." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "IntrinioMarketSnapshotsData", "description": "Intrinio Market Snapshots Data." }, "IntrinioOptionsChainsData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "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." }, "eod_date": { "anyOf": [ { "type": "string", "format": "date" }, { "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." }, "open_interest": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Open Interest", "description": "Open interest on the contract." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "theoretical_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Theoretical Price", "description": "Theoretical value of the option." }, "last_trade_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Trade Price", "description": "Last trade price of the option." }, "tick": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tick", "description": "Whether the last tick was up or down in price." }, "bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid", "description": "Current bid price for the option." }, "bid_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bid Size", "description": "Bid size for the option." }, "ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask", "description": "Current ask price for the option." }, "ask_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ask Size", "description": "Ask size for the option." }, "mark": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Mark", "description": "The mid-price between the latest bid and ask." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "open_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open Bid", "description": "The opening bid price for the option that day." }, "open_ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open Ask", "description": "The opening ask price for the option that day." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "bid_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid High", "description": "The highest bid price for the option that day." }, "ask_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask High", "description": "The highest ask price for the option that day." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "bid_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid Low", "description": "The lowest bid price for the option that day." }, "ask_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask Low", "description": "The lowest ask price for the option that day." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "close_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Close Size", "description": "The closing trade size for the option that day." }, "close_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Close Time", "description": "The time of the closing price for the option that day." }, "close_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close Bid", "description": "The closing bid price for the option that day." }, "close_bid_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Close Bid Size", "description": "The closing bid size for the option that day." }, "close_bid_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Close Bid Time", "description": "The time of the bid closing price for the option that day." }, "close_ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close Ask", "description": "The closing ask price for the option that day." }, "close_ask_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Close Ask Size", "description": "The closing ask size for the option that day." }, "close_ask_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Close Ask Time", "description": "The time of the ask closing price for the option that day." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in the price of the option." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "Change, in normalizezd percentage points, of the option." }, "implied_volatility": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Implied Volatility", "description": "Implied volatility of the option." }, "delta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Delta", "description": "Delta of the option." }, "gamma": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gamma", "description": "Gamma of the option." }, "theta": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Theta", "description": "Theta of the option." }, "vega": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vega", "description": "Vega of the option." }, "rho": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rho", "description": "Rho of the option." }, "exercise_style": { "anyOf": [ { "type": "string" }, { "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": "IntrinioOptionsChainsData", "description": "Intrinio Options Chains Data." }, "IntrinioOptionsUnusualData": { "properties": { "underlying_symbol": { "anyOf": [ { "type": "string" }, { "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." }, "sentiment": { "type": "string", "enum": [ "bullish", "bearish", "neutral" ], "title": "Sentiment", "description": "Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price." }, "bid_at_execution": { "type": "number", "title": "Bid At Execution", "description": "Bid price at execution." }, "ask_at_execution": { "type": "number", "title": "Ask At Execution", "description": "Ask price at execution." }, "average_price": { "type": "number", "title": "Average Price", "description": "The average premium paid per option contract." }, "underlying_price_at_execution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Underlying Price At Execution", "description": "Price of the underlying security at execution of trade." }, "total_size": { "type": "integer", "title": "Total Size", "description": "The total number of contracts involved in a single transaction." }, "total_value": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "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": "IntrinioOptionsUnusualData", "description": "Intrinio Unusual Options Data." }, "IntrinioPriceTargetConsensusData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The company name" }, "target_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target High", "description": "High target of the price target consensus." }, "target_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Low", "description": "Low target of the price target consensus." }, "target_consensus": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Consensus", "description": "Consensus target of the price target consensus." }, "target_median": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Target Median", "description": "Median target of the price target consensus." }, "standard_deviation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Standard Deviation", "description": "The standard deviation of target price estimates." }, "total_analysts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Analysts", "description": "The total number of target price estimates in consensus." }, "raised": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Raised", "description": "The number of analysts that have raised their target price estimates." }, "lowered": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Lowered", "description": "The number of analysts that have lowered their target price estimates." }, "most_recent_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Most Recent Date", "description": "The date of the most recent estimate." }, "industry_group_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "fiscal_period": { "type": "string", "title": "Fiscal Period", "description": "The fiscal period of the report (e.g. FY, Q1, etc.)." }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "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." }, "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": "string" }, { "type": "null" } ], "title": "Statement Type", "description": "Type of the financial statement." }, "parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Name", "description": "Parent's name of the financial attribute." }, "sequence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sequence", "description": "Sequence of the financial statement." }, "factor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Factor", "description": "Unit of the financial attribute." }, "transaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction", "description": "Transaction type (credit/debit) of the financial attribute." }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Type of the financial attribute." }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Id", "description": "The Intrinio ID for the company for which the Security is issued." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the Security." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "\n A 2-3 digit code classifying the Security.\n Reference: https://docs.intrinio.com/documentation/security_codes\n " }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "The currency in which the Security is traded." }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker", "description": "The common/local ticker of the Security." }, "composite_ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Composite Ticker", "description": "The country-composite ticker of the Security." }, "figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Figi", "description": "The OpenFIGI identifier." }, "composite_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Composite Figi", "description": "The country-composite OpenFIGI identifier." }, "share_class_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Share Class Figi", "description": "The global-composite OpenFIGI identifier." }, "primary_listing": { "anyOf": [ { "type": "boolean" }, { "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 " } }, "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." }, "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "free_float": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Free Float", "description": "Percentage of unrestricted shares of a publicly-traded company." }, "float_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Float Shares", "description": "Number of shares available for trading by the general public." }, "outstanding_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Outstanding Shares", "description": "Total number of shares of a publicly-traded company." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "Source of the received data." }, "adjweightedavebasicdilutedsharesos": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adjweightedavebasicdilutedsharesos", "description": "Total number of shares of a publicly-traded company, adjusted for splits." }, "public_float": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "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." }, "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." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The source of the news article." }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary", "description": "The summary of the news article." }, "topics": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topics", "description": "The topics related to the news article." }, "word_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Word Count", "description": "The word count of the news article." }, "business_relevance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Business Relevance", "description": " \tHow strongly correlated the news article is to the business" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sentiment", "description": "The sentiment of the news article - i.e, negative, positive." }, "sentiment_confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Sentiment Confidence", "description": "The confidence score of the sentiment rating." }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "The language of the news article." }, "spam": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Spam", "description": "Whether the news article is spam." }, "copyright": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Copyright", "description": "The copyright notice of the news article." }, "id": { "type": "string", "title": "Id", "description": "Article ID." }, "company": { "anyOf": [ { "$ref": "#/components/schemas/IntrinioCompany" }, { "type": "null" } ], "description": "The Intrinio Company object. Contains details company reference data." }, "security": { "anyOf": [ { "$ref": "#/components/schemas/IntrinioSecurity" }, { "type": "null" } ], "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." }, "forecast": { "type": "number", "title": "Forecast", "description": "Forecast value." }, "levels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/NixtlaTimegenLevelData" }, "type": "array" }, { "type": "null" } ], "title": "Levels", "description": "Prediction intervals." } }, "additionalProperties": true, "type": "object", "required": [ "date", "forecast" ], "title": "NixtlaTimegenData", "description": "Nixtla Timegen Data." }, "NixtlaTimegenLevelData": { "properties": { "level": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Level", "description": "Level." }, "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" }, { "type": "null" } ], "title": "Freq", "description": "Frequency of the data. H: hourly, D: daily, W: weekly, M: monthly, Q: quarterly, Y: yearly.", "default": "D" }, "fh": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fh", "description": "Forecast horizon.", "default": 7 }, "y": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, "type": "object" }, { "type": "null" } ], "title": "Y", "description": "Time series data." }, "level": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "array" }, { "type": "null" } ], "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." }, "clean_ex_first": { "type": "boolean", "title": "Clean Ex First", "description": "Clean the first example.", "default": true }, "finetune_steps": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Finetune Steps", "description": "Number of finetune steps.", "default": 0 }, "finetune_loss": { "anyOf": [ { "type": "string", "enum": [ "default", "mae", "mse", "rmse", "mape", "smape" ] }, { "type": "null" } ], "title": "Finetune Loss", "description": "Finetune loss.", "default": "default" }, "model": { "anyOf": [ { "type": "string", "enum": [ "timegpt-1", "timegpt-1-long-horizon", "short-horizon", "long-horizon", "azureai" ] }, { "type": "null" } ], "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" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDAMERIBORData" }, "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_AMERIBOR", "description": "OBBject with results of type AMERIBOR" }, "OBBject_AnalystEstimates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPAnalystEstimatesData" }, "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_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" }, { "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_AnalystSearch", "description": "OBBject with results of type AnalystSearch" }, "OBBject_AvailableIndicators": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EconDbAvailableIndicatorsData" }, "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_AvailableIndicators", "description": "OBBject with results of type AvailableIndicators" }, "OBBject_AvailableIndices": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPAvailableIndicesData" }, "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_AvailableIndices", "description": "OBBject with results of type AvailableIndices" }, "OBBject_BalanceOfPayments": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/ECBBalanceOfPaymentsData" }, { "$ref": "#/components/schemas/FredBalanceOfPaymentsData" } ] }, "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_BalanceOfPayments", "description": "OBBject with results of type BalanceOfPayments" }, "OBBject_BalanceSheet": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/PolygonBalanceSheetData" }, { "$ref": "#/components/schemas/IntrinioBalanceSheetData" }, { "$ref": "#/components/schemas/FMPBalanceSheetData" } ] }, "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_BalanceSheet", "description": "OBBject with results of type BalanceSheet" }, "OBBject_BalanceSheetGrowth": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPBalanceSheetGrowthData" }, "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_BalanceSheetGrowth", "description": "OBBject with results of type BalanceSheetGrowth" }, "OBBject_CLI": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDCLIData" }, "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_CLI", "description": "OBBject with results of type CLI" }, "OBBject_CalendarDividend": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPCalendarDividendData" }, "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_CalendarDividend", "description": "OBBject with results of type CalendarDividend" }, "OBBject_CalendarEarnings": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPCalendarEarningsData" }, "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_CalendarEarnings", "description": "OBBject with results of type CalendarEarnings" }, "OBBject_CalendarIpo": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioCalendarIpoData" }, "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_CalendarIpo", "description": "OBBject with results of type CalendarIpo" }, "OBBject_CalendarSplits": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPCalendarSplitsData" }, "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_CalendarSplits", "description": "OBBject with results of type CalendarSplits" }, "OBBject_CashFlowStatement": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPCashFlowStatementData" }, { "$ref": "#/components/schemas/PolygonCashFlowStatementData" }, { "$ref": "#/components/schemas/IntrinioCashFlowStatementData" } ] }, "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_CashFlowStatement", "description": "OBBject with results of type CashFlowStatement" }, "OBBject_CashFlowStatementGrowth": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPCashFlowStatementGrowthData" }, "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_CashFlowStatementGrowth", "description": "OBBject with results of type CashFlowStatementGrowth" }, "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": { "$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" }, { "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_CommercialPaper", "description": "OBBject with results of type CommercialPaper" }, "OBBject_CompanyFilings": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioCompanyFilingsData" }, { "$ref": "#/components/schemas/FMPCompanyFilingsData" }, { "$ref": "#/components/schemas/SecCompanyFilingsData" } ] }, "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_CompanyFilings", "description": "OBBject with results of type CompanyFilings" }, "OBBject_CompanyNews": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPCompanyNewsData" }, { "$ref": "#/components/schemas/PolygonCompanyNewsData" }, { "$ref": "#/components/schemas/BenzingaCompanyNewsData" }, { "$ref": "#/components/schemas/IntrinioCompanyNewsData" } ] }, "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_CompanyNews", "description": "OBBject with results of type CompanyNews" }, "OBBject_CompanyOverview": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "$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." }, "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_CompareCompanyFacts", "description": "OBBject with results of type CompareCompanyFacts" }, "OBBject_ConsumerPriceIndex": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDConsumerPriceIndexData" }, "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_ConsumerPriceIndex", "description": "OBBject with results of type ConsumerPriceIndex" }, "OBBject_CountryProfile": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EconDbCountryProfileData" }, "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_CountryProfile", "description": "OBBject with results of type CountryProfile" }, "OBBject_CryptoHistorical": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPCryptoHistoricalData" }, { "$ref": "#/components/schemas/PolygonCryptoHistoricalData" } ] }, "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_CryptoHistorical", "description": "OBBject with results of type CryptoHistorical" }, "OBBject_CryptoSearch": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPCryptoSearchData" }, "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_CryptoSearch", "description": "OBBject with results of type CryptoSearch" }, "OBBject_CurrencyHistorical": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPCurrencyHistoricalData" }, { "$ref": "#/components/schemas/PolygonCurrencyHistoricalData" } ] }, "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_CurrencyHistorical", "description": "OBBject with results of type CurrencyHistorical" }, "OBBject_CurrencyPairs": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/PolygonCurrencyPairsData" }, { "$ref": "#/components/schemas/IntrinioCurrencyPairsData" }, { "$ref": "#/components/schemas/FMPCurrencyPairsData" } ] }, "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_CurrencyPairs", "description": "OBBject with results of type CurrencyPairs" }, "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", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/PolygonCurrencySnapshotsData" }, { "$ref": "#/components/schemas/FMPCurrencySnapshotsData" } ] }, "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_CurrencySnapshots", "description": "OBBject with results of type CurrencySnapshots" }, "OBBject_DiscountWindowPrimaryCreditRate": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDDiscountWindowPrimaryCreditRateData" }, "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_DiscountWindowPrimaryCreditRate", "description": "OBBject with results of type DiscountWindowPrimaryCreditRate" }, "OBBject_DiscoveryFilings": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPDiscoveryFilingsData" }, "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_DiscoveryFilings", "description": "OBBject with results of type DiscoveryFilings" }, "OBBject_ESTR": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDESTRData" }, "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_ESTR", "description": "OBBject with results of type ESTR" }, "OBBject_EUYieldCurve": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ECBEUYieldCurveData" }, "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_EUYieldCurve", "description": "OBBject with results of type EUYieldCurve" }, "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", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPEconomicCalendarData" }, { "$ref": "#/components/schemas/TEEconomicCalendarData" } ] }, "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_EconomicCalendar", "description": "OBBject with results of type EconomicCalendar" }, "OBBject_EconomicIndicators": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EconDbEconomicIndicatorsData" }, "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_EconomicIndicators", "description": "OBBject with results of type EconomicIndicators" }, "OBBject_EquityFTD": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SecEquityFtdData" }, "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_EquityFTD", "description": "OBBject with results of type EquityFTD" }, "OBBject_EquityHistorical": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioEquityHistoricalData" }, { "$ref": "#/components/schemas/FMPEquityHistoricalData" }, { "$ref": "#/components/schemas/PolygonEquityHistoricalData" } ] }, "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_EquityHistorical", "description": "OBBject with results of type EquityHistorical" }, "OBBject_EquityInfo": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioEquityInfoData" }, { "$ref": "#/components/schemas/FMPEquityProfileData" } ] }, "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_EquityInfo", "description": "OBBject with results of type EquityInfo" }, "OBBject_EquityNBBO": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PolygonEquityNBBOData" }, "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_EquityNBBO", "description": "OBBject with results of type EquityNBBO" }, "OBBject_EquityOwnership": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEquityOwnershipData" }, "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_EquityOwnership", "description": "OBBject with results of type EquityOwnership" }, "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", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPEquityQuoteData" }, { "$ref": "#/components/schemas/IntrinioEquityQuoteData" } ] }, "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_EquityQuote", "description": "OBBject with results of type EquityQuote" }, "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", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/SecEquitySearchData" }, { "$ref": "#/components/schemas/IntrinioEquitySearchData" } ] }, "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_EquitySearch", "description": "OBBject with results of type EquitySearch" }, "OBBject_EquityValuationMultiples": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEquityValuationMultiplesData" }, "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_EquityValuationMultiples", "description": "OBBject with results of type EquityValuationMultiples" }, "OBBject_EtfCountries": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEtfCountriesData" }, "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_EtfCountries", "description": "OBBject with results of type EtfCountries" }, "OBBject_EtfEquityExposure": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEtfEquityExposureData" }, "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_EtfEquityExposure", "description": "OBBject with results of type EtfEquityExposure" }, "OBBject_EtfHistorical": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioEquityHistoricalData" }, { "$ref": "#/components/schemas/FMPEquityHistoricalData" }, { "$ref": "#/components/schemas/PolygonEquityHistoricalData" } ] }, "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_EtfHistorical", "description": "OBBject with results of type EtfHistorical" }, "OBBject_EtfHoldings": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/SecEtfHoldingsData" }, { "$ref": "#/components/schemas/FMPEtfHoldingsData" }, { "$ref": "#/components/schemas/IntrinioEtfHoldingsData" } ] }, "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_EtfHoldings", "description": "OBBject with results of type EtfHoldings" }, "OBBject_EtfHoldingsDate": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEtfHoldingsDateData" }, "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_EtfHoldingsDate", "description": "OBBject with results of type EtfHoldingsDate" }, "OBBject_EtfInfo": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioEtfInfoData" }, { "$ref": "#/components/schemas/FMPEtfInfoData" } ] }, "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_EtfInfo", "description": "OBBject with results of type EtfInfo" }, "OBBject_EtfPricePerformance": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioEtfPricePerformanceData" }, { "$ref": "#/components/schemas/FMPPricePerformanceData" } ] }, "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_EtfPricePerformance", "description": "OBBject with results of type EtfPricePerformance" }, "OBBject_EtfSearch": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPEtfSearchData" }, { "$ref": "#/components/schemas/IntrinioEtfSearchData" } ] }, "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_EtfSearch", "description": "OBBject with results of type EtfSearch" }, "OBBject_EtfSectors": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPEtfSectorsData" }, "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_EtfSectors", "description": "OBBject with results of type EtfSectors" }, "OBBject_EuropeanCentralBankInterestRates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDEuropeanCentralBankInterestRatesData" }, "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_EuropeanCentralBankInterestRates", "description": "OBBject with results of type EuropeanCentralBankInterestRates" }, "OBBject_ExecutiveCompensation": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPExecutiveCompensationData" }, "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_ExecutiveCompensation", "description": "OBBject with results of type ExecutiveCompensation" }, "OBBject_FEDFUNDS": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FederalReserveFEDData" }, { "$ref": "#/components/schemas/FREDFEDData" } ] }, "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_FEDFUNDS", "description": "OBBject with results of type FEDFUNDS" }, "OBBject_FinancialRatios": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioFinancialRatiosData" }, { "$ref": "#/components/schemas/FMPFinancialRatiosData" } ] }, "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_FinancialRatios", "description": "OBBject with results of type FinancialRatios" }, "OBBject_Form13FHR": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SecForm13FHRData" }, "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_Form13FHR", "description": "OBBject with results of type Form13FHR" }, "OBBject_ForwardEbitdaEstimates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPForwardEbitdaEstimatesData" }, { "$ref": "#/components/schemas/IntrinioForwardEbitdaEstimatesData" } ] }, "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_ForwardEbitdaEstimates", "description": "OBBject with results of type ForwardEbitdaEstimates" }, "OBBject_ForwardEpsEstimates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioForwardEpsEstimatesData" }, { "$ref": "#/components/schemas/FMPForwardEpsEstimatesData" } ] }, "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_ForwardEpsEstimates", "description": "OBBject with results of type ForwardEpsEstimates" }, "OBBject_ForwardPeEstimates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioForwardPeEstimatesData" }, "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_ForwardPeEstimates", "description": "OBBject with results of type ForwardPeEstimates" }, "OBBject_ForwardSalesEstimates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioForwardSalesEstimatesData" }, "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_ForwardSalesEstimates", "description": "OBBject with results of type ForwardSalesEstimates" }, "OBBject_FredRegional": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FredRegionalData" }, "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_FredRegional", "description": "OBBject with results of type FredRegional" }, "OBBject_FredSearch": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FredSearchData" }, "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_FredSearch", "description": "OBBject with results of type FredSearch" }, "OBBject_FredSeries": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FredSeriesData" }, { "$ref": "#/components/schemas/IntrinioFredSeriesData" } ] }, "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_FredSeries", "description": "OBBject with results of type FredSeries" }, "OBBject_GdpForecast": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDGdpForecastData" }, "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_GdpForecast", "description": "OBBject with results of type GdpForecast" }, "OBBject_GdpNominal": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDGdpNominalData" }, "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_GdpNominal", "description": "OBBject with results of type GdpNominal" }, "OBBject_GdpReal": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDGdpRealData" }, "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_GdpReal", "description": "OBBject with results of type GdpReal" }, "OBBject_GroupedComparisons": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "$ref": "#/components/schemas/GroupedComparisons" }, { "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_GroupedComparisons", "description": "OBBject with results of type GroupedComparisons" }, "OBBject_GroupedFinancials": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "$ref": "#/components/schemas/GroupedFinancials" }, { "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_GroupedFinancials", "description": "OBBject with results of type GroupedFinancials" }, "OBBject_HighQualityMarketCorporateBond": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDHighQualityMarketCorporateBondData" }, "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_HighQualityMarketCorporateBond", "description": "OBBject with results of type HighQualityMarketCorporateBond" }, "OBBject_HistoricalAttributes": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioHistoricalAttributesData" }, "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_HistoricalAttributes", "description": "OBBject with results of type HistoricalAttributes" }, "OBBject_HistoricalDividends": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPHistoricalDividendsData" }, { "$ref": "#/components/schemas/IntrinioHistoricalDividendsData" } ] }, "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_HistoricalDividends", "description": "OBBject with results of type HistoricalDividends" }, "OBBject_HistoricalEmployees": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPHistoricalEmployeesData" }, "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_HistoricalEmployees", "description": "OBBject with results of type HistoricalEmployees" }, "OBBject_HistoricalEps": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPHistoricalEpsData" }, "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_HistoricalEps", "description": "OBBject with results of type HistoricalEps" }, "OBBject_HistoricalSplits": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPHistoricalSplitsData" }, "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_HistoricalSplits", "description": "OBBject with results of type HistoricalSplits" }, "OBBject_ICEBofA": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDICEBofAData" }, "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_ICEBofA", "description": "OBBject with results of type ICEBofA" }, "OBBject_IORB": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDIORBData" }, "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_IORB", "description": "OBBject with results of type IORB" }, "OBBject_IncomeStatement": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPIncomeStatementData" }, { "$ref": "#/components/schemas/PolygonIncomeStatementData" }, { "$ref": "#/components/schemas/IntrinioIncomeStatementData" } ] }, "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_IncomeStatement", "description": "OBBject with results of type IncomeStatement" }, "OBBject_IncomeStatementGrowth": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPIncomeStatementGrowthData" }, "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_IncomeStatementGrowth", "description": "OBBject with results of type IncomeStatementGrowth" }, "OBBject_IndexConstituents": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPIndexConstituentsData" }, "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_IndexConstituents", "description": "OBBject with results of type IndexConstituents" }, "OBBject_IndexHistorical": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPIndexHistoricalData" }, { "$ref": "#/components/schemas/PolygonIndexHistoricalData" }, { "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } ] }, "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_IndexHistorical", "description": "OBBject with results of type IndexHistorical" }, "OBBject_InsiderTrading": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioInsiderTradingData" }, { "$ref": "#/components/schemas/FMPInsiderTradingData" } ] }, "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_InsiderTrading", "description": "OBBject with results of type InsiderTrading" }, "OBBject_InstitutionalOwnership": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPInstitutionalOwnershipData" }, "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_InstitutionalOwnership", "description": "OBBject with results of type InstitutionalOwnership" }, "OBBject_InstitutionsSearch": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SecInstitutionsSearchData" }, "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_InstitutionsSearch", "description": "OBBject with results of type InstitutionsSearch" }, "OBBject_KeyExecutives": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPKeyExecutivesData" }, "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_KeyExecutives", "description": "OBBject with results of type KeyExecutives" }, "OBBject_KeyMetrics": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioKeyMetricsData" }, { "$ref": "#/components/schemas/FMPKeyMetricsData" } ] }, "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_KeyMetrics", "description": "OBBject with results of type KeyMetrics" }, "OBBject_LTIR": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDLTIRData" }, "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_LTIR", "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", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPIndexHistoricalData" }, { "$ref": "#/components/schemas/PolygonIndexHistoricalData" }, { "$ref": "#/components/schemas/IntrinioIndexHistoricalData" } ] }, "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_MarketIndices", "description": "OBBject with results of type MarketIndices" }, "OBBject_MarketSnapshots": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPMarketSnapshotsData" }, { "$ref": "#/components/schemas/PolygonMarketSnapshotsData" }, { "$ref": "#/components/schemas/IntrinioMarketSnapshotsData" } ] }, "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_MarketSnapshots", "description": "OBBject with results of type MarketSnapshots" }, "OBBject_MoneyMeasures": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FederalReserveMoneyMeasuresData" }, "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_MoneyMeasures", "description": "OBBject with results of type MoneyMeasures" }, "OBBject_MoodyCorporateBondIndex": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDMoodyCorporateBondIndexData" }, "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_MoodyCorporateBondIndex", "description": "OBBject with results of type MoodyCorporateBondIndex" }, "OBBject_OptionsChains": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioOptionsChainsData" }, "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_OptionsChains", "description": "OBBject with results of type OptionsChains" }, "OBBject_OptionsUnusual": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioOptionsUnusualData" }, "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_OptionsUnusual", "description": "OBBject with results of type OptionsUnusual" }, "OBBject_PROJECTIONS": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDPROJECTIONData" }, "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_PROJECTIONS", "description": "OBBject with results of type PROJECTIONS" }, "OBBject_PricePerformance": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPPricePerformanceData" }, "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_PricePerformance", "description": "OBBject with results of type PricePerformance" }, "OBBject_PriceTarget": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/BenzingaPriceTargetData" }, { "$ref": "#/components/schemas/FMPPriceTargetData" } ] }, "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_PriceTarget", "description": "OBBject with results of type PriceTarget" }, "OBBject_PriceTargetConsensus": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPPriceTargetConsensusData" }, { "$ref": "#/components/schemas/IntrinioPriceTargetConsensusData" } ] }, "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_PriceTargetConsensus", "description": "OBBject with results of type PriceTargetConsensus" }, "OBBject_ProKeyMetrics": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProKeyMetrics" }, "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_ProKeyMetrics", "description": "OBBject with results of type ProKeyMetrics" }, "OBBject_ReportedFinancials": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioReportedFinancialsData" }, "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_ReportedFinancials", "description": "OBBject with results of type ReportedFinancials" }, "OBBject_RevenueBusinessLine": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPRevenueBusinessLineData" }, "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_RevenueBusinessLine", "description": "OBBject with results of type RevenueBusinessLine" }, "OBBject_RevenueGeographic": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPRevenueGeographicData" }, "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_RevenueGeographic", "description": "OBBject with results of type RevenueGeographic" }, "OBBject_RiskPremium": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FMPRiskPremiumData" }, "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_RiskPremium", "description": "OBBject with results of type RiskPremium" }, "OBBject_RssLitigation": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SecRssLitigationData" }, "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_RssLitigation", "description": "OBBject with results of type RssLitigation" }, "OBBject_SOFR": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDSOFRData" }, "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_SOFR", "description": "OBBject with results of type SOFR" }, "OBBject_SONIA": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDSONIAData" }, "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_SONIA", "description": "OBBject with results of type SONIA" }, "OBBject_STIR": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDSTIRData" }, "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_STIR", "description": "OBBject with results of type STIR" }, "OBBject_SchemaFiles": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "$ref": "#/components/schemas/SecSchemaFilesData" }, { "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_SchemaFiles", "description": "OBBject with results of type SchemaFiles" }, "OBBject_SearchAttributes": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IntrinioSearchAttributesData" }, "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_SearchAttributes", "description": "OBBject with results of type SearchAttributes" }, "OBBject_SelectedTreasuryBill": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDSelectedTreasuryBillData" }, "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_SelectedTreasuryBill", "description": "OBBject with results of type SelectedTreasuryBill" }, "OBBject_SelectedTreasuryConstantMaturity": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDSelectedTreasuryConstantMaturityData" }, "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_SelectedTreasuryConstantMaturity", "description": "OBBject with results of type SelectedTreasuryConstantMaturity" }, "OBBject_ShareStatistics": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioShareStatisticsData" }, { "$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" }, { "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_SicSearch", "description": "OBBject with results of type SicSearch" }, "OBBject_SpotRate": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FREDSpotRateData" }, "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_SpotRate", "description": "OBBject with results of type 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": { "$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" }, { "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_TreasuryConstantMaturity", "description": "OBBject with results of type TreasuryConstantMaturity" }, "OBBject_TreasuryRates": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPTreasuryRatesData" }, { "$ref": "#/components/schemas/FederalReserveTreasuryRatesData" } ] }, "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_TreasuryRates", "description": "OBBject with results of type TreasuryRates" }, "OBBject_USYieldCurve": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/openbb_fred__models__us_yield_curve__FREDYieldCurveData" }, "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_USYieldCurve", "description": "OBBject with results of type USYieldCurve" }, "OBBject_Unemployment": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OECDUnemploymentData" }, "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_Unemployment", "description": "OBBject with results of type Unemployment" }, "OBBject_Watchlist": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Watchlist" }, "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_Watchlist", "description": "OBBject with results of type Watchlist" }, "OBBject_WorldNews": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/IntrinioWorldNewsData" }, { "$ref": "#/components/schemas/BenzingaWorldNewsData" }, { "$ref": "#/components/schemas/FMPWorldNewsData" } ] }, "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_WorldNews", "description": "OBBject with results of type WorldNews" }, "OBBject_YieldCurve": { "properties": { "_id": { "type": "string", "title": " Id" }, "results": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/FMPYieldCurveData" }, { "$ref": "#/components/schemas/openbb_fred__models__yield_curve__FREDYieldCurveData" }, { "$ref": "#/components/schemas/EconDbYieldCurveData" }, { "$ref": "#/components/schemas/FederalReserveYieldCurveData" }, { "$ref": "#/components/schemas/ECBYieldCurveData" } ] }, "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_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" }, "OECDCLIData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "CLI value" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country for which CLI is given" } }, "additionalProperties": true, "type": "object", "title": "OECDCLIData", "description": "OECD CLI Data." }, "OECDGdpForecastData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Nominal GDP value on the date." } }, "additionalProperties": true, "type": "object", "title": "OECDGdpForecastData", "description": "OECD GDP Forecast Data." }, "OECDGdpNominalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Nominal GDP value on the date." } }, "additionalProperties": true, "type": "object", "title": "OECDGdpNominalData", "description": "OECD Nominal GDP Data." }, "OECDGdpRealData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Nominal GDP value on the date." } }, "additionalProperties": true, "type": "object", "title": "OECDGdpRealData", "description": "OECD Real GDP Data." }, "OECDLTIRData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Interest rate (given as a whole number, i.e 10=10%)" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country for which interest rate is given" } }, "additionalProperties": true, "type": "object", "title": "OECDLTIRData", "description": "OECD Long Term Interest Rate Data." }, "OECDSTIRData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Interest rate (given as a whole number, i.e 10=10%)" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country for which interest rate is given" } }, "additionalProperties": true, "type": "object", "title": "OECDSTIRData", "description": "OECD Short Term Interest Rate Data." }, "OECDUnemploymentData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Unemployment rate (given as a whole number, i.e 10=10%)" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country for which unemployment rate is given" } }, "additionalProperties": true, "type": "object", "title": "OECDUnemploymentData", "description": "OECD Unemployment Data." }, "OpenBBErrorResponse": { "properties": { "detail": { "type": "string", "title": "Detail" }, "error_kind": { "type": "string", "title": "Error Kind" } }, "type": "object", "required": [ "detail", "error_kind" ], "title": "OpenBBErrorResponse", "description": "OpenBB Error Response." }, "PolygonBalanceSheetData": { "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." }, "accounts_receivable": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Accounts Receivable", "description": "Accounts receivable" }, "marketable_securities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Marketable Securities", "description": "Marketable securities" }, "prepaid_expenses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prepaid Expenses", "description": "Prepaid expenses" }, "other_current_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Other Current Assets", "description": "Other current assets" }, "total_current_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Current Assets", "description": "Total current assets" }, "property_plant_equipment_net": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Property Plant Equipment Net", "description": "Property plant and equipment net" }, "inventory": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inventory", "description": "Inventory" }, "other_non_current_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Other Non Current Assets", "description": "Other non-current assets" }, "total_non_current_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Non Current Assets", "description": "Total non-current assets" }, "intangible_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Intangible Assets", "description": "Intangible assets" }, "total_assets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Assets", "description": "Total assets" }, "accounts_payable": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Accounts Payable", "description": "Accounts payable" }, "employee_wages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Employee Wages", "description": "Employee wages" }, "other_current_liabilities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Other Current Liabilities", "description": "Other current liabilities" }, "total_current_liabilities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Current Liabilities", "description": "Total current liabilities" }, "other_non_current_liabilities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Other Non Current Liabilities", "description": "Other non-current liabilities" }, "total_non_current_liabilities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Non Current Liabilities", "description": "Total non-current liabilities" }, "long_term_debt": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Long Term Debt", "description": "Long term debt" }, "total_liabilities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Liabilities", "description": "Total liabilities" }, "minority_interest": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minority Interest", "description": "Minority interest" }, "temporary_equity_attributable_to_parent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Temporary Equity Attributable To Parent", "description": "Temporary equity attributable to parent" }, "equity_attributable_to_parent": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Equity Attributable To Parent", "description": "Equity attributable to parent" }, "temporary_equity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Temporary Equity", "description": "Temporary equity" }, "preferred_stock": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Preferred Stock", "description": "Preferred stock" }, "redeemable_non_controlling_interest": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Redeemable Non Controlling Interest", "description": "Redeemable non-controlling interest" }, "redeemable_non_controlling_interest_other": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Redeemable Non Controlling Interest Other", "description": "Redeemable non-controlling interest other" }, "total_stock_holders_equity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Stock Holders Equity", "description": "Total stock holders equity" }, "total_liabilities_and_stock_holders_equity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Liabilities And Stock Holders Equity", "description": "Total liabilities and stockholders equity" }, "total_equity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Equity", "description": "Total equity" } }, "additionalProperties": true, "type": "object", "required": [ "period_ending" ], "title": "PolygonBalanceSheetData", "description": "Polygon Balance Sheet Statement Data." }, "PolygonCashFlowStatementData": { "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." }, "net_cash_flow_from_operating_activities_continuing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Operating Activities Continuing", "description": "Net cash flow from operating activities continuing." }, "net_cash_flow_from_operating_activities_discontinued": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Operating Activities Discontinued", "description": "Net cash flow from operating activities discontinued." }, "net_cash_flow_from_operating_activities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Operating Activities", "description": "Net cash flow from operating activities." }, "net_cash_flow_from_investing_activities_continuing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Investing Activities Continuing", "description": "Net cash flow from investing activities continuing." }, "net_cash_flow_from_investing_activities_discontinued": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Investing Activities Discontinued", "description": "Net cash flow from investing activities discontinued." }, "net_cash_flow_from_investing_activities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Investing Activities", "description": "Net cash flow from investing activities." }, "net_cash_flow_from_financing_activities_continuing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Financing Activities Continuing", "description": "Net cash flow from financing activities continuing." }, "net_cash_flow_from_financing_activities_discontinued": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Financing Activities Discontinued", "description": "Net cash flow from financing activities discontinued." }, "net_cash_flow_from_financing_activities": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow From Financing Activities", "description": "Net cash flow from financing activities." }, "net_cash_flow_continuing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow Continuing", "description": "Net cash flow continuing." }, "net_cash_flow_discontinued": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow Discontinued", "description": "Net cash flow discontinued." }, "exchange_gains_losses": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exchange Gains Losses", "description": "Exchange gains losses." }, "net_cash_flow": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Net Cash Flow", "description": "Net cash flow." } }, "additionalProperties": true, "type": "object", "required": [ "period_ending" ], "title": "PolygonCashFlowStatementData", "description": "Polygon Cash Flow Statement Data." }, "PolygonCompanyNewsData": { "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": "Images associated with the article." }, "url": { "type": "string", "title": "Url", "description": "URL to the article." }, "symbols": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbols", "description": "Symbols associated with the article." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "Source of the article." }, "tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tags", "description": "Keywords/tags in the article" }, "id": { "type": "string", "title": "Id", "description": "Article ID." }, "amp_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amp Url", "description": "AMP URL." }, "publisher": { "allOf": [ { "$ref": "#/components/schemas/PolygonPublisher" } ], "description": "Publisher of the article." } }, "additionalProperties": true, "type": "object", "required": [ "date", "title", "url", "id", "publisher" ], "title": "PolygonCompanyNewsData", "description": "Polygon Company News Data." }, "PolygonCryptoHistoricalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "exclusiveMinimum": 0.0, "title": "Open", "description": "The open price." }, "high": { "type": "number", "exclusiveMinimum": 0.0, "title": "High", "description": "The high price." }, "low": { "type": "number", "exclusiveMinimum": 0.0, "title": "Low", "description": "The low price." }, "close": { "type": "number", "exclusiveMinimum": 0.0, "title": "Close", "description": "The close price." }, "volume": { "type": "number", "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "n": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "N", "description": "Number of transactions for the symbol in the time period." } }, "additionalProperties": true, "type": "object", "required": [ "date", "open", "high", "low", "close", "volume" ], "title": "PolygonCryptoHistoricalData", "description": "Polygon Crypto Historical Price Data." }, "PolygonCurrencyHistoricalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "exclusiveMinimum": 0.0, "title": "Open", "description": "The open price." }, "high": { "type": "number", "exclusiveMinimum": 0.0, "title": "High", "description": "The high price." }, "low": { "type": "number", "exclusiveMinimum": 0.0, "title": "Low", "description": "The low price." }, "close": { "type": "number", "exclusiveMinimum": 0.0, "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "transactions": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Transactions", "description": "Number of transactions for the symbol in the time period." } }, "additionalProperties": true, "type": "object", "required": [ "date", "open", "high", "low", "close" ], "title": "PolygonCurrencyHistoricalData", "description": "Polygon Currency Historical Price Data." }, "PolygonCurrencyPairsData": { "properties": { "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 currency pair." }, "currency_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Symbol", "description": "The symbol of the quote currency." }, "base_currency_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Currency Symbol", "description": "The symbol of the base currency." }, "base_currency_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Currency Name", "description": "Name of the base currency." }, "market": { "type": "string", "title": "Market", "description": "Name of the trading market. Always 'fx'." }, "locale": { "type": "string", "title": "Locale", "description": "Locale of the currency pair." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "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": [ "symbol", "market", "locale" ], "title": "PolygonCurrencyPairsData", "description": "Polygon Currency Available Pairs Data." }, "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": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "type": "number", "title": "Open", "description": "The open price." }, "high": { "type": "number", "title": "High", "description": "The high price." }, "low": { "type": "number", "title": "Low", "description": "The low price." }, "close": { "type": "number", "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vwap", "description": "Volume Weighted Average Price over the period." }, "n": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "N", "description": "Number of transactions for the symbol in the time period." } }, "additionalProperties": true, "type": "object", "required": [ "date", "open", "high", "low", "close" ], "title": "PolygonEquityHistoricalData", "description": "Polygon Equity Historical Price Data." }, "PolygonEquityNBBOData": { "properties": { "ask_exchange": { "type": "string", "title": "Ask Exchange", "description": "The exchange ID for the ask." }, "ask": { "type": "number", "title": "Ask", "description": "The last ask price." }, "ask_size": { "type": "integer", "title": "Ask Size", "description": "\n The ask size. This represents the number of round lot orders at the given ask price.\n The normal round lot size is 100 shares.\n An ask size of 2 means there are 200 shares available to purchase at the given ask price.\n " }, "bid_size": { "type": "integer", "title": "Bid Size", "description": "The bid size in round lots." }, "bid": { "type": "number", "title": "Bid", "description": "The last bid price." }, "bid_exchange": { "type": "string", "title": "Bid Exchange", "description": "The exchange ID for the bid." }, "tape_integer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tape Integer", "description": "The exchange tape." }, "conditions": { "anyOf": [ { "type": "string" }, { "items": { "type": "integer" }, "type": "array" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Conditions", "description": "A list of condition codes." }, "indicators": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Indicators", "description": "A list of indicator codes." }, "sequence_number": { "anyOf": [ { "type": "integer" }, { "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)" }, "participant_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Participant Timestamp", "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange." }, "sip_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Sip Timestamp", "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it." }, "trf_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Trf Timestamp", "description": "The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote." } }, "additionalProperties": true, "type": "object", "required": [ "ask_exchange", "ask", "ask_size", "bid_size", "bid", "bid_exchange" ], "title": "PolygonEquityNBBOData", "description": "Polygon Equity NBBO data." }, "PolygonIncomeStatementData": { "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." }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue", "description": "Total Revenue" }, "cost_of_revenue_goods": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue Goods", "description": "Cost of Revenue - Goods" }, "cost_of_revenue_services": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue Services", "description": "Cost of Revenue - Services" }, "cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue", "description": "Cost of Revenue" }, "gross_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit", "description": "Gross Profit" }, "provisions_for_loan_lease_and_other_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Provisions For Loan Lease And Other Losses", "description": "Provisions for loan lease and other losses" }, "depreciation_and_amortization": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation And Amortization", "description": "Depreciation and Amortization" }, "income_tax_expense_benefit_current": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Tax Expense Benefit Current", "description": "Income tax expense benefit current" }, "deferred_tax_benefit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Deferred Tax Benefit", "description": "Deferred tax benefit" }, "benefits_costs_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Benefits Costs Expenses", "description": "Benefits, costs and expenses" }, "selling_general_and_administrative_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Selling General And Administrative Expense", "description": "Selling, general and administrative expense" }, "research_and_development": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Research And Development", "description": "Research and development" }, "costs_and_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Costs And Expenses", "description": "Costs and expenses" }, "other_operating_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Other Operating Expenses", "description": "Other Operating Expenses" }, "operating_expenses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Expenses", "description": "Operating expenses" }, "operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Income", "description": "Operating Income/Loss" }, "non_operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Operating Income", "description": "Non Operating Income/Loss" }, "interest_and_dividend_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest And Dividend Income", "description": "Interest and Dividend Income" }, "total_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Interest Expense", "description": "Interest Expense" }, "interest_and_debt_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest And Debt Expense", "description": "Interest and Debt Expense" }, "net_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Interest Income", "description": "Interest Income Net" }, "interest_income_after_provision_for_losses": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Interest Income After Provision For Losses", "description": "Interest Income After Provision for Losses" }, "non_interest_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Interest Expense", "description": "Non-Interest Expense" }, "non_interest_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non Interest Income", "description": "Non-Interest Income" }, "income_from_discontinued_operations_net_of_tax_on_disposal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income From Discontinued Operations Net Of Tax On Disposal", "description": "Income From Discontinued Operations Net of Tax on Disposal" }, "income_from_discontinued_operations_net_of_tax": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income From Discontinued Operations Net Of Tax", "description": "Income From Discontinued Operations Net of Tax" }, "income_before_equity_method_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Before Equity Method Investments", "description": "Income Before Equity Method Investments" }, "income_from_equity_method_investments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income From Equity Method Investments", "description": "Income From Equity Method Investments" }, "total_pre_tax_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Pre Tax Income", "description": "Income Before Tax" }, "income_tax_expense": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income Tax Expense", "description": "Income Tax Expense" }, "income_after_tax": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Income After Tax", "description": "Income After Tax" }, "consolidated_net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Consolidated Net Income", "description": "Net Income/Loss" }, "net_income_attributable_noncontrolling_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Attributable Noncontrolling Interest", "description": "Net income (loss) attributable to noncontrolling interest" }, "net_income_attributable_to_parent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Attributable To Parent", "description": "Net income (loss) attributable to parent" }, "net_income_attributable_to_common_shareholders": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income Attributable To Common Shareholders", "description": "Net Income/Loss Available To Common Stockholders Basic" }, "participating_securities_earnings": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Participating Securities Earnings", "description": "Participating Securities Distributed And Undistributed Earnings Loss Basic" }, "undistributed_earnings_allocated_to_participating_securities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Undistributed Earnings Allocated To Participating Securities", "description": "Undistributed Earnings Allocated To Participating Securities" }, "common_stock_dividends": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Common Stock Dividends", "description": "Common Stock Dividends" }, "preferred_stock_dividends_and_other_adjustments": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Preferred Stock Dividends And Other Adjustments", "description": "Preferred stock dividends and other adjustments" }, "basic_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Basic Earnings Per Share", "description": "Earnings Per Share" }, "diluted_earnings_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Diluted Earnings Per Share", "description": "Diluted Earnings Per Share" }, "weighted_average_basic_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Basic Shares Outstanding", "description": "Basic Average Shares" }, "weighted_average_diluted_shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weighted Average Diluted Shares Outstanding", "description": "Diluted Average Shares" } }, "additionalProperties": true, "type": "object", "required": [ "period_ending" ], "title": "PolygonIncomeStatementData", "description": "Polygon Income Statement Data." }, "PolygonIndexHistoricalData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "title": "Date", "description": "The date of the data." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "n": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "N", "description": "Number of transactions for the symbol in the time period." } }, "additionalProperties": true, "type": "object", "required": [ "date" ], "title": "PolygonIndexHistoricalData", "description": "Polygon Index Historical Data." }, "PolygonMarketSnapshotsData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open", "description": "The open price." }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High", "description": "The high price." }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low", "description": "The low price." }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close", "description": "The close price." }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Volume", "description": "The trading volume." }, "prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Close", "description": "The previous close price." }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change", "description": "The change in price from the previous close." }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Percent", "description": "The change in price from the previous close, as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Vwap", "description": "The volume weighted average price of the stock on the current trading day." }, "prev_open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Open", "description": "The previous trading session opening price." }, "prev_high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev High", "description": "The previous trading session high price." }, "prev_low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Low", "description": "The previous trading session low price." }, "prev_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Volume", "description": "The previous trading session volume." }, "prev_vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Prev Vwap", "description": "The previous trading session VWAP." }, "last_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Updated", "description": "The last time the data was updated." }, "bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Bid", "description": "The current bid price." }, "bid_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bid Size", "description": "The current bid size." }, "ask_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ask Size", "description": "The current ask size." }, "ask": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ask", "description": "The current ask price." }, "quote_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Quote Timestamp", "description": "The timestamp of the last quote." }, "last_trade_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Last Trade Price", "description": "The last trade price." }, "last_trade_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Trade Size", "description": "The last trade size." }, "last_trade_conditions": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Last Trade Conditions", "description": "The last trade condition codes." }, "last_trade_exchange": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Trade Exchange", "description": "The last trade exchange ID code." }, "last_trade_timestamp": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Trade Timestamp", "description": "The last trade timestamp." } }, "additionalProperties": true, "type": "object", "required": [ "symbol", "last_updated" ], "title": "PolygonMarketSnapshotsData", "description": "Polygon Market Snapshots Data." }, "PolygonPublisher": { "properties": { "favicon_url": { "type": "string", "title": "Favicon Url", "description": "Favicon URL." }, "homepage_url": { "type": "string", "title": "Homepage Url", "description": "Homepage URL." }, "logo_url": { "type": "string", "title": "Logo Url", "description": "Logo URL." }, "name": { "type": "string", "title": "Name", "description": "Publisher Name." } }, "type": "object", "required": [ "favicon_url", "homepage_url", "logo_url", "name" ], "title": "PolygonPublisher", "description": "PolygonPublisher Data Model." }, "PossibleYears": { "properties": { "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" }, { "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": "SecCikMapData", "description": "SEC CIK Mapping Data." }, "SecCompanyFilingsData": { "properties": { "filing_date": { "type": "string", "format": "date", "title": "Filing Date", "description": "The date of the filing." }, "accepted_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Accepted Date", "description": "Accepted date of the filing." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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." }, "report_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Type", "description": "Type of filing." }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url", "description": "URL to the filing page." }, "report_url": { "type": "string", "title": "Report Url", "description": "URL to the actual report." }, "reportDate": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Reportdate", "description": "The date of the filing." }, "act": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Act", "description": "The SEC Act number." }, "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Items", "description": "The SEC Item numbers." }, "primaryDocDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primarydocdescription", "description": "The description of the primary document." }, "primaryDocument": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primarydocument", "description": "The filename of the primary document." }, "accessionNumber": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Accessionnumber", "description": "The accession number." }, "fileNumber": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Filenumber", "description": "The file number." }, "filmNumber": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Filmnumber", "description": "The film number." }, "isInlineXBRL": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Isinlinexbrl", "description": "Whether the filing is an inline XBRL filing." }, "isXBRL": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Isxbrl", "description": "Whether the filing is an XBRL filing." }, "size": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Size", "description": "The size of the filing." }, "completeSubmissionUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completesubmissionurl", "description": "The URL to the complete filing submission." }, "filingDetailUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filingdetailurl", "description": "The URL to the filing details." } }, "additionalProperties": true, "type": "object", "required": [ "filing_date", "report_url" ], "title": "SecCompanyFilingsData", "description": "SEC Company Filings Data." }, "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": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Settlement Date", "description": "The settlement date of the fail." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data." }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip", "description": "CUSIP of the Security." }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity", "description": "The number of fails on that settlement date." }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price", "description": "The price at the previous closing price from the settlement date." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the Security." } }, "additionalProperties": true, "type": "object", "title": "SecEquityFtdData", "description": "SEC Equity FTD Data." }, "SecEquitySearchData": { "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 company." }, "cik": { "type": "string", "title": "Cik", "description": "Central Index Key" } }, "additionalProperties": true, "type": "object", "required": [ "cik" ], "title": "SecEquitySearchData", "description": "SEC Equity Search Data." }, "SecEtfHoldingsData": { "properties": { "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol", "description": "Symbol representing the entity requested in the data. (ETF)" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the ETF holding." }, "lei": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lei", "description": "The LEI 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." }, "other_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Other Id", "description": "Internal identifier for the holding." }, "balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Balance", "description": "The balance of the holding." }, "pctVal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pctval", "description": "The weight of the holding in ETF in %.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "valUSD": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Valusd", "description": "The value of the holding in USD." }, "payoffProfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payoffprofile", "description": "The payoff profile of the holding." }, "units": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Units", "description": "The units of the holding." }, "curCd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Curcd", "description": "The currency 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." }, "loanVal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Loanval", "description": "The loan value of the holding." }, "issuer_conditional": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Conditional", "description": "The issuer conditions of the holding." }, "asset_conditional": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asset Conditional", "description": "The asset conditions of the holding." }, "maturity_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Maturity Date", "description": "The maturity date of the debt security." }, "coupon_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Coupon Kind", "description": "The type of coupon for the debt security." }, "rate_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Type", "description": "The type of rate for the debt security, floating or fixed." }, "annualized_return": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Annualized Return", "description": "The annualized return on the debt security.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" }, "is_default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Is Default", "description": "If the debt security is defaulted." }, "in_arrears": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "In Arrears", "description": "If the debt security is in arrears." }, "is_paid_kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Is Paid Kind", "description": "If the debt security payments are paid in kind." }, "derivative_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Derivative Category", "description": "The derivative category of the holding." }, "counterparty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counterparty", "description": "The counterparty of the derivative." }, "underlying_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Underlying Name", "description": "The name of the underlying asset associated with the derivative." }, "option_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Option Type", "description": "The type of option." }, "derivative_payoff": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Derivative Payoff", "description": "The payoff profile of the derivative." }, "expiry_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Expiry Date", "description": "The expiry or termination date of the derivative." }, "exercise_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Exercise Price", "description": "The exercise price of the option." }, "exercise_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exercise Currency", "description": "The currency of the option exercise price." }, "shares_per_contract": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares Per Contract", "description": "The number of shares per contract." }, "delta": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Delta", "description": "The delta of the option." }, "rate_type_rec": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Type Rec", "description": "The type of rate for receivable portion of the swap." }, "receive_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Receive Currency", "description": "The receive currency of the swap." }, "upfront_receive": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Upfront Receive", "description": "The upfront amount received of the swap." }, "floating_rate_index_rec": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Floating Rate Index Rec", "description": "The floating rate index for receivable portion of the swap." }, "floating_rate_spread_rec": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Floating Rate Spread Rec", "description": "The floating rate spread for reveivable portion of the swap." }, "rate_tenor_rec": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Tenor Rec", "description": "The rate tenor for receivable portion of the swap." }, "rate_tenor_unit_rec": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Rate Tenor Unit Rec", "description": "The rate tenor unit for receivable portion of the swap." }, "reset_date_rec": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reset Date Rec", "description": "The reset date for receivable portion of the swap." }, "reset_date_unit_rec": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Reset Date Unit Rec", "description": "The reset date unit for receivable portion of the swap." }, "rate_type_pmnt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Type Pmnt", "description": "The type of rate for payment portion of the swap." }, "payment_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payment Currency", "description": "The payment currency of the swap." }, "upfront_payment": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Upfront Payment", "description": "The upfront amount received of the swap." }, "floating_rate_index_pmnt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Floating Rate Index Pmnt", "description": "The floating rate index for payment portion of the swap." }, "floating_rate_spread_pmnt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Floating Rate Spread Pmnt", "description": "The floating rate spread for payment portion of the swap." }, "rate_tenor_pmnt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Tenor Pmnt", "description": "The rate tenor for payment portion of the swap." }, "rate_tenor_unit_pmnt": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Rate Tenor Unit Pmnt", "description": "The rate tenor unit for payment portion of the swap." }, "reset_date_pmnt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reset Date Pmnt", "description": "The reset date for payment portion of the swap." }, "reset_date_unit_pmnt": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Reset Date Unit Pmnt", "description": "The reset date unit for payment portion of the swap." }, "repo_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Type", "description": "The type of repo." }, "is_cleared": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Is Cleared", "description": "If the repo is cleared." }, "is_tri_party": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Is Tri Party", "description": "If the repo is tri party." }, "principal_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Principal Amount", "description": "The principal amount of the repo." }, "principal_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Principal Currency", "description": "The currency of the principal amount." }, "collateral_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collateral Type", "description": "The collateral type of the repo." }, "collateral_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Collateral Amount", "description": "The collateral amount of the repo." }, "collateral_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collateral Currency", "description": "The currency of the collateral amount." }, "exchange_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange Currency", "description": "The currency of the exchange rate." }, "exchange_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Exchange Rate", "description": "The exchange rate." }, "currency_sold": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Sold", "description": "The currency sold in a Forward Derivative." }, "currency_amount_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Currency Amount Sold", "description": "The amount of currency sold in a Forward Derivative." }, "currency_bought": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Bought", "description": "The currency bought in a Forward Derivative." }, "currency_amount_bought": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Currency Amount Bought", "description": "The amount of currency bought in a Forward Derivative." }, "notional_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Notional Amount", "description": "The notional amount of the derivative." }, "notional_currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notional Currency", "description": "The currency of the derivative's notional amount." }, "unrealized_gain": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unrealized Gain", "description": "The unrealized gain or loss on the derivative." } }, "additionalProperties": true, "type": "object", "title": "SecEtfHoldingsData", "description": "SEC ETF Holdings Data." }, "SecForm13FHRData": { "properties": { "period_ending": { "type": "string", "format": "date", "title": "Period Ending", "description": "The end-of-quarter date of the filing." }, "issuer": { "type": "string", "title": "Issuer", "description": "The name of the issuer." }, "cusip": { "type": "string", "title": "Cusip", "description": "The CUSIP of the security." }, "asset_class": { "type": "string", "title": "Asset Class", "description": "The title of the asset class for the security." }, "security_type": { "anyOf": [ { "type": "string", "enum": [ "SH", "PRN" ] }, { "type": "null" } ], "title": "Security Type", "description": "The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'." }, "option_type": { "anyOf": [ { "type": "string", "enum": [ "call", "put" ] }, { "type": "null" } ], "title": "Option Type", "description": "Defined when the holdings being reported are put or call options. Only long positions are reported." }, "voting_authority_sole": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Voting Authority Sole", "description": "The number of shares for which the Manager exercises sole voting authority (none)." }, "voting_authority_shared": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Voting Authority Shared", "description": "The number of shares for which the Manager exercises a defined shared voting authority (none)." }, "voting_authority_other": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Voting Authority Other", "description": "The number of shares for which the Manager exercises other shared voting authority (none)." }, "principal_amount": { "type": "integer", "title": "Principal Amount", "description": "The total number of shares of the class of security or the principal amount of such class. Only long positions are reported" }, "value": { "type": "integer", "title": "Value", "description": "The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter." }, "weight": { "type": "number", "title": "Weight", "description": "The weight of the security relative to the market value of all securities in the filing , as a normalized percent.", "x-frontend_multiply": 100, "x-unit_measurement": "percent" } }, "additionalProperties": true, "type": "object", "required": [ "period_ending", "issuer", "cusip", "asset_class", "principal_amount", "value", "weight" ], "title": "SecForm13FHRData", "description": "SEC Form 13F-HR Data." }, "SecInstitutionsSearchData": { "properties": { "Institution": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Institution", "description": "The name of the institution." }, "CIK Number": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Cik Number", "description": "Central Index Key (CIK)" } }, "additionalProperties": true, "type": "object", "title": "SecInstitutionsSearchData", "description": "SEC Institutions Search Data." }, "SecRssLitigationData": { "properties": { "date": { "type": "string", "format": "date-time", "title": "Date", "description": "The date of publication." }, "title": { "type": "string", "title": "Title", "description": "The title of the release." }, "summary": { "type": "string", "title": "Summary", "description": "Short summary of the release." }, "id": { "type": "string", "title": "Id", "description": "The identifier associated with the release." }, "link": { "type": "string", "title": "Link", "description": "URL to the release." } }, "additionalProperties": true, "type": "object", "required": [ "date", "title", "summary", "id", "link" ], "title": "SecRssLitigationData", "description": "SEC Litigation RSS Feed Data." }, "SecSchemaFilesData": { "properties": { "files": { "items": { "type": "string" }, "type": "array", "title": "Files", "description": "Dictionary of URLs to SEC Schema Files" } }, "additionalProperties": true, "type": "object", "required": [ "files" ], "title": "SecSchemaFilesData", "description": "SEC Schema Files List Data." }, "SecSicSearchData": { "properties": { "SIC Code": { "type": "integer", "title": "Sic Code", "description": "Sector Industrial Code (SIC)" }, "Industry Title": { "type": "string", "title": "Industry Title", "description": "Industry title." }, "Office": { "type": "string", "title": "Office", "description": "Reporting office within the Corporate Finance Office" } }, "additionalProperties": true, "type": "object", "required": [ "SIC Code", "Industry Title", "Office" ], "title": "SecSicSearchData", "description": "SEC Standard Industrial Classification Code (SIC) Data." }, "SecSymbolMapData": { "properties": { "symbol": { "type": "string", "title": "Symbol", "description": "Symbol representing the entity requested in the data." } }, "additionalProperties": true, "type": "object", "required": [ "symbol" ], "title": "SecSymbolMapData", "description": "SEC symbol map Data." }, "TEEconomicCalendarData": { "properties": { "date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Date", "description": "The date of the data." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country of event." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category of event." }, "event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event", "description": "Event name." }, "importance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Importance", "description": "The importance level for the event." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "Source of the data." }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency", "description": "Currency of the data." }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit", "description": "Unit of the data." }, "consensus": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Consensus", "description": "Average forecast among a representative group of economists." }, "previous": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Previous", "description": "Value for the previous period after the revision (if revision is applicable)." }, "revised": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Revised", "description": "Revised previous value, if applicable." }, "actual": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Actual", "description": "Latest released value." }, "forecast": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ], "title": "Forecast", "description": "TradingEconomics projections." }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference", "description": "Abbreviated period for which released data refers to." }, "reference_date": { "anyOf": [ { "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" }, { "type": "null" } ], "title": "Symbol", "description": "TradingEconomics Symbol." }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker", "description": "TradingEconomics Ticker symbol." }, "te_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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": "TEEconomicCalendarData", "description": "Trading Economics Economic Calendar Data." }, "UDFSearchResult": { "properties": { "symbol": { "type": "string", "title": "Symbol" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Name" }, "description": { "type": "string", "title": "Description" }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange" }, "ticker": { "type": "string", "title": "Ticker" }, "logo_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Logo Urls" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "symbol", "description", "ticker", "type" ], "title": "UDFSearchResult", "description": "UDF Symbol Search Model." }, "UDFSubsession": { "properties": { "description": { "type": "string", "title": "Description" }, "id": { "type": "string", "title": "Id" }, "session": { "type": "string", "title": "Session" } }, "type": "object", "required": [ "description", "id", "session" ], "title": "UDFSubsession" }, "UDFSymbol": { "properties": { "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symbol" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Name" }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange" }, "listed_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Listed Exchange" }, "type": { "type": "string", "title": "Type" }, "session": { "type": "string", "title": "Session", "default": "0930-1600" }, "subsession_id": { "type": "string", "title": "Subsession Id", "default": "regular" }, "subsessions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UDFSubsession" }, "type": "array" }, { "type": "null" } ], "title": "Subsessions" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone", "default": "America/New_York" }, "has_weekly_and_monthly": { "type": "boolean", "title": "Has Weekly And Monthly", "default": false }, "has_intraday": { "type": "boolean", "title": "Has Intraday", "default": true }, "has_daily": { "type": "boolean", "title": "Has Daily", "default": true }, "pricescale": { "anyOf": [ { "type": "integer" }, { "items": { "type": "integer" }, "type": "array" } ], "title": "Pricescale", "default": 100 }, "minmov": { "anyOf": [ { "type": "integer" }, { "items": { "type": "integer" }, "type": "array" } ], "title": "Minmov", "default": 1 }, "minmove2": { "anyOf": [ { "type": "integer" }, { "items": { "type": "integer" }, "type": "array" } ], "title": "Minmove2", "default": 0 }, "currency_code": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Currency Code", "default": "USD" }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "fractional": { "anyOf": [ { "type": "boolean" }, { "items": { "type": "boolean" }, "type": "array" } ], "title": "Fractional", "default": false }, "format": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Format", "default": "price" }, "visible_plots_set": { "type": "string", "title": "Visible Plots Set", "default": "ohlc" }, "supported_resolutions": { "items": { "type": "string" }, "type": "array", "title": "Supported Resolutions", "default": [ "1", "5", "15", "30", "60", "D", "W", "M", "3M", "6M", "12M" ] }, "weekly_multipliers": { "items": { "type": "string" }, "type": "array", "title": "Weekly Multipliers", "default": [ "1", "2", "3", "4", "6" ] }, "monthly_multipliers": { "items": { "type": "string" }, "type": "array", "title": "Monthly Multipliers", "default": [ "1", "3", "6", "12" ] }, "has_empty_bars": { "type": "boolean", "title": "Has Empty Bars", "default": true }, "data_status": { "type": "string", "title": "Data Status", "default": "endofday" }, "volume_precision": { "anyOf": [ { "type": "integer" }, { "items": { "type": "integer" }, "type": "array" } ], "title": "Volume Precision", "default": 0 }, "price_source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Price Source Id", "default": "close" }, "price_sources": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Price Sources", "default": [ { "id": "close", "name": "Close" } ] }, "logo_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Logo Urls" } }, "type": "object", "required": [ "type" ], "title": "UDFSymbol", "description": "UDF Symbol Model." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Warning_": { "properties": { "category": { "type": "string", "title": "Category" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "category", "message" ], "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": { "OAuth2PasswordBearer": { "type": "oauth2", "flows": { "password": { "scopes": {}, "tokenUrl": "api/v1/user/token" } } } } } }