{ "openapi": "3.1.0", "info": { "description": "## Overview\n\nWelcome to Twelve Data developer docs — your gateway to comprehensive financial market data through a powerful and easy-to-use API.\nTwelve Data provides access to financial markets across over 50 global countries, covering more than 1 million public instruments, including stocks, forex, ETFs, mutual funds, commodities, and cryptocurrencies.\n\n## Quickstart\n\nTo get started, you'll need to sign up for an API key. Once you have your API key, you can start making requests to the API.\n\n### Step 1: Create Twelve Data account\n\nSign up on the Twelve Data website to create your account [here](https://twelvedata.com/register). This gives you access to the API dashboard and your API key.\n\n### Step 2: Get your API key\n\nAfter signing in, navigate to your [dashboard](https://twelvedata.com/account/api-keys) to find your unique API key. This key is required to authenticate all API and WebSocket requests.\n\n### Step 3: Make your first request\n\nTry a simple API call with cURL to fetch the latest price for Apple (AAPL):\n\n```\ncurl \"https://api.twelvedata.com/price?symbol=AAPL&apikey=your_api_key\"\n```\n\n### Step 4: Make a request from Python or Javascript\n\nUse our client libraries or standard HTTP clients to make API calls programmatically. Here’s an example in [Python](https://github.com/twelvedata/twelvedata-python) and [Node.js](https://github.com/twelvedata/twelvedata-node):\n\n#### Python (using official Twelve Data SDK):\n\n```python\nfrom twelvedata import TDClient\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Get latest price for Apple\nprice = td.price(symbol=\"AAPL\").as_json()\n\nprint(price)\n```\n\n#### JavaScript (Node.js):\n\n```javascript\nimport { MarketDataApi, CreateConfig } from \"@twelvedata/twelvedata-node\";\n\nconst config = CreateConfig('your_api_key');\nconst api = new MarketDataApi(config);\n\nasync function main() {\n  const response = await api.getPrice({\n    symbol: \"AAPL\",\n  });\n  console.log(response.data);\n}\n\nmain().catch(console.error);\n```\n\n### Step 5: Perform correlation analysis between Tesla and Microsoft prices\n\nFetch historical price data for Tesla (TSLA) and Microsoft (MSFT) and calculate the correlation of their closing prices:\n\n```python\nfrom twelvedata import TDClient\nimport pandas as pd\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Fetch historical price data for Tesla\ntsla_ts = td.time_series(\n    symbol=\"TSLA\",\n    interval=\"1day\",\n    outputsize=100\n).as_pandas()\n\n# Fetch historical price data for Microsoft\nmsft_ts = td.time_series(\n    symbol=\"MSFT\",\n    interval=\"1day\",\n    outputsize=100\n).as_pandas()\n\n# Align data on datetime index\ncombined = pd.concat(\n    [tsla_ts['close'].astype(float), msft_ts['close'].astype(float)],\n    axis=1,\n    keys=[\"TSLA\", \"MSFT\"]\n).dropna()\n\n# Calculate correlation\ncorrelation = combined[\"TSLA\"].corr(combined[\"MSFT\"])\nprint(f\"Correlation of closing prices between TSLA and MSFT: {correlation:.2f}\")\n```\n\n### Authentication\n\nAuthenticate your requests using one of these methods:\n\n#### Query parameter method\n```\nGET https://api.twelvedata.com/endpoint?symbol=AAPL&apikey=your_api_key\n```\n\n#### HTTP header method (recommended)\n```\nAuthorization: apikey your_api_key\n```\n\n##### API key useful information\n\n\n### API endpoints\n\n Service | Base URL |\n---------|----------|\n REST API | `https://api.twelvedata.com` |\n WebSocket | `wss://ws.twelvedata.com` |\n\n### Parameter guidelines\n\n\n### Response handling\n\n#### Default format\nAll responses return JSON format by default unless otherwise specified.\n\n#### Null values\nImportant: Some response fields may contain `null` values when data is unavailable for specific metrics. This is expected behavior, not an error.\n\n##### Best Practices:\n\n\n#### Error handling\nStructure your code to gracefully handle:\n\n\n##### Best practices\n\n\n## Errors\n\nTwelve Data API employs a standardized error response format, delivering a JSON object with `code`, `message`, and `status` keys for clear and consistent error communication.\n\n### Codes\n\nBelow is a table of possible error codes, their HTTP status, meanings, and resolution steps:\n\n Code | status | Meaning | Resolution |\n --- | --- | --- | --- |\n **400** | Bad Request | Invalid or incorrect parameter(s) provided. | Check the `message` in the response for details. Refer to the API Documenta­tion to correct the input. |\n **401** | Unauthor­ized | Invalid or incorrect API key. | Verify your API key is correct. Sign up for a key here. |\n **403** | Forbidden | API key lacks permissions for the requested resource (upgrade required). | Upgrade your plan here. |\n **404** | Not Found | Requested data could not be found. | Adjust parameters to be less strict as they may be too restrictive. |\n **414** | Parameter Too Long | Input parameter array exceeds the allowed length. | Follow the `message` guidance to adjust the parameter length. |\n **429** | Too Many Requests | API request limit reached for your key. | Wait briefly or upgrade your plan here. |\n **500** | Internal Server Error | Server-side issue occurred; retry later. | Contact support here for assistance. |\n\n### Example error response\n\nConsider the following invalid request:\n\n```\nhttps://api.twelvedata.com/time_series?symbol=AAPL&interval=0.99min&apikey=your_api_key\n```\n\nDue to the incorrect `interval` value, the API returns:\n\n```json\n{\n  \"code\": 400,\n  \"message\": \"Invalid **interval** provided: 0.99min. Supported intervals: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month\",\n  \"status\": \"error\"\n}\n```\n\nRefer to the API Documentation for valid parameter values to resolve such errors.\n\n## Libraries\n\nTwelve Data provides a growing ecosystem of libraries and integrations to help you build faster and smarter in your preferred environment. Official libraries are actively maintained by the Twelve Data team, while selected community-built libraries offer additional flexibility.\n\nA full list is available on our [GitHub profile](https://github.com/search?q=twelvedata).\n\n### Official SDKs\n\n\n### AI integrations\n\n\n### Spreadsheet add-ons\n\n\n### Community libraries\n\nThe community has developed libraries in several popular languages. You can explore more community libraries on [GitHub](https://github.com/search?q=twelvedata).\n\n\n### Other Twelve Data repositories\n\n\n### API specification\n", "title": "Twelve Data API", "version": "0.0.1" }, "servers": [ { "url": "https://api.twelvedata.com/" } ], "security": [ { "authorizationHeader": [ "[]" ] }, { "queryParameter": [ "[]" ] } ], "paths": { "/ad": { "get": { "description": "The Accumulation/Distribution (AD) endpoint provides data on the cumulative money flow into and out of a financial instrument, using its closing price, price range, and trading volume. This endpoint returns the AD line, which helps users identify potential buying or selling pressure and assess the strength of price movements.", "operationId": "GetTimeSeriesAd", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAd_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Accumulation/distribution", "tags": [ "technical_indicator" ], "x-additional-notes": "Take note that this endpoint is applicable to all instruments except currencies.", "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volume indicators", "x-order": "10", "x-url-hash": "ad-indicator", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/add": { "get": { "description": "The Addition (ADD) endpoint calculates the sum of two input data series, such as technical indicators or price data, and returns the combined result. This endpoint is useful for users who need to aggregate data points to create custom indicators or analyze the combined effect of multiple data series in financial analysis.", "operationId": "GetTimeSeriesAdd", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "62" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdd_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Addition", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "20", "x-url-hash": "add", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/adosc": { "get": { "description": "The Accumulation/Distribution Oscillator endpoint (ADOSC) calculates a momentum indicator that highlights shifts in buying or selling pressure by analyzing price and volume data over different time frames. It returns numerical values that help users identify potential trend reversals in financial markets.", "operationId": "GetTimeSeriesAdOsc", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "64" }, "x-go-name": "SlowPeriod", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdOsc_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Accumulation/distribution oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volume indicators", "x-order": "30", "x-url-hash": "adosc", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/adx": { "get": { "description": "The Average Directional Index (ADX) endpoint provides data on the strength of a market trend, regardless of its direction. It returns a numerical value that helps users identify whether a market is trending or moving sideways.", "operationId": "GetTimeSeriesAdx", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdx_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Average directional index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Momentum indicators", "x-order": "40", "x-url-hash": "adx", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/adxr": { "get": { "description": "The Average Directional Movement Index Rating (ADXR) endpoint provides a smoothed measure of trend strength for a specified financial instrument. It returns the ADXR values, which help users assess the consistency of a trend over a given period by reducing short-term fluctuations. This endpoint is useful for traders and analysts who need to evaluate the stability of market trends for better timing of entry and exit points in their trading strategies.", "operationId": "GetTimeSeriesAdxr", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdxr_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Average directional movement index rating", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "50", "x-url-hash": "adxr", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/analyst_ratings/light": { "get": { "description": "The analyst ratings snapshot endpoint provides a streamlined summary of ratings from analyst firms for both US and international markets. It delivers essential data on analyst recommendations, including buy, hold, and sell ratings, allowing users to quickly assess the general sentiment of analysts towards a particular stock.", "operationId": "GetAnalystRatingsLight", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" }, { "description": "Filter by rating change action", "in": "query", "name": "rating_change", "schema": { "$ref": "#/components/schemas/RatingChangeEnum" }, "x-go-name": "RatingChange", "x-order": "60" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "70" }, "x-go-name": "PageSize", "x-order": "70" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnalystRatingsLight_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Analyst ratings snapshot", "tags": [ "analysis" ], "x-api-credits-cost": "75", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "80", "x-starting-plan": "ultra,enterprise", "x-url-hash": "analyst-ratings-light", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/analyst_ratings/us_equities": { "get": { "description": "The analyst ratings US equities endpoint provides detailed information on analyst ratings for U.S. stocks. It returns data on the latest ratings issued by various analyst firms, including the rating itself, the firm issuing the rating, and any changes in the rating. This endpoint is useful for users tracking analyst opinions on U.S. equities, allowing them to see how professional analysts view the potential performance of specific stocks.", "operationId": "GetAnalystRatingsUsEquities", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" }, { "description": "Filter by rating change action", "in": "query", "name": "rating_change", "schema": { "$ref": "#/components/schemas/RatingChangeEnum" }, "x-go-name": "RatingChange", "x-order": "60" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "70" }, "x-go-name": "PageSize", "x-order": "70" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnalystRatingsUsEquities_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Analyst ratings US equities", "tags": [ "analysis" ], "x-api-credits-cost": "200", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "90", "x-starting-plan": "ultra,enterprise", "x-url-hash": "analyst-ratings-us", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/api_usage": { "get": { "description": "The API Usage endpoint provides detailed information on your current API usage statistics. It returns data such as the number of requests made, remaining requests, and the reset time for your usage limits. This endpoint is essential for monitoring and managing your API consumption to ensure you stay within your allocated limits.", "operationId": "GetApiUsage", "parameters": [ { "description": "Output format", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "10" }, { "description": "Specify the delimiter used when downloading the CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "20" }, "x-go-name": "Delimiter", "x-order": "20" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "UTC", "type": "string", "x-go-name": "Timezone", "x-order": "30" }, "x-go-name": "Timezone", "x-order": "30" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUsage_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "API usage", "tags": [ "advanced" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Advanced", "x-order": "30" } }, "/apo": { "get": { "description": "The Absolute Price Oscillator (APO) endpoint calculates the difference between two specified moving averages of a financial instrument's price, providing data that helps users identify potential price trends and reversals. The response includes the calculated APO values over a specified time period, which can be used to track momentum changes and assess the strength of price movements.", "operationId": "GetTimeSeriesApo", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "64" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "64" }, "x-go-name": "SlowPeriod", "x-order": "64" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesApo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Absolute price oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "60", "x-url-hash": "apo", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/aroon": { "get": { "description": "The Aroon Indicator endpoint provides data on the time elapsed since the highest high and lowest low within a specified period, helping users identify the presence and strength of market trends. It returns two values: Aroon Up and Aroon Down, which indicate the trend direction and momentum. This endpoint is useful for traders and analysts looking to assess trend patterns and potential reversals in financial markets.", "operationId": "GetTimeSeriesAroon", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAroon_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Aroon indicator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "70", "x-url-hash": "aroon", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/aroonosc": { "get": { "description": "The Aroon Oscillator endpoint provides the calculated difference between the Aroon Up and Aroon Down indicators for a given financial instrument. It returns a time series of values that help users identify the strength and direction of a trend, as well as potential trend reversals. This data is useful for traders and analysts seeking to evaluate market trends over a specified period.", "operationId": "GetTimeSeriesAroonOsc", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAroonOsc_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Aroon oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "80", "x-url-hash": "aroonosc", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/atr": { "get": { "description": "The Average True Range (ATR) endpoint provides data on market volatility by calculating the average range of price movement over a user-defined period. It returns numerical values representing the ATR for each time interval, allowing users to gauge the degree of price fluctuation in a financial instrument. This data is useful for setting stop-loss levels and determining optimal entry and exit points in trading strategies.", "operationId": "GetTimeSeriesAtr", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAtr_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Average true range", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volatility indicators", "x-order": "90", "x-url-hash": "atr", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/avg": { "get": { "description": "The Average (AVG) endpoint calculates the arithmetic mean of a specified data series over a chosen time period. It returns a smoothed dataset that helps users identify trends by reducing short-term fluctuations. This endpoint is useful for obtaining a clearer view of data trends, particularly in time series analysis.", "operationId": "GetTimeSeriesAvg", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAvg_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "100", "x-url-hash": "avg", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/avgprice": { "get": { "description": "The Average Price (AVGPRICE) endpoint calculates and returns the mean value of a security's open, high, low, and close prices. This endpoint provides a straightforward metric to assess the overall price level of a security over a specified period.", "operationId": "GetTimeSeriesAvgPrice", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAvgPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Average price", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "110", "x-url-hash": "avgprice", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/balance_sheet": { "get": { "description": "The balance sheet endpoint provides a detailed financial statement for a company, outlining its assets, liabilities, and shareholders' equity. This endpoint returns structured data that includes current and non-current assets, total liabilities, and equity figures, enabling users to assess a company's financial health and stability.", "operationId": "GetBalanceSheet", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "32", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "32", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the balance sheet data", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70" }, { "description": "Begin date for filtering items by fiscal date.\nReturns income statements with fiscal dates on or after this date. Format `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2024-01-01" }, { "description": "End date for filtering items by fiscal date.\nReturns income statements with fiscal dates on or before this date. Format `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2024-05-01" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBalanceSheet_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Balance sheet", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Pro plan (individual) and the Venture plan (business) and above. Full access to historical data requires the Ultra plan (individual) or the Enterprise plan (business).", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Fundamentals", "x-order": "130", "x-starting-plan": "pro,venture", "x-url-hash": "balance-sheet", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/balance_sheet/consolidated": { "get": { "description": "The balance sheet consolidated endpoint provides a detailed overview of a company's raw balance sheet, including a comprehensive summary of its assets, liabilities, and shareholders' equity. This endpoint is useful for retrieving financial data that reflects the overall financial position of a company, allowing users to access critical information about its financial health and structure.", "operationId": "GetBalanceSheetConsolidated", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the balance sheet data.", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70" }, { "description": "Begin date for filtering items by fiscal date. Returns income statements with fiscal dates on or after this date.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80" }, { "description": "End date for filtering items by fiscal date. Returns income statements with fiscal dates on or before this date.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBalanceSheetConsolidated_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Balance sheet consolidated", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "140", "x-starting-plan": "ultra,enterprise", "x-url-hash": "balance-sheet-consolidated", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/batch": { "post": { "description": "The batch request endpoint allows users to request data for multiple financial instruments, time intervals, and data types simultaneously. This endpoint is useful for efficiently gathering diverse financial data in a single operation, reducing the need for multiple individual requests. Errors in specific requests do not affect the processing of others, and each error is reported separately, enabling easy troubleshooting.\n\n### Request body\nOnly JSON `POST` requests are supported.\nThe request content structure consists of key-value items. The key is a unique request ID. The value is requested url.\n\n### Response\nThe response contains key-value data. The key is a unique request ID. The value is returned data.\n\n### API credits\n", "operationId": "advanced", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/advanced_request_value" }, "type": "object" } }, "application/xml": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/advanced_request_value" }, "type": "object" } } }, "description": "Map of requests", "required": false, "x-example-key": "req_1", "x-go-name": "Body", "x-order": 10 }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advanced_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Batches", "tags": [ "advanced" ], "x-badge": "Useful", "x-group": "Advanced", "x-order": 10, "x-url-hash": "batch-requests", "x-codegen-request-body-name": "key" } }, "/bbands": { "get": { "description": "The Bollinger Bands (BBANDS) endpoint calculates and returns three key data points: an upper band, a lower band, and a simple moving average (SMA) for a specified financial instrument. These bands are used to assess market volatility by showing how far prices deviate from the SMA. This information helps users identify potential price reversals and determine whether an asset is overbought or oversold.", "operationId": "GetTimeSeriesBBands", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "63" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 20, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "64" }, "x-go-name": "TimePeriod", "x-order": "64" }, { "description": "Number of standard deviations. Must be at least `1`", "in": "query", "name": "sd", "schema": { "default": 2, "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": "62" }, "x-go-name": "StandardDeviation", "x-order": "62" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "61" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBBands_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Bollinger bands", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Overlap studies", "x-order": "120", "x-url-hash": "bbands", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/beta": { "get": { "description": "The Beta Indicator endpoint provides data on a security's sensitivity to market movements by comparing its price changes to a benchmark index. It returns the beta value, which quantifies the systematic risk of the security relative to the market. This information is useful for evaluating how much a security's price is expected to move in relation to market changes.", "operationId": "GetTimeSeriesBeta", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "61" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "63" }, "x-go-name": "TimePeriod", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBeta_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Beta indicator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "130", "x-url-hash": "beta", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/bonds": { "get": { "description": "The fixed income endpoint provides a daily updated list of available bonds. It returns an array containing detailed information about each bond, including identifiers, names, and other relevant attributes.", "operationId": "GetBonds", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "US2Y" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange" }, "x-go-name": "Exchange", "example": "NYSE" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country" }, "x-go-name": "Country", "example": "United States" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Adds info on which plan symbol is available", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan" }, "x-go-name": "ShowPlan" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "default": 5000, "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBonds_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Fixed income", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "70", "x-url-hash": "bonds-list" } }, "/bop": { "get": { "description": "The Balance of Power (BOP) endpoint provides data on the buying and selling pressure of a security by analyzing its open, high, low, and close prices. It returns numerical values that help users detect shifts in market sentiment and potential price movements.", "operationId": "GetTimeSeriesBop", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBop_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Balance of power", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "140", "x-url-hash": "bop", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/cash_flow": { "get": { "description": "The cash flow endpoint provides detailed information on a company's cash flow activities, including the net cash and cash equivalents moving in and out of the business. This data includes operating, investing, and financing cash flows, offering a comprehensive view of the company's liquidity and financial health.", "operationId": "GetCashFlow", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the cash flow statements", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70" }, { "description": "Start date for filtering cash flow statements.\nOnly cash flow statements with fiscal dates on or after this date will be included.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2024-01-01" }, { "description": "End date for filtering cash flow statements.\nOnly cash flow statements with fiscal dates on or before this date will be included.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2024-12-31" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCashFlow_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Cash flow", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Pro plan (individual) and the Venture plan (business) and above. Full access to historical data requires the Ultra plan (individual) or the Enterprise plan (business).", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Fundamentals", "x-order": "150", "x-starting-plan": "pro,venture", "x-url-hash": "cash-flow", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/cash_flow/consolidated": { "get": { "description": "The cash flow consolidated endpoint provides raw data on a company's consolidated cash flow, including the net cash and cash equivalents moving in and out of the business. It returns information on operating, investing, and financing activities, helping users track liquidity and financial health over a specified period.", "operationId": "GetCashFlowConsolidated", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the cash flow statements", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70" }, { "description": "Start date for filtering cash flow statements. Only cash flow statements with fiscal dates on or after this date will be included.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2024-01-01" }, { "description": "End date for filtering cash flow statements. Only cash flow statements with fiscal dates on or before this date will be included.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2024-12-31" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCashFlowConsolidated_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Cash flow consolidated", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "160", "x-starting-plan": "ultra,enterprise", "x-url-hash": "cash-flow-consolidated", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/cci": { "get": { "description": "The Commodity Channel Index (CCI) endpoint provides data on the CCI values for a specified security, helping users detect potential price reversals by identifying overbought or oversold conditions. It returns a series of CCI values calculated over a specified time period, allowing users to assess the momentum of a security relative to its average price range.", "operationId": "GetTimeSeriesCci", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 20, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCci_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Commodity channel index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "150", "x-url-hash": "cci", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ceil": { "get": { "description": "The Ceiling (CEIL) endpoint rounds each value in the input data series up to the nearest whole number. It returns a series where each original data point is adjusted to its ceiling value, which can be useful for precise calculations or when integrating with other technical indicators that require integer inputs.", "operationId": "GetTimeSeriesCeil", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCeil_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Ceiling", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "160", "x-url-hash": "ceil", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/cmo": { "get": { "description": "The Chande Momentum Oscillator (CMO) endpoint provides data on the momentum of a security by calculating the relative strength of recent price movements. It returns a numerical value indicating whether a security is potentially overbought or oversold, assisting users in identifying possible trend reversals.", "operationId": "GetTimeSeriesCmo", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCmo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Chande momentum oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "170", "x-url-hash": "cmo", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/commodities": { "get": { "description": "The commodities endpoint provides a daily updated list of available commodity pairs, across precious metals, livestock, softs, grains, etc.", "operationId": "GetCommodities", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "XAU/USD" }, { "description": "Filter by category of commodity", "in": "query", "name": "category", "schema": { "type": "string", "x-go-name": "Category", "x-order": "20" }, "x-go-name": "Category", "x-order": "20", "example": "Precious Metal" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "30" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "40" }, "x-go-name": "Delimiter", "x-order": "40" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "50" }, "x-go-name": "Page", "x-order": "50" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "60" }, "x-go-name": "PageSize", "x-order": "60" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommodities_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Commodities", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "60", "x-url-hash": "commodities-list" } }, "/coppock": { "get": { "description": "The Coppock Curve is a momentum oscillator used to detect potential long-term trend reversals in financial markets. It returns the calculated values of this indicator over a specified period, allowing users to identify when a security's price may be shifting from a downtrend to an uptrend. This endpoint is particularly useful for analyzing securities in bottoming markets.", "operationId": "GetTimeSeriesCoppock", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods for weighted moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "wma_period", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "WMAPeriod", "x-order": "64" }, "x-go-name": "WMAPeriod", "x-order": "64" }, { "description": "Number of periods for long term rate of change. Takes values in the range from `1` to `800`", "in": "query", "name": "long_roc_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "LongRocPeriod", "x-order": "61" }, "x-go-name": "LongRocPeriod", "x-order": "61" }, { "description": "Number of periods for short term rate of change. Takes values in the range from `1` to `800`", "in": "query", "name": "short_roc_period", "schema": { "default": 11, "format": "int64", "type": "integer", "x-go-name": "ShortRocPeriod", "x-order": "63" }, "x-go-name": "ShortRocPeriod", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCoppock_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Coppock curve", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "180", "x-url-hash": "coppock", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/correl": { "get": { "description": "The Correlation (CORREL) endpoint calculates the statistical relationship between two securities over a specified time period, returning a correlation coefficient. This coefficient ranges from -1 to 1, indicating the strength and direction of their linear relationship. A value close to 1 suggests a strong positive correlation, while a value near -1 indicates a strong negative correlation. This data is useful for identifying securities that move together or in opposite directions, aiding in strategies like diversification or pairs trading.", "operationId": "GetTimeSeriesCorrel", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "62" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "63" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "64" }, "x-go-name": "TimePeriod", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCorrel_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Correlation", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "190", "x-url-hash": "correl", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/countries": { "get": { "description": "The countries endpoint provides a comprehensive list of countries, including their ISO codes, official names, capitals, and currencies. This data is essential for applications requiring accurate country information for tasks such as localization, currency conversion, or geographic analysis.", "operationId": "GetCountries", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCountries_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Countries", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Supporting metadata", "x-order": "10", "x-url-hash": "countries" } }, "/cross_listings": { "get": { "description": "The cross_listings endpoint provides a daily updated list of cross-listed symbols for a specified financial instrument. Cross-listed symbols represent the same security available on multiple exchanges. This endpoint is useful for identifying all the exchanges where a particular security is traded, allowing users to access comprehensive trading information across different markets.", "operationId": "GetCrossListings", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "AAPL" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "20" }, "x-go-name": "Exchange", "x-order": "20", "example": "NASDAQ" }, { "description": "Market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "30" }, "x-go-name": "MicCode", "x-order": "30", "example": "XNGS" }, { "description": "Country to which stock exchange belongs to", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCrossListings_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Cross listings", "tags": [ "reference_data" ], "x-api-credits-cost": "40", "x-api-credits-type": "request", "x-group": "Reference data/Discovery", "x-order": "20", "x-starting-plan": "grow,venture", "x-url-hash": "cross-listings" } }, "/crsi": { "get": { "description": "The Connors Relative Strength Index (CRSI) endpoint provides a detailed analysis of stock momentum by combining three components: the Relative Strength Index, the Rate of Change, and the Up/Down Length. This endpoint returns a numerical value that helps identify potential trend reversals and momentum shifts in a security's price. Ideal for traders seeking to refine entry and exit points, the CRSI offers a nuanced view of market conditions beyond traditional RSI indicators.", "operationId": "GetTimeSeriesCrsi", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "63" }, { "description": "Number of periods for RSI used to calculate price momentum. Takes values in the range from `1` to `800`", "in": "query", "name": "rsi_period", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "RsiPeriod", "x-order": "62" }, "x-go-name": "RsiPeriod", "x-order": "62" }, { "description": "Number of periods for RSI used to calculate up/down trend. Takes values in the range from `1` to `800`", "in": "query", "name": "up_down_length", "schema": { "default": 2, "format": "int64", "type": "integer", "x-go-name": "UpDownLength", "x-order": "64" }, "x-go-name": "UpDownLength", "x-order": "64" }, { "description": "Number of periods used to calculate PercentRank. Takes values in the range from `1` to `800`", "in": "query", "name": "percent_rank_period", "schema": { "default": 100, "format": "int64", "type": "integer", "x-go-name": "PercentRankPeriod", "x-order": "61" }, "x-go-name": "PercentRankPeriod", "x-order": "61" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCrsi_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Connors relative strength index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "200", "x-url-hash": "crsi", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/cryptocurrencies": { "get": { "description": "The cryptocurrencies endpoint provides a daily updated list of all available cryptos. It returns an array containing detailed information about each cryptocurrency, including its symbol, name, and other relevant identifiers. This endpoint is useful for retrieving a comprehensive catalog of cryptocurrencies for applications that require up-to-date market listings or need to display available crypto assets to users.", "operationId": "GetCryptocurrencies", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "BTC/USD" }, { "description": "Filter by exchange name. E.g. `Binance`, `Coinbase`, etc.", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange" }, "x-go-name": "Exchange", "example": "Binance" }, { "description": "Filter by currency base", "in": "query", "name": "currency_base", "schema": { "type": "string", "x-go-name": "CurrencyBase" }, "x-go-name": "CurrencyBase", "example": "BTC" }, { "description": "Filter by currency quote", "in": "query", "name": "currency_quote", "schema": { "type": "string", "x-go-name": "CurrencyQuote" }, "x-go-name": "CurrencyQuote", "example": "USD" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCryptocurrencies_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Cryptocurrency pairs", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "30", "x-url-hash": "cryptocurrencies-list" } }, "/cryptocurrency_exchanges": { "get": { "description": "The cryptocurrency exchanges endpoint provides a daily updated list of available cryptocurrency exchanges. It returns an array containing details about each exchange, such as exchange names and identifiers.", "operationId": "GetCryptocurrencyExchanges", "parameters": [ { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "10" }, { "description": "Specify the delimiter used when downloading the CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "20" }, "x-go-name": "Delimiter", "x-order": "20" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCryptocurrencyExchanges_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Cryptocurrency exchanges", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Markets", "x-order": "30" } }, "/currency_conversion": { "get": { "description": "The currency conversion endpoint provides real-time exchange rates and calculates the converted amount for specified currency pairs, including both forex and cryptocurrencies. This endpoint is useful for obtaining up-to-date conversion values between two currencies, facilitating tasks such as financial reporting, e-commerce transactions, and travel budgeting.", "operationId": "GetCurrencyConversion", "parameters": [ { "description": "The currency pair you want to request can be either forex or cryptocurrency. Slash(`/`) delimiter is used. E.g. `EUR/USD` or `BTC/ETH` will be correct", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "EUR/USD" }, { "description": "Amount of base currency to be converted into quote currency. Supports values in the range from `0` and above", "in": "query", "name": "amount", "required": true, "schema": { "format": "double", "type": "number", "x-go-name": "Amount", "x-order": "20" }, "x-go-name": "Amount", "x-order": "20", "example": "100" }, { "description": "If not null, will use exchange rate from a specific date or time. Format `2006-01-02` or `2006-01-02T15:04:05`. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "30" }, "x-go-name": "Date", "x-order": "30", "example": "2006-01-02T15:04:05" }, { "description": "Value can be `JSON` or `CSV`. Default `JSON`", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "40" }, { "description": "Specify the delimiter used when downloading the `CSV` file. Default semicolon `;`", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "50" }, "x-go-name": "Delimiter", "x-order": "50" }, { "description": "The number of decimal places for the data", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "60" }, "x-go-name": "DecimalPlaces", "x-order": "60" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "type": "string", "x-go-name": "Timezone", "x-order": "60" }, "x-go-name": "Timezone", "x-order": "60", "example": "UTC" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCurrencyConversion_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Currency conversion", "tags": [ "currencies" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "Useful", "x-group": "Currencies", "x-order": "20" } }, "/dema": { "get": { "description": "The Double Exponential Moving Average (DEMA) endpoint provides a data series that calculates a moving average with reduced lag by emphasizing recent price data. This endpoint returns time-series data that includes the DEMA values for a specified financial instrument, allowing users to track price trends and identify potential trading opportunities.", "operationId": "GetTimeSeriesDema", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDema_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Double exponential moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "210", "x-url-hash": "dema", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/direct_holders": { "get": { "description": "The direct holders endpoint provides detailed information about the number of shares directly held by individuals or entities as recorded in a company's official share registry. This data is essential for understanding the distribution of stock ownership within a company, helping users identify major shareholders and assess shareholder concentration.", "operationId": "GetDirectHolders", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "7203" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectHolders_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Direct holders", "tags": [ "regulatory" ], "x-additional-notes": "This API endpoint is available on the Ultra plan (individual) and the Enterprise plan (business) and above. Support for the Tadawul exchange is currently in beta.", "x-api-credits-cost": "1500", "x-api-credits-type": "symbol", "x-badge": "New", "x-group": "Regulatory", "x-order": "50", "x-starting-plan": "ultra,enterprise", "x-url-hash": "direct-holders", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/div": { "get": { "description": "The Division (DIV) endpoint calculates the result of dividing one data series by another, providing a normalized output. It is commonly used to combine or adjust multiple technical indicators or price data for comparative analysis. This endpoint returns the division results as a time series, allowing users to easily interpret and utilize the normalized data in their financial models or charts.", "operationId": "GetTimeSeriesDiv", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "62" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDiv_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Division", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "220", "x-url-hash": "div", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/dividends": { "get": { "description": "The dividends endpoint provides historical dividend data for a specified stock, in many cases covering over a decade. It returns information on dividend payouts, including the ex-date, amount, and frequency. This endpoint is ideal for users tracking dividend histories or evaluating the income potential of stocks.", "operationId": "GetDividends", "parameters": [ { "description": "Symbol ticker of instrument. For preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "27", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "27", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "30" }, "x-go-name": "Exchange", "x-order": "30", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "40" }, "x-go-name": "MicCode", "x-order": "40", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "50" }, "x-go-name": "Country", "x-order": "50", "example": "US" }, { "description": "Specifies the time range for which to retrieve dividend data.\nAccepts values such as `last` (most recent dividend), `next` (upcoming dividend),\n`1m` - `5y` for respective periods, or `full` for all available data.\nIf provided together with `start_date` and/or `end_date`, this parameter takes precedence.", "in": "query", "name": "range", "schema": { "$ref": "#/components/schemas/RangeEnum" }, "x-go-name": "Range", "x-order": "60" }, { "description": "Start date for the dividend data query. Only dividends with dates on or after this date will be returned. Format `2006-01-02`.\nIf provided together with `range` parameter, `range` will take precedence.", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "70" }, "x-go-name": "StartDate", "x-order": "70", "example": "2024-01-01" }, { "description": "End date for the dividend data query. Only dividends with dates on or before this date will be returned. Format `2006-01-02`.\nIf provided together with `range` parameter, `range` will take precedence.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "80" }, "x-go-name": "EndDate", "x-order": "80", "example": "2024-12-31" }, { "description": "Specifies if there should be an adjustment", "in": "query", "name": "adjust", "schema": { "default": true, "type": "boolean", "x-go-name": "Adjust", "x-order": "90" }, "x-go-name": "Adjust", "x-order": "90" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDividends_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Dividends", "tags": [ "fundamentals" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "30", "x-starting-plan": "grow,venture", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/dividends_calendar": { "get": { "description": "The dividends calendar endpoint provides a detailed schedule of upcoming and past dividend events for specified date ranges. By using the `start_date` and `end_date` parameters, users can retrieve a list of companies issuing dividends, including the ex-dividend date and dividend amount. This endpoint is ideal for tracking dividend payouts and planning investment strategies based on dividend schedules.", "operationId": "GetDividendsCalendar", "parameters": [ { "description": "Symbol ticker of instrument. For preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "1" }, "x-go-name": "Symbol", "x-order": "1", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "2" }, "x-go-name": "Figi", "x-order": "2", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "3" }, "x-go-name": "Isin", "x-order": "3", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "4" }, "x-go-name": "Cusip", "x-order": "4", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "10" }, "x-go-name": "Exchange", "x-order": "10", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "20" }, "x-go-name": "MicCode", "x-order": "20", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "US" }, { "description": "Start date for the dividends calendar query. Only dividends with ex-dates on or after this date will be returned. Format `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "40" }, "x-go-name": "StartDate", "x-order": "40", "example": "2024-01-01" }, { "description": "End date for the dividends calendar query. Only dividends with ex-dates on or before this date will be returned. Format `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "50" }, "x-go-name": "EndDate", "x-order": "50", "example": "2024-12-31" }, { "description": "Number of data points to retrieve.\nSupports values in the range from `1` to `500`.\nDefault `100` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 100, "format": "int64", "type": "integer", "x-go-name": "Outputsize", "x-order": "60" }, "x-go-name": "Outputsize", "x-order": "60" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "70" }, "x-go-name": "Page", "x-order": "70" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DividendsCalendarItem" }, "type": "array" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Dividends calendar", "tags": [ "fundamentals" ], "x-api-credits-cost": "40", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "40", "x-starting-plan": "grow,venture" } }, "/dpo": { "get": { "description": "The Detrended Price Oscillator (DPO) endpoint calculates and returns the DPO values for a specified financial instrument over a given time period. This endpoint helps traders by highlighting short-term price cycles and identifying potential overbought or oversold conditions without the influence of long-term trends. The response includes a series of DPO values, which can be used to assess price momentum and cyclical patterns in the market.", "operationId": "GetTimeSeriesDpo", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specifies if there should be a shift to match the current price", "in": "query", "name": "centered", "schema": { "default": false, "type": "boolean", "x-go-name": "Centered", "x-order": "62" }, "x-go-name": "Centered", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDpo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Detrended price oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "230", "x-url-hash": "dpo", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/dx": { "get": { "description": "Retrieve the Directional Movement Index (DX) values for a given security to assess the strength of its positive and negative price movements. This endpoint provides a time series of DX values, which are useful for evaluating the momentum and trend direction of the security over a specified period.", "operationId": "GetTimeSeriesDx", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDx_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Directional movement index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "240", "x-url-hash": "dx", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/earliest_timestamp": { "get": { "description": "The earliest_timestamp endpoint provides the earliest available date and time for a specified financial instrument at a given data interval. This endpoint is useful for determining the starting point of historical data availability for various assets, such as stocks or currencies, allowing users to understand the time range covered by the data.", "operationId": "GetEarliestTimestamp", "parameters": [ { "description": "Symbol ticker of the instrument.", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9XRY4" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series.", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1day" }, { "description": "Exchange where instrument is traded.", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "Nasdaq" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone" }, "x-go-name": "Timezone" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarliestTimestamp_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Earliest timestamp", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Discovery", "x-order": "30", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/earnings": { "get": { "description": "The earnings endpoint provides comprehensive earnings data for a specified company, including both the estimated and actual Earnings Per Share (EPS) figures. This endpoint delivers historical earnings information, allowing users to track a company's financial performance over time.", "operationId": "GetEarnings", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Type of earning, returns only 1 record.\nWhen is not empty, dates and outputsize parameters are ignored", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEarningsEnum" }, "x-go-name": "Period", "x-order": "80" }, { "description": "Number of data points to retrieve.\nSupports values in the range from `1` to `1000`.\nDefault `10` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "90" }, "x-go-name": "PageSize", "x-order": "90" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "100" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "110" }, "x-go-name": "Delimiter", "x-order": "110" }, { "description": "The date from which the data is requested. The date format is `YYYY-MM-DD`.", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "140" }, "x-go-name": "StartDate", "x-order": "140", "example": "2024-04-01" }, { "description": "The date to which the data is requested. The date format is `YYYY-MM-DD`.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "150" }, "x-go-name": "EndDate", "x-order": "150", "example": "2024-04-30" }, { "description": "The number of decimal places in the response data. Should be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 2, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "130" }, "x-go-name": "DecimalPlaces", "x-order": "130" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarnings_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Earnings", "tags": [ "fundamentals" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "70", "x-starting-plan": "grow,venture", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/earnings_calendar": { "get": { "description": "The earnings calendar endpoint provides a schedule of company earnings announcements for a specified date range. By default, it returns earnings data for the current day. Users can customize the date range using the `start_date` and `end_date` parameters to retrieve earnings information for specific periods. This endpoint is useful for tracking upcoming earnings reports and planning around key financial announcements.", "operationId": "GetEarningsCalendar", "parameters": [ { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "10" }, "x-go-name": "Exchange", "x-order": "10", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "20" }, "x-go-name": "MicCode", "x-order": "20", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "United States" }, { "description": "Value can be JSON or CSV", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "40" }, { "description": "Specify the delimiter used when downloading the CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "50" }, "x-go-name": "Delimiter", "x-order": "50" }, { "description": "Can be used separately and together with end_date.\nFormat `2006-01-02` or `2006-01-02T15:04:05`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "70" }, "x-go-name": "StartDate", "x-order": "70", "example": "2024-04-01" }, { "description": "Can be used separately and together with start_date.\nFormat `2006-01-02` or `2006-01-02T15:04:05`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "80" }, "x-go-name": "EndDate", "x-order": "80", "example": "2024-04-30" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 2, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "60" }, "x-go-name": "DecimalPlaces", "x-order": "60" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarningsCalendar_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Earnings calendar", "tags": [ "fundamentals" ], "x-api-credits-cost": "40", "x-api-credits-type": "request", "x-group": "Fundamentals", "x-order": "80", "x-starting-plan": "grow,venture" } }, "/earnings_estimate": { "get": { "description": "The earnings estimate endpoint provides access to analysts' projected earnings per share (EPS) for a specific company, covering both upcoming quarterly and annual periods. This data is crucial for users who need to track and compare expected financial performance across different timeframes, aiding in the evaluation of a company's future profitability.", "operationId": "GetEarningsEstimate", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Earnings estimate", "tags": [ "analysis" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-badge": "Useful", "x-group": "Analysis", "x-order": "10", "x-starting-plan": "ultra,enterprise", "x-url-hash": "earning-estimate", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/edgar_filings/archive": { "get": { "description": "The EDGAR fillings endpoint provides access to a comprehensive collection of financial documents submitted to the SEC, including real-time and historical forms, filings, and exhibits. Users can retrieve detailed information about company disclosures, financial statements, and regulatory submissions, enabling them to access essential compliance and financial data directly from the SEC's EDGAR system.", "operationId": "GetEdgarFilingsArchive", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNGS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Filter by form types, example `8-K`, `EX-1.1`", "in": "query", "name": "form_type", "schema": { "type": "string", "x-go-name": "FormType", "x-order": "70" }, "x-go-name": "FormType", "x-order": "70", "example": "8-K" }, { "description": "Filter by filled date from", "in": "query", "name": "filled_from", "schema": { "type": "string", "x-go-name": "FilledFrom", "x-order": "80" }, "x-go-name": "FilledFrom", "x-order": "80", "example": "2024-01-01" }, { "description": "Filter by filled date to", "in": "query", "name": "filled_to", "schema": { "type": "string", "x-go-name": "FilledTo", "x-order": "90" }, "x-go-name": "FilledTo", "x-order": "90", "example": "2024-01-01" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "100" }, "x-go-name": "Page", "x-order": "100" }, { "description": "Number of records in response", "in": "query", "name": "page_size", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "110" }, "x-go-name": "PageSize", "x-order": "110" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEdgarFilingsArchive_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "EDGAR fillings", "tags": [ "regulatory" ], "x-api-credits-cost": "50", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Regulatory", "x-order": "10", "x-starting-plan": "ultra,enterprise", "x-url-hash": "edgar-filings-archive", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/ema": { "get": { "description": "The Exponential Moving Average (EMA) endpoint calculates the EMA for a specified financial instrument over a given time period. It returns a time series of EMA values, which highlight recent price trends by weighting recent data more heavily. This is useful for traders seeking to identify trend directions and potential trade opportunities based on recent price movements.", "operationId": "GetTimeSeriesEma", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesEma_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Exponential moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Overlap studies", "x-order": "250", "x-url-hash": "ema", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/eod": { "get": { "description": "The End of Day (EOD) Prices endpoint provides the closing price and other relevant metadata for a financial instrument at the end of a trading day. This endpoint is useful for retrieving daily historical data for stocks, ETFs, or other securities, allowing users to track performance over time and compare daily market movements.", "operationId": "GetEod", "parameters": [ { "description": "Symbol ticker of the instrument", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BHTMY7" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "30" }, "x-go-name": "Exchange", "x-order": "30", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "40" }, "x-go-name": "MicCode", "x-order": "40", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "50" }, "x-go-name": "Country", "x-order": "50", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "60", "example": "ETF" }, { "description": "If not null, then return data from a specific date", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "70" }, "x-go-name": "Date", "x-order": "70", "example": "2006-01-02" }, { "description": "Parameter is optional. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "80" }, "x-go-name": "Prepost", "x-order": "80" }, { "description": "Specifies the number of decimal places for floating values\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "90" }, "x-go-name": "DecimalPlaces", "x-order": "90" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEod_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "End of day price", "tags": [ "market_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Market data", "x-order": "70", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/eps_revisions": { "get": { "description": "The EPS revisions endpoint provides updated analyst forecasts for a company's earnings per share (EPS) on both a quarterly and annual basis. It delivers data on how these EPS predictions have changed over the past week and month, allowing users to track recent adjustments in analyst expectations. This endpoint is useful for monitoring shifts in market sentiment regarding a company's financial performance.", "operationId": "GetEpsRevisions", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEpsRevisions_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "EPS revisions", "tags": [ "analysis" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "40", "x-starting-plan": "ultra,enterprise", "x-url-hash": "eps-revisions", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/eps_trend": { "get": { "description": "The EPS trend endpoint provides detailed historical data on Earnings Per Share (EPS) trends over specified periods. It returns a comprehensive breakdown of estimated EPS changes, allowing users to track and analyze the progression of a company's earnings performance over time. This endpoint is ideal for users seeking to understand historical EPS fluctuations and assess financial growth patterns.", "operationId": "GetEpsTrend", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEpsTrend_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "EPS trend", "tags": [ "analysis" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "30", "x-starting-plan": "ultra,enterprise", "x-url-hash": "eps-trend", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/etfs": { "get": { "description": "The ETFs endpoint provides a daily updated list of all available Exchange-Traded Funds. It returns an array containing detailed information about each ETF, including its symbol, name, and other relevant identifiers. This endpoint is useful for retrieving a comprehensive catalog of ETFs for portfolio management, investment tracking, or financial analysis.", "operationId": "GetEtf", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "SPY" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi" }, "x-go-name": "Figi", "example": "BBG000BDTF76" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin" }, "x-go-name": "Isin", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip" }, "x-go-name": "Cusip", "example": "594918104" }, { "description": "The CIK of an instrument for which data is requested", "in": "query", "name": "cik", "schema": { "type": "string", "x-go-name": "Cik" }, "x-go-name": "Cik", "example": "95953" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange" }, "x-go-name": "Exchange", "example": "NYSE" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode" }, "x-go-name": "MicCode", "example": "XNYS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country" }, "x-go-name": "Country", "example": "United States" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Adds info on which plan symbol is available", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan" }, "x-go-name": "ShowPlan" }, { "description": "Include delisted identifiers", "in": "query", "name": "include_delisted", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeDelisted" }, "x-go-name": "IncludeDelisted" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEtf_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "ETFs", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "40", "x-url-hash": "etf-list" } }, "/etfs/family": { "get": { "description": "Retrieve a comprehensive list of exchange-traded fund (ETF) families, providing users with detailed information on various ETF groups available in the market. This endpoint is ideal for users looking to explore different ETF categories, compare offerings, or integrate ETF family data into their financial applications.", "operationId": "GetETFsFamily", "parameters": [ { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "10" }, "x-go-name": "Country", "x-order": "10", "example": "United States" }, { "description": "Filter by investment company that manages the fund", "in": "query", "name": "fund_family", "schema": { "type": "string", "x-go-name": "FundFamily", "x-order": "20" }, "x-go-name": "FundFamily", "x-order": "20", "example": "iShares" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsFamily_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "ETFs families", "tags": [ "etfs" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "ETFs", "x-order": "70", "x-url-hash": "etf-family-list" } }, "/etfs/list": { "get": { "description": "The ETFs directory endpoint provides a daily updated list of exchange-traded funds, sorted by total assets in descending order. This endpoint is useful for retrieving comprehensive ETF data, including fund names and asset values, to assist users in quickly identifying the ETFs available.", "operationId": "GetETFsList", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi" }, "x-go-name": "Figi", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin" }, "x-go-name": "Isin", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip" }, "x-go-name": "Cusip", "example": "464287200" }, { "description": "The CIK of an instrument for which data is requested", "in": "query", "name": "cik", "schema": { "type": "string", "x-go-name": "Cik" }, "x-go-name": "Cik", "example": "95953" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country" }, "x-go-name": "Country", "example": "United States" }, { "description": "Filter by investment company that manages the fund", "in": "query", "name": "fund_family", "schema": { "type": "string", "x-go-name": "FundFamily" }, "x-go-name": "FundFamily", "example": "iShares" }, { "description": "Filter by the type of fund", "in": "query", "name": "fund_type", "schema": { "type": "string", "x-go-name": "FundType" }, "x-go-name": "FundType", "example": "Large Blend" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Number of decimal places for floating values", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp" }, "x-go-name": "Dp" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 50, "format": "int64", "type": "integer", "x-go-name": "OutputSize" }, "x-go-name": "OutputSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsList_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "ETFs directory", "tags": [ "etfs" ], "x-additional-notes": "Basic, Grow, and Pro plans (individual) and Venture plan (business) return up to 50 records. For complete data on over 40,000 ETFs, upgrade to the Ultra plan (individual), Enterprise (business), or Custom plan (business).", "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "Useful", "x-group": "ETFs", "x-order": "10", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etfs-list" } }, "/etfs/type": { "get": { "description": "The ETFs Types endpoint provides a concise list of ETF categories by market (e.g., Singapore, United States), including types like \"Equity Precious Metals\" and \"Large Blend.\" It supports targeted investment research and portfolio diversification.", "operationId": "GetETFsType", "parameters": [ { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "10" }, "x-go-name": "Country", "x-order": "10", "example": "United States" }, { "description": "Filter by the type of fund", "in": "query", "name": "fund_type", "schema": { "type": "string", "x-go-name": "FundType", "x-order": "20" }, "x-go-name": "FundType", "x-order": "20", "example": "Large Blend" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsType_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "ETFs types", "tags": [ "etfs" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "ETFs", "x-order": "80", "x-url-hash": "etf-type-list" } }, "/etfs/world": { "get": { "description": "The ETF full data endpoint provides detailed information about global Exchange-Traded Funds. It returns comprehensive data, including a summary, performance metrics, risk assessment, and composition details. This endpoint is ideal for users seeking an in-depth analysis of worldwide ETFs, enabling them to access key financial metrics and portfolio breakdowns.", "operationId": "GetETFsWorld", "parameters": [ { "description": "Symbol ticker of etf", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "464287200" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "50" }, "x-go-name": "Dp", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorld_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "ETF full data", "tags": [ "etfs" ], "x-api-credits-cost": "800", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "ETFs", "x-order": "20", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etf-all-data", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/etfs/world/composition": { "get": { "description": "The ETFs composition endpoint provides detailed information about the composition of global Exchange-Traded Funds. It returns data on the sectors included in the ETF, specific holding details, and the weighted exposure of each component. This endpoint is useful for users who need to understand the specific makeup and sector distribution of an ETF portfolio.", "operationId": "GetETFsWorldComposition", "parameters": [ { "description": "Symbol ticker of etf", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "464287200" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "50" }, "x-go-name": "Dp", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldComposition_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Composition", "tags": [ "etfs" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "ETFs", "x-order": "60", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etf-composition", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/etfs/world/performance": { "get": { "description": "The ETFs performance endpoint provides comprehensive performance data for exchange-traded funds globally. It returns detailed metrics such as trailing returns and annual returns, enabling users to evaluate the historical performance of various ETFs. This endpoint is ideal for users looking to compare ETF performance over different time periods and assess their investment potential.", "operationId": "GetETFsWorldPerformance", "parameters": [ { "description": "Symbol ticker of etf", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "464287200" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "50" }, "x-go-name": "Dp", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldPerformance_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Performance", "tags": [ "etfs" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "ETFs", "x-order": "40", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etf-performance", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/etfs/world/risk": { "get": { "description": "The ETFs risk endpoint provides essential risk metrics for global Exchange Traded Funds. It returns data such as volatility, beta, and other risk-related indicators, enabling users to assess the potential risk associated with investing in various ETFs worldwide.", "operationId": "GetETFsWorldRisk", "parameters": [ { "description": "Symbol ticker of etf", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "464287200" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "50" }, "x-go-name": "Dp", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldRisk_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Risk", "tags": [ "etfs" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "ETFs", "x-order": "50", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etf-risk", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/etfs/world/summary": { "get": { "description": "The ETFs summary endpoint provides a concise overview of global Exchange-Traded Funds. It returns key data points such as ETF names, symbols, and current market values, enabling users to quickly assess the performance and status of various international ETFs. This summary is ideal for users who need a snapshot of the global ETF landscape without delving into detailed analysis.", "operationId": "GetETFsWorldSummary", "parameters": [ { "description": "Symbol ticker of etf", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IVV" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BVZ697" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US4642872000" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "464287200" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "50" }, "x-go-name": "Dp", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldSummary_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Summary", "tags": [ "etfs" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "ETFs", "x-order": "30", "x-starting-plan": "ultra,enterprise", "x-url-hash": "etf-summary", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/exchange_rate": { "get": { "description": "The exchange rate endpoint provides real-time exchange rates for specified currency pairs, including both forex and cryptocurrency. It returns the current exchange rate value between two currencies, allowing users to quickly access up-to-date conversion rates for financial transactions or market analysis.", "operationId": "GetExchangeRate", "parameters": [ { "description": "The currency pair you want to request can be either forex or cryptocurrency. Slash(`/`) delimiter is used. E.g. `EUR/USD` or `BTC/ETH` will be correct", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "EUR/USD" }, { "description": "If not null, will use exchange rate from a specific date or time. Format `2006-01-02` or `2006-01-02T15:04:05`. Is set in the local exchange time zone, use timezone parameter to specify a specific time zone", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "20" }, "x-go-name": "Date", "x-order": "20", "example": "2006-01-02T15:04:05" }, { "description": "Value can be `JSON` or `CSV`. Default `JSON`", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "30" }, { "description": "Specify the delimiter used when downloading the `CSV` file. Default semicolon `;`", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "40" }, "x-go-name": "Delimiter", "x-order": "40" }, { "description": "The number of decimal places for the data", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "type": "string", "x-go-name": "Timezone", "x-order": "60" }, "x-go-name": "Timezone", "x-order": "60", "example": "UTC" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeRate_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Exchange rate", "tags": [ "currencies" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Currencies", "x-order": "10" } }, "/exchange_schedule": { "get": { "description": "The exchanges schedule endpoint provides detailed information about various stock exchanges, including their trading hours and operational days. This data is essential for users who need to know when specific exchanges are open for trading, allowing them to plan their activities around the availability of these markets.", "operationId": "GetExchangeSchedule", "parameters": [ { "description": "Filter by exchange name", "in": "query", "name": "mic_name", "schema": { "type": "string", "x-go-name": "MicName", "x-order": "20" }, "x-go-name": "MicName", "x-order": "20", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "30" }, "x-go-name": "MicCode", "x-order": "30", "example": "XNGS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "

\nIf a date is provided, the API returns the schedule for the specified date; otherwise, it returns the default (common) schedule.\n

\nThe date can be specified in one of the following formats:\n\nWhen using a datetime value, the resulting schedule will correspond to the local calendar day at the specified time.\nFor example, 2025-04-11T20:00:00 UTC corresponds to:\n", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "10" }, "x-go-name": "Date", "x-order": "10", "example": "2021-10-27" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeSchedule_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Exchanges schedule", "tags": [ "reference_data" ], "x-api-credits-cost": "100", "x-api-credits-type": "request", "x-group": "Reference data/Markets", "x-order": "20", "x-starting-plan": "ultra,enterprise", "x-url-hash": "exchange-schedule" } }, "/exchanges": { "get": { "description": "The exchanges endpoint provides a comprehensive list of all available equity exchanges. It returns an array containing detailed information about each exchange, such as exchange code, name, country, and timezone. This data is updated daily.", "operationId": "GetExchanges", "parameters": [ { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "10", "example": "ETF" }, { "description": "Filter by exchange name", "in": "query", "name": "name", "schema": { "type": "string", "x-go-name": "Name", "x-order": "20" }, "x-go-name": "Name", "x-order": "20", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "code", "schema": { "type": "string", "x-go-name": "Code", "x-order": "30" }, "x-go-name": "Code", "x-order": "30", "example": "XBUE" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "50" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "60" }, "x-go-name": "Delimiter", "x-order": "60" }, { "description": "Adds info on which plan symbol is available", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan", "x-order": "70" }, "x-go-name": "ShowPlan", "x-order": "70" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchanges_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Exchanges", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "Reference data/Markets", "x-order": "10" } }, "/exp": { "get": { "description": "The Exponential (EXP) Indicator endpoint computes the exponential value of a specified input, providing a numerical result that is commonly applied in complex mathematical and financial computations.", "operationId": "GetTimeSeriesExp", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesExp_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Exponential", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "260", "x-url-hash": "exp", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/floor": { "get": { "description": "The Floor (FLOOR) endpoint processes numerical input data by rounding each value down to the nearest integer. It returns a series of adjusted data points that can be used for further calculations or combined with other datasets. This endpoint is useful for users needing to simplify data by removing decimal precision, aiding in scenarios where integer values are required.", "operationId": "GetTimeSeriesFloor", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesFloor_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Floor", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "270", "x-url-hash": "floor", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/forex_pairs": { "get": { "description": "The forex pairs endpoint provides a comprehensive list of all available foreign exchange currency pairs. It returns an array of forex pairs, which is updated daily.", "operationId": "GetForexPairs", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "EUR/USD" }, { "description": "Filter by currency base", "in": "query", "name": "currency_base", "schema": { "type": "string", "x-go-name": "CurrencyBase" }, "x-go-name": "CurrencyBase", "example": "EUR" }, { "description": "Filter by currency quote", "in": "query", "name": "currency_quote", "schema": { "type": "string", "x-go-name": "CurrencyQuote" }, "x-go-name": "CurrencyQuote", "example": "USD" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetForexPairs_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Forex pairs", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "20", "x-url-hash": "forex-pairs-list" } }, "/fund_holders": { "get": { "description": "The fund holders endpoint provides detailed information about the proportion of a company's stock that is owned by mutual fund holders. It returns data on the number of shares held, the percentage of total shares outstanding, and the names of the mutual funds involved. This endpoint is useful for users looking to understand mutual fund investment in a specific company.", "operationId": "GetFundHolders", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFundHolders_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Fund holders", "tags": [ "regulatory" ], "x-api-credits-cost": "1500", "x-api-credits-type": "symbol", "x-group": "Regulatory", "x-order": "40", "x-starting-plan": "ultra,enterprise", "x-url-hash": "fund-holders", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/funds": { "get": { "description": "The funds endpoint provides a daily updated list of available investment funds. It returns an array containing detailed information about each fund, including identifiers, names, and other relevant attributes.", "operationId": "GetFunds", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "FXAIX" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi" }, "x-go-name": "Figi", "example": "BBG000BHTMY7" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin" }, "x-go-name": "Isin", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip" }, "x-go-name": "Cusip", "example": "594918104" }, { "description": "The CIK of an instrument for which data is requested", "in": "query", "name": "cik", "schema": { "type": "string", "x-go-name": "Cik" }, "x-go-name": "Cik", "example": "95953" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange" }, "x-go-name": "Exchange", "example": "Nasdaq" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country" }, "x-go-name": "Country", "example": "United States" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Adds info on which plan symbol is available", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan" }, "x-go-name": "ShowPlan" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "default": 5000, "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFunds_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Funds", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "50", "x-url-hash": "funds-list" } }, "/growth_estimates": { "get": { "description": "The growth estimates endpoint provides consensus analyst projections on a company's growth rates over various timeframes. It aggregates and averages estimates from multiple analysts, focusing on key financial metrics such as earnings per share and revenue. This endpoint is useful for obtaining a comprehensive view of expected company performance based on expert analysis.", "operationId": "GetGrowthEstimates", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "40", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "40", "x-required-group": "symbol", "example": "594918104" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "50" }, "x-go-name": "Country", "x-order": "50", "example": "United States" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "60" }, "x-go-name": "Exchange", "x-order": "60", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "70" }, "x-go-name": "MicCode", "x-order": "70", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGrowthEstimates_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Growth estimates", "tags": [ "analysis" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "50", "x-starting-plan": "ultra,enterprise", "x-url-hash": "growth-estimates", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/heikinashicandles": { "get": { "description": "The heikinashi candles endpoint provides smoothed candlestick data by averaging price information to reduce market noise. It returns a series of Heikin Ashi candles, which include open, high, low, and close values, making it easier to identify trends and potential reversals in asset prices. This endpoint is useful for traders and analysts seeking a clearer view of market trends without the volatility present in traditional candlestick charts.", "operationId": "GetTimeSeriesHeikinashiCandles", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Heikinashi candles", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "280", "x-url-hash": "heikinashicandles", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/hlc3": { "get": { "description": "The High, Low, Close Average (HLC3) endpoint calculates and returns the average of a security's high, low, and close prices for a specified period. This endpoint provides a straightforward metric to assess price trends, helping users quickly identify the average price level of a security over time.", "operationId": "GetTimeSeriesHlc3", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHlc3_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "High, low, close average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "290", "x-url-hash": "hlc3", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_dcperiod": { "get": { "description": "The Hilbert Transform Dominant Cycle Period (HT_DCPERIOD) endpoint calculates the dominant cycle length of a financial instrument's price data. It returns a numerical value representing the cycle period, which traders can use to identify prevailing market cycles and adjust their trading strategies accordingly.", "operationId": "GetTimeSeriesHtDcPeriod", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPeriod_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform dominant cycle period", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Cycle indicators", "x-order": "300", "x-url-hash": "ht-dcperiod", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_dcphase": { "get": { "description": "The Hilbert Transform Dominant Cycle Phase (HT_DCPHASE) endpoint provides the current phase of the dominant market cycle for a given financial instrument. It returns numerical data indicating the phase angle, which can be used by traders to identify potential market entry and exit points based on cyclical patterns.", "operationId": "GetTimeSeriesHtDcPhase", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPhase_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform dominant cycle phase", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Cycle indicators", "x-order": "305", "x-url-hash": "ht-dcphase", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_phasor": { "get": { "description": "The Hilbert Transform Phasor Components (HT_PHASOR) endpoint analyzes a price series to return two key components: in-phase and quadrature. These components help identify cyclical patterns and the direction of trends in the data. Use this endpoint to gain precise insights into the timing and strength of market cycles, enhancing your ability to track and predict price movements.", "operationId": "GetTimeSeriesHtPhasor", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtPhasor_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform phasor components", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Cycle indicators", "x-order": "310", "x-url-hash": "ht-phasor", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_sine": { "get": { "description": "The Hilbert Transform Sine Wave (HT_SINE) endpoint provides sine and cosine wave components derived from the dominant market cycle. This data helps traders pinpoint potential market turning points and assess trend directions by analyzing cyclical patterns.", "operationId": "GetTimeSeriesHtSine", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtSine_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform sine wave", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Cycle indicators", "x-order": "320", "x-url-hash": "ht-sine", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_trendline": { "get": { "description": "The Hilbert Transform Instantaneous Trendline (HT_TRENDLINE) endpoint provides a smoothed moving average that aligns with the dominant market cycle. It returns data points that help traders identify current market trends and determine potential entry or exit points in trading.", "operationId": "GetTimeSeriesHtTrendline", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendline_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform instantaneous trendline", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "330", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ht_trendmode": { "get": { "description": "The Hilbert Transform Trend vs Cycle Mode (HT_TRENDMODE) endpoint identifies whether a market is in a trending or cyclical phase. It returns data indicating the current market phase, allowing users to adjust their trading strategies based on the prevailing conditions.", "operationId": "GetTimeSeriesHtTrendMode", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendMode_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Hilbert transform trend vs cycle mode", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Cycle indicators", "x-order": "340", "x-url-hash": "ht-trendmode", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ichimoku": { "get": { "description": "The Ichimoku Cloud endpoint provides data on the Ichimoku Kinko Hyo indicator, offering insights into trend direction, support and resistance levels, and potential entry and exit points. It returns key components such as the Tenkan-sen, Kijun-sen, Senkou Span A, Senkou Span B, and Chikou Span. This data helps users evaluate market trends and identify strategic trading opportunities.", "operationId": "GetTimeSeriesIchimoku", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The time period used for generating the conversation line. Takes values in the range from `1` to `800`", "in": "query", "name": "conversion_line_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "ConversionLinePeriod", "x-order": "61" }, "x-go-name": "ConversionLinePeriod", "x-order": "61" }, { "description": "The time period used for generating the base line. Takes values in the range from `1` to `800`", "in": "query", "name": "base_line_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "BaseLinePeriod", "x-order": "62" }, "x-go-name": "BaseLinePeriod", "x-order": "62" }, { "description": "The time period used for generating the leading span B line. Takes values in the range from `1` to `800`", "in": "query", "name": "leading_span_b_period", "schema": { "default": 52, "format": "int64", "type": "integer", "x-go-name": "LeadingSpanBPeriod", "x-order": "63" }, "x-go-name": "LeadingSpanBPeriod", "x-order": "63" }, { "description": "The time period used for generating the lagging span line. Takes values in the range from `1` to `800`", "in": "query", "name": "lagging_span_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "LaggingSpanPeriod", "x-order": "64" }, "x-go-name": "LaggingSpanPeriod", "x-order": "64" }, { "description": "Indicates whether to include ahead span period", "in": "query", "name": "include_ahead_span_period", "schema": { "default": true, "type": "boolean", "x-go-name": "IncludeAheadSpanPeriod", "x-order": "65" }, "x-go-name": "IncludeAheadSpanPeriod", "x-order": "65" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesIchimoku_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Ichimoku cloud", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "350", "x-url-hash": "ichimoku", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/income_statement": { "get": { "description": "The income statement endpoint provides detailed financial data on a company's income statement, including revenues, expenses, and net income for specified periods, either annually or quarterly. This endpoint is essential for retrieving comprehensive financial performance metrics of a company, allowing users to access historical and current financial results.", "operationId": "GetIncomeStatement", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the income statement data", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70", "example": "annual" }, { "description": "Begin date for filtering income statements by fiscal date.\nReturns income statements with fiscal dates on or after this date.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2024-01-01" }, { "description": "End date for filtering income statements by fiscal date.\nReturns income statements with fiscal dates on or before this date.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2024-12-31" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "100" }, "x-go-name": "PageSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncomeStatement_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Income statement", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Pro plan (individual) and the Venture plan (business) and above. Full access to historical data requires the Ultra plan (individual) or the Enterprise plan (business).", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Fundamentals", "x-order": "110", "x-starting-plan": "pro,venture", "x-url-hash": "income-statement", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/income_statement/consolidated": { "get": { "description": "The income statement consolidated endpoint provides a company's raw income statement, detailing revenue, expenses, and net income for specified periods, either annually or quarterly. This data is essential for evaluating a company's financial performance over time, allowing users to access comprehensive financial results in a structured format.", "operationId": "GetIncomeStatementConsolidated", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The reporting period for the income statement data", "in": "query", "name": "period", "schema": { "$ref": "#/components/schemas/PeriodEnum" }, "x-go-name": "Period", "x-order": "70" }, { "description": "Begin date for filtering income statements by fiscal date.\nReturns income statements with fiscal dates on or after this date.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2024-01-01" }, { "description": "End date for filtering income statements by fiscal date.\nReturns income statements with fiscal dates on or before this date.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2024-12-31" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 6, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncomeStatementConsolidated_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Income statement consolidated", "tags": [ "fundamentals" ], "x-additional-notes": "This API endpoint is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "120", "x-starting-plan": "ultra,enterprise", "x-url-hash": "income-statement-consolidated", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/insider_transactions": { "get": { "description": "The insider transaction endpoint provides detailed data on trades executed by company insiders, such as executives and directors. It returns information including the insider's name, their role, the transaction type, the number of shares, the transaction date, and the price per share. This endpoint is useful for tracking insider activity and understanding potential insider sentiment towards a company's stock.", "operationId": "GetInsiderTransactions", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested, e.g., `AAPL`, `TSLA`.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded, e.g., `Nasdaq`, `NSE`", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., United States or US.", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInsiderTransactions_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Insider transaction", "tags": [ "regulatory" ], "x-api-credits-cost": "200", "x-api-credits-type": "symbol", "x-group": "Regulatory", "x-order": "20", "x-starting-plan": "pro,venture", "x-url-hash": "insider-transactions", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/institutional_holders": { "get": { "description": "The institutional holders endpoint provides detailed information on the percentage and amount of a company's stock owned by institutional investors, such as pension funds, insurance companies, and investment firms. This data is essential for understanding the influence and involvement of large entities in a company's ownership structure.", "operationId": "GetInstitutionalHolders", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInstitutionalHolders_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Institutional holders", "tags": [ "regulatory" ], "x-api-credits-cost": "1500", "x-api-credits-type": "symbol", "x-group": "Regulatory", "x-order": "30", "x-starting-plan": "ultra,enterprise", "x-url-hash": "institutional-holders", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/instrument_type": { "get": { "description": "The instrument type endpoint lists all available financial instrument types, such as stocks, ETFs, and cryptos. This information is essential for users to identify and categorize different financial instruments when accessing or analyzing market data.", "operationId": "GetInstrumentType", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInstrumentType_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Instrument type", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Supporting metadata", "x-order": "20", "x-url-hash": "instrument-type" } }, "/intervals": { "get": { "description": "The intervals endpoint provides a list of supported time intervals that can be used for querying financial data.", "operationId": "GetIntervals", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntervals_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Intervals List", "tags": [ "reference_data" ] } }, "/ipo_calendar": { "get": { "description": "The IPO Calendar endpoint provides detailed information on initial public offerings (IPOs), including those that have occurred in the past, are happening today, or are scheduled for the future. Users can access data such as company names, IPO dates, and offering details, allowing them to track and monitor IPO activity efficiently.", "operationId": "GetIpoCalendar", "parameters": [ { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "10" }, "x-go-name": "Exchange", "x-order": "10", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "20" }, "x-go-name": "MicCode", "x-order": "20", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "United States" }, { "description": "The earliest IPO date to include in the results. Format: `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "40" }, "x-go-name": "StartDate", "x-order": "40", "example": "2021-01-01" }, { "description": "The latest IPO date to include in the results. Format: `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "50" }, "x-go-name": "EndDate", "x-order": "50", "example": "2021-12-31" } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "$ref": "#/components/schemas/GetIpoCalendar_200_response_value_inner" }, "type": "array" }, "type": "object" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "IPO calendar", "tags": [ "fundamentals" ], "x-api-credits-cost": "40", "x-api-credits-type": "request", "x-group": "Fundamentals", "x-order": "90", "x-starting-plan": "grow,venture" } }, "/kama": { "get": { "description": "The Kaufman Adaptive Moving Average (KAMA) endpoint calculates the KAMA for a specified financial instrument, returning a time series of values that reflect the average price adjusted for market volatility. This endpoint helps users identify trends by smoothing out price fluctuations while remaining sensitive to significant price movements.", "operationId": "GetTimeSeriesKama", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKama_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Kaufman adaptive moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "360", "x-url-hash": "kama", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/keltner": { "get": { "description": "The Keltner Channel endpoint provides data for a volatility-based technical indicator that combines the Exponential Moving Average (EMA) and the Average True Range (ATR) to form a channel around a security's price. This endpoint returns the upper, middle, and lower bands of the channel, which can be used to identify potential overbought or oversold conditions, assess trend direction, and detect possible price breakouts.", "operationId": "GetTimeSeriesKeltner", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 20, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "61" }, "x-go-name": "TimePeriod", "x-order": "61" }, { "description": "The time period used for calculating the Average True Range. Takes values in the range from `1` to `800`", "in": "query", "name": "atr_time_period", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "ATRTimePeriod", "x-order": "62" }, "x-go-name": "ATRTimePeriod", "x-order": "62" }, { "description": "The factor used to adjust the indicator's sensitivity", "in": "query", "name": "multiplier", "schema": { "default": 2, "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": "63" }, "x-go-name": "Multiplier", "x-order": "63" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "64" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "65" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKeltner_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Keltner channel", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "370", "x-url-hash": "keltner", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/key_executives": { "get": { "description": "The key executives endpoint provides detailed information about a company's key executives identified by a specific stock symbol. It returns data such as names, titles, and roles of the executives, which can be useful for understanding the leadership structure of the company.", "operationId": "GetKeyExecutives", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKeyExecutives_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Key executives", "tags": [ "fundamentals" ], "x-api-credits-cost": "1000", "x-api-credits-type": "symbol", "x-badge": "Useful", "x-group": "Fundamentals", "x-order": "170", "x-starting-plan": "ultra,enterprise", "x-url-hash": "key-executives", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/kst": { "get": { "description": "The Know Sure Thing (KST) endpoint provides a momentum oscillator that combines four smoothed rates of change into a single trend-following indicator. This endpoint returns data that helps users identify potential trend reversals, as well as overbought or oversold conditions in the market.", "operationId": "GetTimeSeriesKst", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The time period for the first Rate of Change calculation.", "in": "query", "name": "roc_period_1", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "RocPeriod1", "x-order": "61" }, "x-go-name": "RocPeriod1", "x-order": "61" }, { "description": "The time period for the second Rate of Change calculation.", "in": "query", "name": "roc_period_2", "schema": { "default": 15, "format": "int64", "type": "integer", "x-go-name": "RocPeriod2", "x-order": "61" }, "x-go-name": "RocPeriod2", "x-order": "61" }, { "description": "The time period for the third Rate of Change calculation.", "in": "query", "name": "roc_period_3", "schema": { "default": 20, "format": "int64", "type": "integer", "x-go-name": "RocPeriod3", "x-order": "61" }, "x-go-name": "RocPeriod3", "x-order": "61" }, { "description": "The time period for the forth Rate of Change calculation.", "in": "query", "name": "roc_period_4", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "RocPeriod4", "x-order": "61" }, "x-go-name": "RocPeriod4", "x-order": "61" }, { "description": "The time period for the first Simple Moving Average.", "in": "query", "name": "sma_period_1", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "SmaPeriod1", "x-order": "62" }, "x-go-name": "SmaPeriod1", "x-order": "62" }, { "description": "The time period for the second Simple Moving Average.", "in": "query", "name": "sma_period_2", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "SmaPeriod2", "x-order": "62" }, "x-go-name": "SmaPeriod2", "x-order": "62" }, { "description": "The time period for the third Simple Moving Average.", "in": "query", "name": "sma_period_3", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "SmaPeriod3", "x-order": "62" }, "x-go-name": "SmaPeriod3", "x-order": "62" }, { "description": "The time period for the forth Simple Moving Average.", "in": "query", "name": "sma_period_4", "schema": { "default": 15, "format": "int64", "type": "integer", "x-go-name": "SmaPeriod4", "x-order": "62" }, "x-go-name": "SmaPeriod4", "x-order": "62" }, { "description": "The time period used for generating the signal line.", "in": "query", "name": "signal_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": "63" }, "x-go-name": "SignalPeriod", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKst_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Know sure thing", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "380", "x-url-hash": "kst", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/last_change/{endpoint}": { "get": { "description": "The last change endpoint provides the most recent updates to fundamental data for a specified dataset. It returns a timestamp indicating when the data was last modified, allowing users to efficiently manage API requests by only fetching new data when changes occur. This helps optimize data retrieval and reduce unnecessary API credit usage.", "operationId": "GetLastChanges", "parameters": [ { "description": "Endpoint name", "in": "path", "name": "endpoint", "required": true, "schema": { "$ref": "#/components/schemas/EndpointEnum" }, "x-go-name": "Endpoint", "x-order": "10", "example": "statistics" }, { "description": "The starting date and time for data selection, in `2006-01-02T15:04:05` format", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "20" }, "x-go-name": "StartDate", "x-order": "20", "example": "2023-10-14T00:00:00" }, { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "30" }, "x-go-name": "Symbol", "x-order": "30", "example": "AAPL" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "70" }, "x-go-name": "Page", "x-order": "70" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLastChanges_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Last changes", "tags": [ "fundamentals" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Fundamentals", "x-order": "190" } }, "/linearreg": { "get": { "description": "The Linear Regression endpoint (LINEARREG) calculates the best-fit straight line through a series of financial data points. It returns the slope and intercept values of this line, allowing users to determine the overall direction of a market trend and identify potential support or resistance levels.", "operationId": "GetTimeSeriesLinearReg", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62." }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "63" }, "x-go-name": "TimePeriod", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearReg_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Linear regression", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "390", "x-url-hash": "linearreg", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/linearregangle": { "get": { "description": "The Linear Regression Angle endpoint (LINEARREGANGLE) calculates the angle of the linear regression line for a given time series of stock prices. It returns the slope of the trend line, expressed in degrees, which helps users identify the direction and steepness of a trend over a specified period. This data is useful for detecting upward or downward trends in asset prices.", "operationId": "GetTimeSeriesLinearRegAngle", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegAngle_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Linear regression angle", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "400", "x-url-hash": "linearregangle", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/linearregintercept": { "get": { "description": "The Linear Regression Intercept endpoint (LINEARREGINTERCEPT) calculates the y-intercept of a linear regression line for a given dataset. It returns the value where the regression line crosses the y-axis, providing a numerical reference point for understanding the starting position of a trend over a specified period. This can be useful for users needing to establish baseline values in their data analysis.", "operationId": "GetTimeSeriesLinearRegIntercept", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Linear regression intercept", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "410", "x-url-hash": "linearregintercept", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/linearregslope": { "get": { "description": "The Linear Regression Slope endpoint (LINEARREGSLOPE) calculates the slope of a linear regression line for a given dataset, reflecting the rate of change in the data trend over a specified period. It returns a numerical value representing this slope, which can be used to assess the direction and strength of the trend in the dataset.", "operationId": "GetTimeSeriesLinearRegSlope", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegSlope_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Linear regression slope", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "420", "x-url-hash": "linearregslope", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ln": { "get": { "description": "The Natural Logarithm (LN) endpoint computes the natural logarithm of a specified input value, returning a numerical result. This endpoint is useful for users needing to perform logarithmic transformations on data, which can be applied in various financial calculations and advanced mathematical analyses.", "operationId": "GetTimeSeriesLn", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLn_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Natural logarithm", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "430", "x-url-hash": "ln", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/log10": { "get": { "description": "The Base-10 Logarithm (LOG10) endpoint computes the base-10 logarithm of a specified input value. It returns a numerical result that represents the power to which the number 10 must be raised to obtain the input value. This endpoint is useful for transforming data into a logarithmic scale, which can simplify the analysis of exponential growth patterns or compress large ranges of data in financial calculations.", "operationId": "GetTimeSeriesLog10", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLog10_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Base-10 logarithm", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "440", "x-url-hash": "log10", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/logo": { "get": { "description": "The logo endpoint provides the official logo image for a specified company, cryptocurrency, or forex pair. This endpoint is useful for integrating visual branding elements into financial applications, websites, or reports, ensuring that users can easily identify and associate the correct logo with the respective financial asset.", "operationId": "GetLogo", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested, e.g., `AAPL`, `BTC/USD`, `EUR/USD`.", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "BTC/USD" }, { "description": "The exchange name where the instrument is traded, e.g., `NASDAQ`, `NSE`", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "20" }, "x-go-name": "Exchange", "x-order": "20", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., `XNAS`, `XLON`", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "30" }, "x-go-name": "MicCode", "x-order": "30", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLogo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Logo", "tags": [ "fundamentals" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "10" } }, "/ma": { "get": { "description": "The Moving Average (MA) endpoint provides the average price of a security over a specified time frame, offering a smoothed representation of price data. This endpoint returns the calculated moving average values, which can assist users in identifying price trends and potential support or resistance levels in the market.", "operationId": "GetTimeSeriesMa", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "63" }, "x-go-name": "TimePeriod", "x-order": "63" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMa_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "450", "x-url-hash": "ma", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/macd": { "get": { "description": "This endpoint calculates the Moving Average Convergence Divergence (MACD) for a specified financial instrument. It returns the MACD line, signal line, and histogram values, which help users identify potential trend reversals and trading opportunities by analyzing the relationship between two moving averages.", "operationId": "GetTimeSeriesMacd", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "63" }, "x-go-name": "SlowPeriod", "x-order": "63" }, { "description": "The time period used for generating the signal line.", "in": "query", "name": "signal_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": "64" }, "x-go-name": "SignalPeriod", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacd_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Moving average convergence divergence", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Momentum indicators", "x-order": "460", "x-url-hash": "macd", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/macd_slope": { "get": { "description": "The Moving Average Convergence Divergence (MACD) Slope endpoint provides the rate of change of the MACD line for a given security. It returns data on how quickly the MACD line is rising or falling, offering insights into the momentum shifts in the security's price. This information is useful for traders looking to gauge the speed of price movements and potential trend reversals.", "operationId": "GetTimeSeriesMacdSlope", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "63" }, "x-go-name": "SlowPeriod", "x-order": "63" }, { "description": "The time period used for generating the signal line.", "in": "query", "name": "signal_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": "64" }, "x-go-name": "SignalPeriod", "x-order": "64" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "64" }, "x-go-name": "TimePeriod", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacdSlope_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Moving average convergence divergence slope", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "470", "x-starting-plan": "pro,venture", "x-url-hash": "macd-slope", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/macdext": { "get": { "description": "The Moving Average Convergence Divergence Extension (MACDEXT) endpoint provides a customizable version of the MACD indicator, allowing users to specify different moving average types and parameters. It returns data that includes the MACD line, signal line, and histogram values, tailored to the user's chosen settings. This endpoint is useful for traders who require flexibility in analyzing price trends and momentum by adjusting the calculation methods to fit their specific trading strategies.", "operationId": "GetTimeSeriesMacdExt", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "The type of fast moving average used in the calculation.", "in": "query", "name": "fast_ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "FastMAType", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "63" }, "x-go-name": "SlowPeriod", "x-order": "63" }, { "description": "The type of slow moving average used in the calculation.", "in": "query", "name": "slow_ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "SlowMAType", "x-order": "63" }, { "description": "The time period used for generating the signal line.", "in": "query", "name": "signal_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": "64" }, "x-go-name": "SignalPeriod", "x-order": "64" }, { "description": "The type of fast moving average used for generating the signal line.", "in": "query", "name": "signal_ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "SignalMAType", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacdExt_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Moving average convergence divergence extension", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "480", "x-url-hash": "macdext", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/mama": { "get": { "description": "The MESA Adaptive Moving Average (MAMA) endpoint calculates a moving average that adjusts to the dominant market cycle, offering a balance between quick response to price changes and noise reduction. It returns data that includes the adaptive moving average values, which can be used to identify trends and potential reversal points.", "operationId": "GetTimeSeriesMama", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "The limit for the fast moving average.", "in": "query", "name": "fast_limit", "schema": { "default": 0.5, "format": "double", "type": "number", "x-go-name": "FastLimit", "x-order": "62" }, "x-go-name": "FastLimit", "x-order": "62" }, { "description": "The limit for the slow moving average.", "in": "query", "name": "slow_limit", "schema": { "default": 0.05, "format": "double", "type": "number", "x-go-name": "SlowLimit", "x-order": "63" }, "x-go-name": "SlowLimit", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMama_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MESA adaptive moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "490", "x-url-hash": "mama", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/market_cap": { "get": { "description": "The Market Capitalization History endpoint provides historical data on a company's market capitalization over a specified time period. It returns a time series of market cap values, allowing users to track changes in a company's market value.", "operationId": "GetMarketCap", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Start date for market capitalization data retrieval.\nData will be returned from this date onwards.\nFormat `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "70" }, "x-go-name": "StartDate", "x-order": "70", "example": "2023-01-01" }, { "description": "End date for market capitalization data retrieval.\nData will be returned up to and including this date.\nFormat `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "80" }, "x-go-name": "EndDate", "x-order": "80", "example": "2023-12-31" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "90" }, "x-go-name": "Page", "x-order": "90" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "OutputSize", "x-order": "100" }, "x-go-name": "OutputSize", "x-order": "100" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketCap_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Market capitalization", "tags": [ "fundamentals" ], "x-api-credits-cost": "5", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Fundamentals", "x-order": "180", "x-starting-plan": "ultra,enterprise", "x-url-hash": "market-cap", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/market_movers/{market}": { "get": { "description": "The market movers endpoint provides a ranked list of the top-gaining and losing assets for the current trading day. It returns detailed data on the highest percentage price increases and decreases since the previous day's close. This endpoint supports international equities, forex, and cryptocurrencies, enabling users to quickly identify significant market movements across various asset classes.", "operationId": "GetMarketMovers", "parameters": [ { "description": "Market type", "in": "path", "name": "market", "required": true, "schema": { "$ref": "#/components/schemas/MarketEnum" }, "x-go-name": "Market", "x-order": "5", "example": "stocks" }, { "description": "Specifies direction of the snapshot gainers or losers", "in": "query", "name": "direction", "schema": { "$ref": "#/components/schemas/DirectionEnum" }, "x-go-name": "Direction", "x-order": "10" }, { "description": "Specifies the size of the snapshot.\nCan be in a range from `1` to `50`", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer", "x-go-name": "OutputSize", "x-order": "20" }, "x-go-name": "OutputSize", "x-order": "20" }, { "description": "Country of the snapshot, applicable to non-currencies only.\nTakes country name or alpha code", "in": "query", "name": "country", "schema": { "default": "USA", "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30" }, { "description": "Takes values with price grater than specified value", "in": "query", "name": "price_greater_than", "schema": { "type": "string", "x-go-name": "PriceGreaterThan", "x-order": "40" }, "x-go-name": "PriceGreaterThan", "x-order": "40", "example": "175.5" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": "5", "maximum": 11, "minimum": 0, "type": "string", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketMoversResponseBody" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Market movers", "tags": [ "market_data" ], "x-api-credits-cost": "100", "x-api-credits-type": "request", "x-group": "Market data", "x-order": "80", "x-starting-plan": "pro,venture" } }, "/market_state": { "get": { "description": "The market state endpoint provides real-time information on the operational status of all available stock exchanges. It returns data on whether each exchange is currently open or closed, along with the time remaining until the next opening or closing. This endpoint is useful for users who need to monitor exchange hours and plan their trading activities accordingly.", "operationId": "GetMarketState", "parameters": [ { "description": "The exchange name where the instrument is traded.", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "10" }, "x-go-name": "Exchange", "x-order": "10", "example": "NYSE" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded.", "in": "query", "name": "code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "20" }, "x-go-name": "MicCode", "x-order": "20", "example": "XNYS" }, { "description": "The country where the exchange is located. Takes country name or alpha code.", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MarketStateResponseItem" }, "type": "array" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Market state", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Markets", "x-order": "40" } }, "/max": { "get": { "description": "The Maximum (MAX) endpoint calculates and returns the highest value within a specified data series over a given period. This endpoint is useful for identifying potential resistance levels or detecting extreme price movements in financial data.", "operationId": "GetTimeSeriesMax", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMax_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Maximum", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "500", "x-url-hash": "max", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/maxindex": { "get": { "description": "The Maximum Index (MAXINDEX) endpoint identifies the position of the highest value within a specified data series over a given time frame. It returns the index where the peak value occurs, allowing users to pinpoint when the maximum price or value was reached in the series. This is useful for tracking the timing of significant peaks in financial data.", "operationId": "GetTimeSeriesMaxIndex", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMaxIndex_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Maximum Index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "510", "x-url-hash": "maxindex", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/mcginley_dynamic": { "get": { "description": "This endpoint calculates the McGinley Dynamic (MCGINLEY_DYNAMIC) indicator, which provides a refined moving average that adapts to market volatility. This endpoint returns data that reflects smoother price trends and identifies potential support or resistance levels more accurately than traditional moving averages. It is useful for users seeking to track price movements with reduced lag and enhanced responsiveness to market changes.", "operationId": "GetTimeSeriesMcGinleyDynamic", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "McGinley dynamic indicator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "520", "x-url-hash": "mcginley-dynamic", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/medprice": { "get": { "description": "The Median Price (MEDPRICE) endpoint calculates and returns the average of the high and low prices of a security for a specified period. This endpoint provides a simplified view of price movements, helping users quickly assess price trends by focusing on the midpoint of price action.", "operationId": "GetTimeSeriesMedPrice", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMedPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Median price", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "530", "x-url-hash": "medprice", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/mfi": { "get": { "description": "The Money Flow Index (MFI) endpoint provides a volume-weighted momentum oscillator that quantifies buying and selling pressure by analyzing positive and negative money flow. It returns data indicating potential overbought or oversold conditions in a financial asset, aiding users in understanding market trends and price movements.", "operationId": "GetTimeSeriesMfi", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMfi_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Money flow index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "540", "x-url-hash": "mfi", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/midpoint": { "get": { "description": "The Midpoint (MIDPOINT) endpoint calculates the average value between the highest and lowest prices of a financial instrument over a specified period. It returns a time series of midpoint values, which can help users identify price trends and smooth out short-term fluctuations in the data.", "operationId": "GetTimeSeriesMidPoint", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMidPoint_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Midpoint", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "550", "x-url-hash": "midpoint", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/midprice": { "get": { "description": "The Midprice (MIDPRICE) endpoint calculates and returns the average of a financial instrument's highest and lowest prices over a specified time period. This data provides a smoothed representation of price movements, helping users identify potential support or resistance levels in the market.", "operationId": "GetTimeSeriesMidPrice", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMidPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Midprice", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "560", "x-url-hash": "midprice", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/min": { "get": { "description": "The Minimum (MIN) Indicator endpoint provides the lowest value of a specified data series over a chosen time period. This endpoint is useful for identifying potential support levels or detecting extreme price movements in financial data.", "operationId": "GetTimeSeriesMin", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMin_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minimum", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "570", "x-url-hash": "min", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/minindex": { "get": { "description": "The Minimum Index (MININDEX) endpoint identifies the position of the lowest value within a specified data series over a given time frame. It returns the index number corresponding to the earliest occurrence of this minimum value. This is useful for pinpointing when the lowest price or value occurred in a dataset, aiding in time-based analysis of data trends.", "operationId": "GetTimeSeriesMinIndex", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinIndex_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minimum index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "580", "x-url-hash": "minindex", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/minmax": { "get": { "description": "The Minimum and Maximum (MINMAX) endpoint identifies the lowest and highest values within a specified time frame for a given data series. It returns these extreme values, which can be used to detect potential support and resistance levels or significant price fluctuations in the data.", "operationId": "GetTimeSeriesMinMax", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinMax_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minimum and maximum", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "590", "x-url-hash": "minmax", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/minmaxindex": { "get": { "description": "The Minimum and Maximum Index (MINMAXINDEX) endpoint identifies the positions of the lowest and highest values within a specified data series period. It returns indices that indicate when these extreme values occur, allowing users to pinpoint significant price changes over time.", "operationId": "GetTimeSeriesMinMaxIndex", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinMaxIndex_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minimum and maximum index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "600", "x-url-hash": "minmaxindex", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/minus_di": { "get": { "description": "The Minus Directional Indicator (MINUS_DI) endpoint calculates and returns the strength of a security's downward price movement over a specified period. This data is useful for traders and analysts looking to identify bearish trends and assess the intensity of price declines in financial markets.", "operationId": "GetTimeSeriesMinusDI", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinusDI_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minus directional indicator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "610", "x-url-hash": "minus-di", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/minus_dm": { "get": { "description": "The Minus Directional Movement endpoint (MINUS_DM) calculates the downward price movement of a security over a specified period. It returns a series of values indicating the strength of downward trends, useful for traders to identify potential selling opportunities or confirm bearish market conditions.", "operationId": "GetTimeSeriesMinusDM", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinusDM_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Minus directional movement", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "620", "x-url-hash": "minus-dm", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/mom": { "get": { "description": "The Momentum (MOM) endpoint provides data on the rate of change in a security's price over a user-defined period. It returns a series of numerical values indicating the speed and direction of the price movement, which can help users detect emerging trends or potential reversals in the market.", "operationId": "GetTimeSeriesMom", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMom_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Momentum", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "630", "x-url-hash": "mom", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/money_market_funds/list": { "get": { "description": "The money market funds directory endpoint provides a list of money market funds, sorted in descending order by their total fund size. This endpoint is useful for retrieving an organized overview of available money market funds.", "operationId": "GetMoneyMarketFundsList", "parameters": [ { "description": "Filter by symbol (ISIN or ticker)", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "IE00BK8M8M59" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatMoneyMarketFundsListEnum" }, "x-go-name": "Format", "x-order": "30" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "40" }, "x-go-name": "Delimiter", "x-order": "40" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "50" }, "x-go-name": "Page", "x-order": "50" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 100, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "60" }, "x-go-name": "PageSize", "x-order": "60" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMoneyMarketFundsList_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MMFs directory", "tags": [ "money_market_funds" ], "x-additional-notes": "Basic, Grow, and Pro plans (individual) and Venture plan (business) return up to 50 records. For complete data, upgrade to the Ultra plan (individual), Enterprise (business), or Custom plan (business).", "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Money market funds", "x-order": "10", "x-starting-plan": "ultra,enterprise", "x-url-hash": "money-market-funds-list" } }, "/money_market_funds/world": { "get": { "description": "The money market fund full data endpoint provides detailed information about a global money market fund. It returns a comprehensive snapshot of the fund, including its identity, screener metrics (fund size, liquidity, weighted average maturity), yields, key facts, risk indicator, and key risks. This endpoint is essential for users seeking in-depth insights into a specific money market fund.", "operationId": "GetMoneyMarketFundsWorld", "parameters": [ { "description": "Symbol ticker of money market fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "IE00BK8M8M59" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "IE00BK8M8M59" }, { "description": "Number of decimal places for floating values", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "40" }, "x-go-name": "Dp", "x-order": "40" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMoneyMarketFundsWorld_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MMF full data", "tags": [ "money_market_funds" ], "x-api-credits-cost": "1000", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Money market funds", "x-order": "20", "x-starting-plan": "ultra,enterprise", "x-url-hash": "money-market-funds-all-data", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin" ] } ] } } }, "/mult": { "get": { "description": "The Multiplication (MULT) endpoint calculates the product of two input data series, returning a new data series that represents the element-wise multiplication of the inputs. This is useful for combining or adjusting technical indicators or price data to create custom metrics or to normalize values across different scales.", "operationId": "GetTimeSeriesMult", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "62" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMult_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Multiplication", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "640", "x-url-hash": "mult", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/mutual_funds/family": { "get": { "description": "The mutual funds family endpoint provides a comprehensive list of MF families, which are groups of mutual funds managed by the same investment company. This data is useful for users looking to explore or compare different fund families, understand the range of investment options offered by each, and identify potential investment opportunities within specific fund families.", "operationId": "GetMutualFundsFamily", "parameters": [ { "description": "Filter by investment company that manages the fund", "in": "query", "name": "fund_family", "schema": { "type": "string", "x-go-name": "FundFamily", "x-order": "20" }, "x-go-name": "FundFamily", "x-order": "20", "example": "Jackson National" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "10" }, "x-go-name": "Country", "x-order": "10", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsFamily_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MFs families", "tags": [ "mutual_funds" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "100", "x-url-hash": "mutual-fund-family-list" } }, "/mutual_funds/list": { "get": { "description": "The mutual funds directory endpoint provides a daily updated list of mutual funds, sorted in descending order by their total assets value. This endpoint is useful for retrieving an organized overview of available mutual funds.", "operationId": "GetMutualFundsList", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20" }, "x-go-name": "Figi", "x-order": "20", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25" }, "x-go-name": "Isin", "x-order": "25", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26" }, "x-go-name": "Cusip", "x-order": "26", "example": "120678230" }, { "description": "The CIK of an instrument for which data is requested", "in": "query", "name": "cik", "schema": { "type": "string", "x-go-name": "Cik", "x-order": "28" }, "x-go-name": "Cik", "x-order": "28", "example": "95953" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "United States" }, { "description": "Filter by investment company that manages the fund", "in": "query", "name": "fund_family", "schema": { "type": "string", "x-go-name": "FundFamily", "x-order": "40" }, "x-go-name": "FundFamily", "x-order": "40", "example": "Jackson National" }, { "description": "Filter by the type of fund", "in": "query", "name": "fund_type", "schema": { "type": "string", "x-go-name": "FundType", "x-order": "50" }, "x-go-name": "FundType", "x-order": "50", "example": "Small Blend" }, { "description": "Filter by performance rating from `0` to `5`", "in": "query", "name": "performance_rating", "schema": { "format": "int64", "type": "integer", "x-go-name": "PerformanceRating", "x-order": "60" }, "x-go-name": "PerformanceRating", "x-order": "60", "example": 4 }, { "description": "Filter by risk rating from `0` to `5`", "in": "query", "name": "risk_rating", "schema": { "format": "int64", "type": "integer", "x-go-name": "RiskRating", "x-order": "70" }, "x-go-name": "RiskRating", "x-order": "70", "example": 4 }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "72" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "74" }, "x-go-name": "Delimiter", "x-order": "74" }, { "description": "Number of decimal places for floating values", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp", "x-order": "76" }, "x-go-name": "Dp", "x-order": "76" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": "80" }, "x-go-name": "Page", "x-order": "80" }, { "description": "Number of records in response", "in": "query", "name": "outputsize", "schema": { "default": 100, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "90" }, "x-go-name": "PageSize", "x-order": "90" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsList_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MFs directory", "tags": [ "mutual_funds" ], "x-additional-notes": "Basic, Grow, and Pro plans (individual) and Venture plan (business) return up to 50 records. For complete data on over 140,000 Mutual Funds, upgrade to the Ultra plan (individual), Enterprise (business), or Custom plan (business).", "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "Useful", "x-group": "Mutual funds", "x-order": "10", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mutual-funds-list" } }, "/mutual_funds/type": { "get": { "description": "This endpoint provides detailed information on various types of mutual funds, such as equity, bond, and balanced funds, allowing users to understand the different investment options available.", "operationId": "GetMutualFundsType", "parameters": [ { "description": "Filter by the type of fund", "in": "query", "name": "fund_type", "schema": { "type": "string", "x-go-name": "FundType", "x-order": "20" }, "x-go-name": "FundType", "x-order": "20", "example": "Jackson National" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "10" }, "x-go-name": "Country", "x-order": "10", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsType_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MFs types", "tags": [ "mutual_funds" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "110", "x-url-hash": "mutual-fund-type-list" } }, "/mutual_funds/world": { "get": { "description": "The mutual full data endpoint provides detailed information about global mutual funds. It returns a comprehensive dataset that includes a summary of the fund, its performance metrics, risk assessment, ratings, asset composition, purchase details, and sustainability factors. This endpoint is essential for users seeking in-depth insights into mutual funds on a global scale, allowing them to evaluate various aspects such as investment performance, risk levels, and environmental impact.", "operationId": "GetMutualFundsWorld", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "MF full data", "tags": [ "mutual_funds" ], "x-api-credits-cost": "1000", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "Mutual funds", "x-order": "20", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-all-data", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/composition": { "get": { "description": "The mutual funds compositions endpoint provides detailed information about the portfolio composition of a specified mutual fund. It returns data on sector allocations, individual holdings, and their respective weighted exposures. This endpoint is useful for users seeking to understand the investment distribution and risk profile of a mutual fund.", "operationId": "GetMutualFundsWorldComposition", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldComposition_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Composition", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "Mutual funds", "x-order": "70", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-composition", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/performance": { "get": { "description": "The mutual funds performances endpoint provides comprehensive performance data for mutual funds globally. It returns metrics such as trailing returns, annual returns, quarterly returns, and load-adjusted returns.", "operationId": "GetMutualFundsWorldPerformance", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldPerformance_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Performance", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "Mutual funds", "x-order": "40", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-performance", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/purchase_info": { "get": { "description": "The mutual funds purchase information endpoint provides detailed purchasing details for global mutual funds. It returns data on minimum investment requirements, current pricing, and a list of brokerages where the mutual fund can be purchased. This endpoint is useful for users looking to understand the entry requirements and options available for investing in specific mutual funds.", "operationId": "GetMutualFundsWorldPurchaseInfo", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldPurchaseInfo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Purchase info", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "80", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-purchase-info", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/ratings": { "get": { "description": "The mutual funds ratings endpoint provides detailed ratings for mutual funds across global markets. It returns data on the performance and quality of mutual funds, including ratings calculated in-house by Twelve Data and from various financial institutions.", "operationId": "GetMutualFundsWorldRatings", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldRatings_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Ratings", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "60", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-ratings", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/risk": { "get": { "description": "The mutual funds risk endpoint provides detailed risk metrics for global mutual funds. It returns data such as standard deviation, beta, and Sharpe ratio, which help assess the volatility and risk profile of mutual funds across different markets.", "operationId": "GetMutualFundsWorldRisk", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldRisk_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Risk", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "50", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-risk", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/summary": { "get": { "description": "The mutual funds summary endpoint provides a concise overview of global mutual funds, including key details such as fund name, symbol, asset class, and region. This endpoint is useful for quickly obtaining essential information about various mutual funds worldwide, aiding in the comparison and selection of funds for investment portfolios.", "operationId": "GetMutualFundsWorldSummary", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldSummary_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Summary", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "30", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-summary", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/mutual_funds/world/sustainability": { "get": { "description": "The mutual funds sustainability endpoint provides detailed information on the sustainability and Environmental, Social, and Governance (ESG) ratings of global mutual funds. It returns data such as ESG scores, sustainability metrics, and fund identifiers.", "operationId": "GetMutualFundsWorldSustainability", "parameters": [ { "description": "Symbol ticker of mutual fund", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "1535462D" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG00HMMLCH1" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "LU1206782309" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "120678230" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Number of decimal places for floating values. Accepts value in range [0,11]", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "50" }, "x-go-name": "DecimalPlaces", "x-order": "50" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldSustainability_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Sustainability", "tags": [ "mutual_funds" ], "x-api-credits-cost": "200", "x-api-credits-type": "request", "x-group": "Mutual funds", "x-order": "90", "x-starting-plan": "ultra,enterprise", "x-url-hash": "mf-sustainability", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/natr": { "get": { "description": "The Normalized Average True Range (NATR) endpoint provides a volatility indicator that calculates the average range of price movement over a specified period, expressed as a percentage of the security's price. This data allows users to compare volatility levels across different securities easily. The endpoint returns a time series of NATR values, which can be used to assess and compare the price volatility of various financial instruments.", "operationId": "GetTimeSeriesNatr", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesNatr_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Normalized average true range", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volatility indicators", "x-order": "650", "x-url-hash": "natr", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/obv": { "get": { "description": "The On Balance Volume (OBV) endpoint provides a time series of the OBV indicator, which calculates cumulative volume to reflect buying and selling pressure over time. This endpoint returns data that helps users track volume trends in relation to price movements, aiding in the identification of potential trend continuations or reversals in a security's price.", "operationId": "GetTimeSeriesObv", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesObv_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "On balance volume", "tags": [ "technical_indicator" ], "x-additional-notes": "Take note that this endpoint is applicable to all instruments except currencies.", "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volume indicators", "x-order": "660", "x-url-hash": "obv", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/percent_b": { "get": { "description": "The Percent B (%B) endpoint calculates and returns the %B value, which indicates the position of a security's price relative to its Bollinger Bands. This data helps users determine if a security is near the upper or lower band, potentially signaling overbought or oversold conditions.", "operationId": "GetTimeSeriesPercent_B", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "The standard deviation applied in the calculation. Must be at least `1`", "in": "query", "name": "sd", "schema": { "default": 2, "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": "63" }, "x-go-name": "StandardDeviation", "x-order": "63" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPercent_B_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Percent B", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Momentum indicators", "x-order": "670", "x-url-hash": "percent-b", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/pivot_points_hl": { "get": { "description": "The Pivot Points High Low (PIVOT_POINTS_HL) endpoint calculates key support and resistance levels for a security by analyzing its highest and lowest prices over a specified period. This endpoint returns data that includes pivot points, support levels, and resistance levels, which can be used to identify potential price reversal zones and optimize trade entry and exit strategies.", "operationId": "GetTimeSeriesPivotPointsHL", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPivotPointsHL_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Pivot points high low", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "680", "x-starting-plan": "pro,venture", "x-url-hash": "pivot-points-hl", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/plus_di": { "get": { "description": "The Plus Directional Indicator endpoint (/plus_di) provides data on the strength of a security's upward price movement by calculating the Plus Directional Indicator (PLUS_DI). It returns a time series of PLUS_DI values, which can be used to assess the intensity of upward trends in a security's price over a specified period.", "operationId": "GetTimeSeriesPlusDI", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPlusDI_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Plus directional indicator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "690", "x-url-hash": "plus-di", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/plus_dm": { "get": { "description": "The Plus Directional Movement (PLUS_DM) endpoint calculates the upward price movement of a financial security over a specified period. It returns numerical values representing the magnitude of upward price changes, which can be used to assess the strength of an uptrend. This data is essential for traders and analysts who need to evaluate the bullish momentum of a security.", "operationId": "GetTimeSeriesPlusDM", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPlusDM_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Plus directional movement", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "700", "x-url-hash": "plus-dm", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ppo": { "get": { "description": "The Percentage Price Oscillator (PPO) endpoint calculates the percentage difference between two specified moving averages of a financial instrument's price. It returns data that includes the PPO values, which traders can use to identify potential trend reversals and generate trading signals.", "operationId": "GetTimeSeriesPpo", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods for fast moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_period", "schema": { "default": 12, "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": "62" }, "x-go-name": "FastPeriod", "x-order": "62" }, { "description": "Number of periods for slow moving average. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_period", "schema": { "default": 26, "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": "63" }, "x-go-name": "SlowPeriod", "x-order": "63" }, { "description": "The type of moving average used", "in": "query", "name": "ma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "MAType", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPpo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Percentage price oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "710", "x-url-hash": "ppo", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/press_releases": { "get": { "description": "The press releases endpoint offers structured, real-time access to official company press releases and corporate announcements from public entities across global markets.", "operationId": "PressReleasesListParameters", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "32", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "32", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Begin date for filtering items.\nReturns press releases with release date on or after this date. Format `2025-12-24T02:07:00`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2025-12-01T00:00:00" }, { "description": "End date for filtering items.\nReturns press releases with release date on or before this date. Format `2025-12-24T02:07:00`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2025-12-31T23:59:00" }, { "description": "Time zone for date filtering. Default is the identifier time zone.", "in": "query", "name": "timezone", "schema": { "type": "string", "x-go-name": "TimeZone", "x-order": "100" }, "x-go-name": "TimeZone", "x-order": "100", "example": "America/New_York" }, { "description": "Comma-separated list of languages to filter press releases by language.", "in": "query", "name": "language", "schema": { "type": "string", "x-go-name": "Language", "x-order": "95" }, "x-go-name": "Language", "x-order": "95", "example": "en,en-US" }, { "description": "Number of latest press releases returned. Only used if no data range is specified. Maximum value is `10`.\n\ntype: number", "in": "query", "name": "outputsize", "schema": { "default": 2, "format": "int64", "type": "integer", "x-go-name": "Outputsize", "x-order": "110" }, "x-go-name": "Outputsize", "x-order": "110", "example": 5 } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PressReleasesListParameters_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Press releases", "tags": [ "fundamentals" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Fundamentals", "x-order": "105", "x-starting-plan": "Basic", "x-url-hash": "press-releases", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/price": { "get": { "description": "The latest price endpoint provides the latest market price for a specified financial instrument. It returns a single data point representing the current (or the most recently available) trading price.", "operationId": "GetPrice", "parameters": [ { "description": "Symbol ticker of the instrument", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BHTMY7" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "30" }, "x-go-name": "Exchange", "x-order": "30", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "40" }, "x-go-name": "MicCode", "x-order": "40", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "50" }, "x-go-name": "Country", "x-order": "50", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "60", "example": "ETF" }, { "description": "Value can be JSON or CSV", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "70" }, { "description": "Specify the delimiter used when downloading the CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "80" }, "x-go-name": "Delimiter", "x-order": "80" }, { "description": "Parameter is optional. Only for Pro or Venture, and above plans.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume.", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "100" }, "x-go-name": "Prepost", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "110" }, "x-go-name": "DecimalPlaces", "x-order": "110" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Latest price", "tags": [ "market_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Market data", "x-order": "60", "x-url-hash": "real-time-price", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/price_target": { "get": { "description": "The price target endpoint provides detailed projections of a security's future price as estimated by financial analysts. It returns data including the high, low, and average price targets. This endpoint is useful for users seeking to understand potential future valuations of specific securities based on expert analysis.", "operationId": "GetPriceTarget", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPriceTarget_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Price target", "tags": [ "analysis" ], "x-api-credits-cost": "75", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Analysis", "x-order": "70", "x-starting-plan": "ultra,enterprise", "x-url-hash": "price-target", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/profile": { "get": { "description": "The profile endpoint provides detailed company information, including the company's name, industry, sector, CEO, and headquarters location. This data is useful for obtaining a comprehensive overview of a company's business and financial standing.", "operationId": "GetProfile", "parameters": [ { "description": "Symbol ticker of instrument. For preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfile_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Profile", "tags": [ "fundamentals" ], "x-api-credits-cost": "10", "x-api-credits-type": "symbol", "x-badge": "Useful", "x-group": "Fundamentals", "x-order": "20", "x-starting-plan": "grow,venture", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/quote": { "get": { "description": "The quote endpoint provides real-time data for a selected financial instrument, returning essential information such as the latest price, open, high, low, close, volume, and price change. This endpoint is ideal for users needing up-to-date market data to track price movements and trading activity for specific stocks, ETFs, or other securities.", "operationId": "GetQuote", "parameters": [ { "description": "Symbol ticker of the instrument", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000BHTMY7" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval of the quote", "in": "query", "name": "interval", "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Number of periods for Average Volume", "in": "query", "name": "volume_time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "AverageVolumeTimePeriod", "x-order": "70" }, "x-go-name": "AverageVolumeTimePeriod", "x-order": "70" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "80", "example": "ETF" }, { "description": "Value can be JSON or CSV\nDefault JSON", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "Specify the delimiter used when downloading the CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Parameter is optional. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume.", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "120" }, "x-go-name": "Prepost", "x-order": "120" }, { "description": "If true, then return data for closed day", "in": "query", "name": "eod", "schema": { "default": false, "type": "boolean", "x-go-name": "Eod", "x-order": "130" }, "x-go-name": "Eod", "x-order": "130" }, { "description": "Number of hours for calculate rolling change at period. By default set to 24, it can be in range [1, 168].", "in": "query", "name": "rolling_period", "schema": { "default": 24, "format": "int64", "type": "integer", "x-go-name": "RollingPeriod", "x-order": "140" }, "x-go-name": "RollingPeriod", "x-order": "140" }, { "description": "Specifies the number of decimal places for floating values\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "150" }, "x-go-name": "DecimalPlaces", "x-order": "150" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "160" }, "x-go-name": "Timezone", "x-order": "160" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuote_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Quote", "tags": [ "market_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Market data", "x-order": "50", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/recommendations": { "get": { "description": "The recommendations endpoint provides a summary of analyst opinions for a specific stock, delivering an average recommendation categorized as Strong Buy, Buy, Hold, or Sell. It also includes a numerical recommendation score, offering a quick overview of market sentiment based on expert analysis.", "operationId": "GetRecommendations", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "40", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "40", "x-required-group": "symbol", "example": "594918104" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "50" }, "x-go-name": "Country", "x-order": "50", "example": "United States" }, { "description": "The exchange name where the instrument is traded, e.g., `Nasdaq`, `NSE`.", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "60" }, "x-go-name": "Exchange", "x-order": "60", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "65" }, "x-go-name": "MicCode", "x-order": "65", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRecommendations_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Recommendations", "tags": [ "analysis" ], "x-api-credits-cost": "100", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Analysis", "x-order": "60", "x-starting-plan": "ultra,enterprise", "x-url-hash": "recommendations", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/revenue_estimate": { "get": { "description": "The revenue estimate endpoint provides a company's projected quarterly and annual revenue figures based on analysts' estimates. This data is useful for users seeking insights into expected company performance, allowing them to compare forecasted sales with historical data or other companies' estimates.", "operationId": "GetRevenueEstimate", "parameters": [ { "description": "Filter by symbol", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "40" }, "x-go-name": "Country", "x-order": "40", "example": "United States" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "50" }, "x-go-name": "Exchange", "x-order": "50", "example": "NASDAQ" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., XNAS, XLON.", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "55" }, "x-go-name": "MicCode", "x-order": "55", "example": "XNAS" }, { "description": "Number of decimal places for floating values.\nShould be in range [0,11] inclusive", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "60" }, "x-go-name": "DecimalPlaces", "x-order": "60" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRevenueEstimate_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Revenue estimate", "tags": [ "analysis" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Analysis", "x-order": "20", "x-starting-plan": "ultra,enterprise", "x-url-hash": "revenue-estimate", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/roc": { "get": { "description": "The Rate of Change (ROC) endpoint calculates the percentage change in a security's price over a defined period, returning a time series of ROC values. This data helps users track momentum by showing how quickly prices are changing, which can be useful for identifying potential price movements.", "operationId": "GetTimeSeriesRoc", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRoc_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Rate of change", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "720", "x-url-hash": "roc", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/rocp": { "get": { "description": "The Rate of Change Percentage (ROCP) endpoint calculates and returns the percentage change in the price of a financial security over a user-defined period. This data helps users identify shifts in price momentum and potential trend reversals by providing a clear numerical representation of how much the price has increased or decreased in percentage terms.", "operationId": "GetTimeSeriesRocp", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocp_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Rate of change percentage", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "730", "x-url-hash": "rocp", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/rocr": { "get": { "description": "The Rate of Change Ratio (ROCR) endpoint calculates and returns the ratio of a security's current price to its price from a specified number of periods ago. This data helps users track price momentum and identify potential trend reversals by providing a clear numerical value that reflects price changes over time.", "operationId": "GetTimeSeriesRocr", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocr_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Rate of change ratio", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "740", "x-url-hash": "rocr", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/rocr100": { "get": { "description": "The Rate of Change Ratio 100 (ROCR100) endpoint calculates the percentage change in a security's price over a specified period, expressed as a ratio to 100. It returns data that highlights the momentum of the price movement and identifies potential trend reversals. This endpoint is useful for users looking to assess the strength and direction of a security's price trend over time.", "operationId": "GetTimeSeriesRocr100", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocr100_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Rate of change ratio 100", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "750", "x-url-hash": "rocr100", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/rsi": { "get": { "description": "The Relative Strength Index (RSI) endpoint provides data on the RSI values for a specified financial instrument over a given period. It returns a series of RSI values, which indicate the momentum of price movements and help identify potential overbought or oversold conditions. This data is useful for traders looking to assess the strength of price trends and anticipate possible trend reversals.", "operationId": "GetTimeSeriesRsi", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRsi_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Relative strength index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Momentum indicators", "x-order": "760", "x-url-hash": "rsi", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/rvol": { "get": { "description": "The Relative Volume endpoint (/rvol) provides a ratio comparing a security's current trading volume to its average volume over a specified period. This data helps users detect unusual trading activity and assess the strength of price movements, offering insights into potential market breakouts.", "operationId": "GetTimeSeriesRvol", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRvol_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Relative volume", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volume indicators", "x-order": "770", "x-starting-plan": "grow,venture", "x-url-hash": "rvol", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/sanctions/{source}": { "get": { "description": "The sanctions entities endpoint provides a comprehensive list of entities sanctioned by a specified authority, such as OFAC, UK, EU, or AU. Users can retrieve detailed information about individuals, organizations, and other entities subject to sanctions from the chosen source, facilitating compliance and risk management processes.", "operationId": "GetSourceSanctionedEntities", "parameters": [ { "description": "Sanctions source", "in": "path", "name": "source", "required": true, "schema": { "$ref": "#/components/schemas/SourceEnum" }, "x-go-name": "Source", "example": "ofac" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSourceSanctionedEntities_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Sanctioned entities", "tags": [ "regulatory" ], "x-api-credits-cost": "50", "x-api-credits-type": "request", "x-badge": "New", "x-group": "Regulatory", "x-order": "70", "x-starting-plan": "ultra,enterprise", "x-url-hash": "sanctioned-entities" } }, "/sar": { "get": { "description": "The Parabolic Stop and Reverse (SAR) endpoint provides data on potential support and resistance levels for a specified security, using its price and time. This endpoint returns numerical values that help traders determine possible entry and exit points in their trading strategies.", "operationId": "GetTimeSeriesSar", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The rate of change in the indicator's values.", "in": "query", "name": "acceleration", "schema": { "default": 0.02, "format": "double", "type": "number", "x-go-name": "Acceleration", "x-order": "61" }, "x-go-name": "Acceleration", "x-order": "61" }, { "description": "The maximum value considered for the indicator calculation.", "in": "query", "name": "maximum", "schema": { "default": 0.2, "format": "double", "type": "number", "x-go-name": "Maximum", "x-order": "62" }, "x-go-name": "Maximum", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSar_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Parabolic stop and reverse", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "780", "x-starting-plan": "grow,venture", "x-url-hash": "sar", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/sarext": { "get": { "description": "The Parabolic SAR Extended (SAREXT) endpoint provides a customizable version of the Parabolic SAR indicator, which is used to identify potential entry and exit points in trading. Users can adjust parameters such as acceleration factors to tailor the indicator to specific trading strategies. The endpoint returns data points indicating potential trend reversals.", "operationId": "GetTimeSeriesSarExt", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The initial value for the indicator calculation.", "in": "query", "name": "start_value", "schema": { "default": 0, "format": "double", "type": "number", "x-go-name": "StartValue", "x-order": "61" }, "x-go-name": "StartValue", "x-order": "61" }, { "description": "The adjustment applied when the indicator's direction changes.", "in": "query", "name": "offset_on_reverse", "schema": { "default": 0, "format": "double", "type": "number", "x-go-name": "OffsetOnReverse", "x-order": "62" }, "x-go-name": "OffsetOnReverse", "x-order": "62" }, { "description": "The maximum acceleration value for long positions.", "in": "query", "name": "acceleration_limit_long", "schema": { "default": 0.02, "format": "double", "type": "number", "x-go-name": "AccelerationLimitLong", "x-order": "63" }, "x-go-name": "AccelerationLimitLong", "x-order": "63" }, { "description": "The acceleration value for long positions.", "in": "query", "name": "acceleration_long", "schema": { "default": 0.02, "format": "double", "type": "number", "x-go-name": "AccelerationLong", "x-order": "63" }, "x-go-name": "AccelerationLong", "x-order": "63" }, { "description": "The highest allowed acceleration for long positions.", "in": "query", "name": "acceleration_max_long", "schema": { "default": 0.2, "format": "double", "type": "number", "x-go-name": "AccelerationMaxLong", "x-order": "63" }, "x-go-name": "AccelerationMaxLong", "x-order": "63" }, { "description": "The maximum acceleration value for short positions.", "in": "query", "name": "acceleration_limit_short", "schema": { "default": 0.02, "format": "double", "type": "number", "x-go-name": "AccelerationLimitShort", "x-order": "64" }, "x-go-name": "AccelerationLimitShort", "x-order": "64" }, { "description": "The acceleration value for short positions.", "in": "query", "name": "acceleration_short", "schema": { "default": 0.02, "format": "double", "type": "number", "x-go-name": "AccelerationShort", "x-order": "64" }, "x-go-name": "AccelerationShort", "x-order": "64" }, { "description": "The highest allowed acceleration for short positions.", "in": "query", "name": "acceleration_max_short", "schema": { "default": 0.2, "format": "double", "type": "number", "x-go-name": "AccelerationMaxShort", "x-order": "65" }, "x-go-name": "AccelerationMaxShort", "x-order": "65" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSarExt_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Parabolic stop and reverse extended", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "790", "x-url-hash": "sarext", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/sma": { "get": { "description": "The Simple Moving Average (SMA) endpoint calculates and returns the average price of a security over a user-defined time period. This endpoint provides a series of data points that represent the smoothed price trend, which can help users identify potential price movements and evaluate historical price behavior.", "operationId": "GetTimeSeriesSma", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSma_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Simple moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Overlap studies", "x-order": "800", "x-url-hash": "sma", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/splits": { "get": { "description": "The splits endpoint provides historical data on stock split events for a specified company. It returns details including the date of each split and the corresponding split factor.", "operationId": "GetSplits", "parameters": [ { "description": "Symbol ticker of instrument. For preferred stocks use dot(.) delimiter. E.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "Range of data to be returned", "in": "query", "name": "range", "schema": { "$ref": "#/components/schemas/RangeSplitsEnum" }, "x-go-name": "Range", "x-order": "70" }, { "description": "The starting date for data selection. Format `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "80" }, "x-go-name": "StartDate", "x-order": "80", "example": "2020-01-01" }, { "description": "The ending date for data selection. Format `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "90" }, "x-go-name": "EndDate", "x-order": "90", "example": "2020-12-31" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSplits_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Splits", "tags": [ "fundamentals" ], "x-api-credits-cost": "20", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "50", "x-starting-plan": "grow,venture", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/splits_calendar": { "get": { "description": "The splits calendar endpoint provides a detailed calendar of stock split events within a specified date range. By setting the `start_date` and `end_date` parameters, users can retrieve a list of upcoming or past stock splits, including the company name, split ratio, and effective date. This endpoint is useful for tracking changes in stock structure and planning investment strategies around these events.", "operationId": "GetSplitsCalendar", "parameters": [ { "description": "Symbol ticker of instrument. For preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "1" }, "x-go-name": "Symbol", "x-order": "1", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "2" }, "x-go-name": "Figi", "x-order": "2", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "3" }, "x-go-name": "Isin", "x-order": "3", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "4" }, "x-go-name": "Cusip", "x-order": "4", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "10" }, "x-go-name": "Exchange", "x-order": "10", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "20" }, "x-go-name": "MicCode", "x-order": "20", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "30" }, "x-go-name": "Country", "x-order": "30", "example": "United States" }, { "description": "The starting date (inclusive) for filtering split events in the calendar. Format `2006-01-02`", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "40" }, "x-go-name": "StartDate", "x-order": "40", "example": "2024-01-01" }, { "description": "The ending date (inclusive) for filtering split events in the calendar. Format `2006-01-02`", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "50" }, "x-go-name": "EndDate", "x-order": "50", "example": "2024-12-31" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `500`. Default `100` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 100, "format": "int64", "type": "integer", "x-go-name": "Outputsize", "x-order": "60" }, "x-go-name": "Outputsize", "x-order": "60" }, { "description": "Page number", "in": "query", "name": "page", "schema": { "default": "1", "type": "string", "x-go-name": "Page", "x-order": "70" }, "x-go-name": "Page", "x-order": "70" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SplitsCalendarResponseItem" }, "type": "array" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Splits calendar", "tags": [ "fundamentals" ], "x-api-credits-cost": "40", "x-api-credits-type": "symbol", "x-group": "Fundamentals", "x-order": "60", "x-starting-plan": "grow,venture" } }, "/sqrt": { "get": { "description": "The Square Root (SQRT) endpoint computes the square root of a specified numerical input. It returns a single numerical value representing the square root, which can be used in various mathematical computations or financial models requiring this specific transformation.", "operationId": "GetTimeSeriesSqrt", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSqrt_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Square root", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "810", "x-url-hash": "sqrt", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/statistics": { "get": { "description": "The statistics endpoint provides a comprehensive snapshot of a company's key financial statistics, including valuation metrics, revenue figures, profit margins, and other essential financial data. This endpoint is ideal for users seeking detailed insights into a company's financial health and performance metrics.", "operationId": "GetStatistics", "parameters": [ { "description": "Symbol ticker of instrument.\nFor preferred stocks use dot(.) delimiter.\nE.g. `BRK.A` or `BRK.B` will be correct", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "31", "x-required-group": "symbol", "example": "594918104" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "Country where instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStatistics_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Statistics", "tags": [ "fundamentals" ], "x-api-credits-cost": "50", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Fundamentals", "x-order": "100", "x-starting-plan": "pro,venture", "x-required": { "anyOf": [ { "required": [ "symbol", "figi", "isin", "cusip" ] } ] } } }, "/stddev": { "get": { "description": "The Standard Deviation (STDDEV) endpoint calculates the dispersion of a financial instrument's price data from its average value. It returns a numerical value representing the volatility of the asset over a specified period. This endpoint is useful for traders and analysts to assess price variability and identify periods of high or low volatility in the market.", "operationId": "GetTimeSeriesStdDev", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "63" }, "x-go-name": "TimePeriod", "x-order": "63" }, { "description": "The standard deviation applied in the calculation.", "in": "query", "name": "sd", "schema": { "default": 2, "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": "61" }, "x-go-name": "StandardDeviation", "x-order": "61" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStdDev_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Standard deviation", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "820", "x-url-hash": "stddev", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/stoch": { "get": { "description": "The Stochastic Oscillator endpoint provides data on a momentum indicator that evaluates a security's closing price relative to its price range over a specified timeframe. It returns values indicating potential overbought or oversold conditions, aiding in identifying possible trend reversals. Users receive the %K and %D values, which are essential for analyzing the momentum and potential turning points in the market.", "operationId": "GetTimeSeriesStoch", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_k_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": "61" }, "x-go-name": "FastKPeriod", "x-order": "61" }, { "description": "The time period for the slow %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_k_period", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "SlowKPeriod", "x-order": "61" }, "x-go-name": "SlowKPeriod", "x-order": "61" }, { "description": "The time period for the slow %D line in the Stochastic Oscillator. Takes values in the range from `1` to `800`", "in": "query", "name": "slow_d_period", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "SlowDPeriod", "x-order": "62" }, "x-go-name": "SlowDPeriod", "x-order": "62" }, { "description": "The type of slow %K Moving Average used. Default is SMA.", "in": "query", "name": "slow_kma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "SlowKMAType", "x-order": "63" }, { "description": "The type of slow Displaced Moving Average used. Default is SMA.", "in": "query", "name": "slow_dma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "SlowDMAType", "x-order": "64" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStoch_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Stochastic oscillator", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Technical indicators/Momentum indicators", "x-order": "830", "x-url-hash": "stoch", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/stochf": { "get": { "description": "The Stochastic Fast (STOCHF) endpoint calculates the fast version of the Stochastic Oscillator, providing data on the momentum of a financial instrument by comparing a particular closing price to a range of its prices over a specified period. This endpoint returns the %K and %D values, which are used to identify potential overbought or oversold conditions in the market. It is useful for traders who need quick, responsive insights into price movements, although it may generate more false signals due to its sensitivity.", "operationId": "GetTimeSeriesStochF", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_k_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": "61" }, "x-go-name": "FastKPeriod", "x-order": "61" }, { "description": "The time period for the fast %D line in the Stochastic Oscillator. Takes values in the range from `1` to `800`", "in": "query", "name": "fast_d_period", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "FastDPeriod", "x-order": "62" }, "x-go-name": "FastDPeriod", "x-order": "62" }, { "description": "The type of fast Displaced Moving Average used.", "in": "query", "name": "fast_dma_type", "schema": { "$ref": "#/components/schemas/MaTypeEnum" }, "x-go-name": "FastDMAType", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStochF_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Stochastic fast", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "840", "x-url-hash": "stochf", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/stochrsi": { "get": { "description": "The Stochastic Relative Strength Index (Stochastic RSI) endpoint calculates the Stochastic RSI values for a given financial instrument, providing data on its momentum and potential price reversals. This endpoint returns time-series data, including the %K and %D lines, which help users identify overbought or oversold conditions. Ideal for traders seeking to refine entry and exit points by analyzing short-term price movements.", "operationId": "GetTimeSeriesStochRsi", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specifies the price data type: open, high, low, or close.", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeStochrsiEnum" }, "x-go-name": "SeriesType", "x-order": "63" }, { "description": "Length of period for calculating the RSI component. Takes values in the range from `1` to `800`", "in": "query", "name": "rsi_length", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "64" }, "x-go-name": "TimePeriod", "x-order": "64" }, { "description": "Period length for computing the stochastic oscillator of the RSI. Takes values in the range from `1` to `800`", "in": "query", "name": "stoch_length", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": "61" }, "x-go-name": "FastKPeriod", "x-order": "61" }, { "description": "Period for smoothing the %K line. Takes values in the range from `1` to `800`", "in": "query", "name": "k_period", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "SlowKPeriod", "x-order": "61" }, "x-go-name": "SlowKPeriod", "x-order": "61" }, { "in": "query", "name": "slow_kma_type", "schema": { "type": "string", "x-go-name": "SlowKMAType" }, "x-go-name": "SlowKMAType" }, { "description": "Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from `1` to `800`", "in": "query", "name": "d_period", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "SlowDPeriod", "x-order": "62" }, "x-go-name": "SlowDPeriod", "x-order": "62" }, { "in": "query", "name": "slow_dma_type", "schema": { "type": "string", "x-go-name": "SlowDMAType" }, "x-go-name": "SlowDMAType" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStochRsi_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Stochastic relative strength index", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "850", "x-url-hash": "stochrsi", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/stocks": { "get": { "description": "The stocks endpoint provides a daily updated list of all available stock symbols. It returns an array containing the symbols, which can be used to identify and access specific stock data across various services. This endpoint is essential for users needing to retrieve the latest stock symbol information for further data requests or integration into financial applications.", "operationId": "GetStocks", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol" }, "x-go-name": "Symbol", "example": "AAPL" }, { "description": "Filter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi" }, "x-go-name": "Figi", "example": "BBG000B9Y5X2" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin" }, "x-go-name": "Isin", "example": "US0378331005" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip" }, "x-go-name": "Cusip", "example": "594918104" }, { "description": "The CIK of an instrument for which data is requested", "in": "query", "name": "cik", "schema": { "type": "string", "x-go-name": "Cik" }, "x-go-name": "Cik", "example": "95953" }, { "description": "Filter by exchange name", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange" }, "x-go-name": "Exchange", "example": "NASDAQ" }, { "description": "Filter by market identifier code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode" }, "x-go-name": "MicCode", "example": "XNGS" }, { "description": "Filter by country name or alpha code, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country" }, "x-go-name": "Country", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "example": "Common Stock" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter" }, { "description": "Adds info on which plan symbol is available", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan" }, "x-go-name": "ShowPlan" }, { "description": "Include delisted identifiers", "in": "query", "name": "include_delisted", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeDelisted" }, "x-go-name": "IncludeDelisted" }, { "description": "Page number of the results to fetch", "in": "query", "name": "page", "schema": { "default": 1, "format": "int64", "type": "integer", "x-go-name": "Page" }, "x-go-name": "Page" }, { "description": "Determines the number of data points returned in the output", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "PageSize" }, "x-go-name": "PageSize" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStocks_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Stocks", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Asset catalogs", "x-order": "10", "x-url-hash": "stocks-list" } }, "/sub": { "get": { "description": "The Subtraction (SUB) endpoint calculates the difference between two input data series, such as technical indicators or price data. It returns a time series of the resulting values, allowing users to compare or normalize data by highlighting the variance between the two series.", "operationId": "GetTimeSeriesSub", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type used as the first part of technical indicator", "in": "query", "name": "series_type_1", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType1", "x-order": "62" }, { "description": "Price type used as the second part of technical indicator", "in": "query", "name": "series_type_2", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType2", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSub_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Subtraction", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "860", "x-url-hash": "sub", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/sum": { "get": { "description": "The Summation (SUM) endpoint calculates the cumulative total of a specified data series over a defined time period. It returns a numerical value representing the sum, which can be used to track the aggregate value of financial data, such as stock prices or trading volumes, over time. This endpoint is useful for users needing to compute the total accumulation of a dataset for further analysis or reporting.", "operationId": "GetTimeSeriesSum", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "62" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSum_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Summation", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "870", "x-url-hash": "sum", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/supertrend": { "get": { "description": "The Supertrend endpoint provides data on the Supertrend indicator, a tool used to identify potential buy and sell signals in trending markets. It returns values that indicate the current trend direction and potential reversal points based on price, time, and volatility. Users can leverage this data to pinpoint optimal entry and exit points for trades.", "operationId": "GetTimeSeriesSuperTrend", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The period used for calculation in the indicator. Takes values in the range from `1` to `800`", "in": "query", "name": "period", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "Period", "x-order": "61" }, "x-go-name": "Period", "x-order": "61" }, { "description": "The factor used to adjust the indicator's sensitivity.", "in": "query", "name": "multiplier", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": "62" }, "x-go-name": "Multiplier", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrend_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Supertrend", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volatility indicators", "x-order": "880", "x-url-hash": "supertrend", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/supertrend_heikinashicandles": { "get": { "description": "The Supertrend Heikin Ashi candles endpoint provides data combining Supertrend signals with Heikin Ashi candlestick patterns. It returns a series of data points indicating trend direction and smoothed price movements, useful for identifying potential buy or sell opportunities in trading.", "operationId": "GetTimeSeriesSuperTrendHeikinAshiCandles", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The period used for calculation in the indicator. Takes values in the range from `1` to `800`", "in": "query", "name": "period", "schema": { "default": 10, "format": "int64", "type": "integer", "x-go-name": "Period", "x-order": "61" }, "x-go-name": "Period", "x-order": "61" }, { "description": "The factor used to adjust the indicator's sensitivity.", "in": "query", "name": "multiplier", "schema": { "default": 3, "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": "62" }, "x-go-name": "Multiplier", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Supertrend Heikin Ashi candles", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volatility indicators", "x-order": "890", "x-starting-plan": "grow,venture", "x-url-hash": "supertrend-heikinashicandles", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/symbol_search": { "get": { "description": "The symbol search endpoint allows users to find financial instruments by name or symbol. It returns a list of matching symbols, ordered by relevance, with the most relevant instrument first. This is useful for quickly locating specific stocks, ETFs, or other financial instruments when only partial information is available.", "operationId": "GetSymbolSearch", "parameters": [ { "description": "Symbol to search. Supports:\n", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10" }, "x-go-name": "Symbol", "x-order": "10", "example": "AAPL" }, { "description": "Number of matches in response. Max 120", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "maximum": 120, "type": "integer", "x-go-name": "Outputsize", "x-order": "30" }, "x-go-name": "Outputsize", "x-order": "30" }, { "description": "Adds info on which plan symbol is available.", "in": "query", "name": "show_plan", "schema": { "default": false, "type": "boolean", "x-go-name": "ShowPlan", "x-order": "40" }, "x-go-name": "ShowPlan", "x-order": "40" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSymbolSearch_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Symbol search", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-badge": "High demand", "x-group": "Reference data/Discovery", "x-order": "10" } }, "/t3ma": { "get": { "description": "The Triple Exponential Moving Average (T3MA) endpoint calculates a smoothed moving average using three exponential moving averages on price data. It returns a dataset that highlights price trends with reduced lag, offering precise trend analysis. This is useful for identifying trend direction and potential reversal points.", "operationId": "GetTimeSeriesT3ma", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "The factor used to adjust the indicator's volatility. Takes values in the range from `0` to `1`", "in": "query", "name": "v_factor", "schema": { "default": 0.7, "format": "double", "type": "number", "x-go-name": "VFactor", "x-order": "63" }, "x-go-name": "VFactor", "x-order": "63" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesT3ma_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Triple exponential moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "900", "x-url-hash": "t3ma", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/tax_info": { "get": { "description": "The tax information endpoint provides detailed tax-related data for a specified financial instrument, including applicable tax rates and relevant tax codes. This information is essential for users needing to understand the tax implications associated with trading or investing in specific instruments.", "operationId": "GetTaxInfo", "parameters": [ { "description": "The ticker symbol of an instrument for which data is requested, e.g., `SKYQ`, `AIRE`, `ALM:BME`, `HSI:HKEX`.", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "SKYQ" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "30", "x-required-group": "symbol", "example": "US5949181045" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG019XJT9D6" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "25", "x-required-group": "symbol", "example": "594918104" }, { "description": "The exchange name where the instrument is traded, e.g., `Nasdaq`, `Euronext`", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "Nasdaq" }, { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded, e.g., `XNAS`, `XLON`", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaxInfo_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Tax information", "tags": [ "regulatory" ], "x-api-credits-cost": "50", "x-api-credits-type": "symbol", "x-group": "Regulatory", "x-order": "60", "x-starting-plan": "ultra,enterprise", "x-url-hash": "tax-info", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/technical_indicators": { "get": { "description": "The technical indicators endpoint provides a comprehensive list of available technical indicators, each represented as an object. This endpoint is useful for developers looking to integrate a variety of technical analysis tools into their applications, allowing for streamlined access to indicator data without needing to manually configure each one.", "operationId": "GetTechnicalIndicators", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTechnicalIndicators_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Technical indicators", "tags": [ "reference_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "request", "x-group": "Reference data/Supporting metadata", "x-order": "30", "x-url-hash": "technical-indicators-interface" } }, "/tema": { "get": { "description": "The Triple Exponential Moving Average (TEMA) endpoint calculates and returns the TEMA values for a specified financial instrument over a given time period. This endpoint provides a series of data points that smooth out price fluctuations by applying three layers of exponential moving averages, allowing users to identify and track underlying trends in the instrument's price movement.", "operationId": "GetTimeSeriesTema", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "The time period used for calculation in the indicator. Default is 9.", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTema_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Triple exponential moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "910", "x-url-hash": "tema", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/time_series": { "get": { "description": "The time series endpoint provides detailed historical data for a specified financial instrument. It returns two main components: metadata, which includes essential information about the instrument, and a time series dataset. The time series consists of chronological entries with Open, High, Low, and Close prices, and for applicable instruments, it also includes trading volume. This endpoint is ideal for retrieving comprehensive historical price data for analysis or visualization purposes.", "operationId": "GetTimeSeries", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeries_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Time series", "tags": [ "market_data" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-badge": "High demand", "x-group": "Market data", "x-order": "10", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/time_series/cross": { "get": { "description": "The Time Series Cross endpoint calculates and returns historical cross-rate data for exotic forex pairs, cryptocurrencies, or stocks (e.g., Apple Inc. price in Indian Rupees) on the fly. It provides metadata about the requested symbol and a time series array with Open, High, Low, and Close prices, sorted descending by time, enabling analysis of price history and market trends.", "operationId": "GetTimeSeriesCross", "parameters": [ { "description": "Base currency symbol", "in": "query", "name": "base", "required": true, "schema": { "type": "string", "x-go-name": "Base" }, "x-go-name": "Base", "example": "JPY" }, { "description": "Base instrument type according to the `/instrument_type` endpoint", "in": "query", "name": "base_type", "schema": { "type": "string", "x-go-name": "BaseType" }, "x-go-name": "BaseType", "example": "Physical Currency" }, { "description": "Base exchange", "in": "query", "name": "base_exchange", "schema": { "type": "string", "x-go-name": "BaseExchange" }, "x-go-name": "BaseExchange", "example": "Binance" }, { "description": "Base MIC code", "in": "query", "name": "base_mic_code", "schema": { "type": "string", "x-go-name": "BaseMicCode" }, "x-go-name": "BaseMicCode", "example": "XNGS" }, { "description": "Quote currency symbol", "in": "query", "name": "quote", "required": true, "schema": { "type": "string", "x-go-name": "Quote" }, "x-go-name": "Quote", "example": "BTC" }, { "description": "Quote instrument type according to the `/instrument_type` endpoint", "in": "query", "name": "quote_type", "schema": { "type": "string", "x-go-name": "QuoteType" }, "x-go-name": "QuoteType", "example": "Digital Currency" }, { "description": "Quote exchange", "in": "query", "name": "quote_exchange", "schema": { "type": "string", "x-go-name": "QuoteExchange" }, "x-go-name": "QuoteExchange", "example": "Coinbase" }, { "description": "Quote MIC code", "in": "query", "name": "quote_mic_code", "schema": { "type": "string", "x-go-name": "QuoteMicCode" }, "x-go-name": "QuoteMicCode", "example": "XNYS" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "format": "int64", "type": "integer", "x-go-name": "OutputSize" }, "x-go-name": "OutputSize", "example": 30 }, { "description": "Format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "example": "JSON" }, { "description": "Delimiter used in CSV file", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter" }, "x-go-name": "Delimiter", "example": ";" }, { "description": "Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume.", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "PrePost" }, "x-go-name": "PrePost" }, { "description": "Start date for the time series data", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate" }, "x-go-name": "StartDate", "example": "2025-01-01" }, { "description": "End date for the time series data", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate" }, "x-go-name": "EndDate", "example": "2025-01-31" }, { "description": "Specifies if there should be an adjustment", "in": "query", "name": "adjust", "schema": { "default": true, "type": "boolean", "x-go-name": "Adjust" }, "x-go-name": "Adjust" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.", "in": "query", "name": "dp", "schema": { "default": 5, "format": "int64", "type": "integer", "x-go-name": "Dp" }, "x-go-name": "Dp", "example": 5 }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "type": "string", "x-go-name": "Timezone" }, "x-go-name": "Timezone", "example": "UTC" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCross_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Time series cross", "tags": [ "market_data" ], "x-api-credits-cost": "5", "x-api-credits-type": "symbol", "x-group": "Market data", "x-order": "20" } }, "/trange": { "get": { "description": "The True Range (TRANGE) endpoint calculates the range of price movement for a specified period, providing a measure of market volatility. It returns data that includes the highest and lowest prices over the period, along with the closing price from the previous period. This information is useful for traders to assess market volatility and adjust their trading strategies accordingly.", "operationId": "GetTimeSeriesTRange", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTRange_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "True range", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Volatility indicators", "x-order": "920", "x-url-hash": "trange", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/trima": { "get": { "description": "The Triangular Moving Average (TRIMA) endpoint calculates and returns the smoothed average price of a financial security over a specified period, with a focus on central data points. This endpoint provides a balanced view of price trends by applying a double smoothing process, making it useful for identifying underlying price patterns and reducing short-term fluctuations.", "operationId": "GetTimeSeriesTrima", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTrima_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Triangular moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "930", "x-url-hash": "trima", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/tsf": { "get": { "description": "The Time Series Forecast (TSF) endpoint provides projected future price levels using linear regression analysis. It returns data that helps users identify potential support and resistance levels, as well as trend direction in a financial market. This endpoint is useful for traders seeking to anticipate price movements and adjust their strategies accordingly.", "operationId": "GetTimeSeriesTsf", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTsf_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Time series forecast", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "940", "x-url-hash": "tsf", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/typprice": { "get": { "description": "The Typical Price (TYPPRICE) endpoint calculates and returns the average of a financial instrument's high, low, and close prices for a given period. This endpoint provides a simplified metric that reflects the central tendency of price movements, useful for traders and analysts who need a straightforward view of price trends.", "operationId": "GetTimeSeriesTypPrice", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTypPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Typical price", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "950", "x-url-hash": "typprice", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/ultosc": { "get": { "description": "The Ultimate Oscillator endpoint (/ultosc) calculates a momentum oscillator that integrates short, intermediate, and long-term price movements to detect potential overbought or oversold conditions and possible trend reversals. It returns a time series of oscillator values, which can be used to assess market momentum and identify entry or exit points in trading strategies.", "operationId": "GetTimeSeriesUltOsc", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The first time period used for calculation in the indicator. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period_1", "schema": { "default": 7, "format": "int64", "type": "integer", "x-go-name": "TimePeriod1", "x-order": "62" }, "x-go-name": "TimePeriod1", "x-order": "62" }, { "description": "The second time period used for calculation in the indicator. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period_2", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod2", "x-order": "62" }, "x-go-name": "TimePeriod2", "x-order": "62" }, { "description": "The third time period used for calculation in the indicator. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period_3", "schema": { "default": 28, "format": "int64", "type": "integer", "x-go-name": "TimePeriod3", "x-order": "62" }, "x-go-name": "TimePeriod3", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesUltOsc_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Ultimate oscillator endpoint", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "960", "x-url-hash": "ultosc", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/var": { "get": { "description": "The Variance (VAR) endpoint calculates the statistical variance of a financial data series, providing a measure of how much the data points deviate from the average value. It returns a numerical value representing this dispersion, which can be used to assess the volatility of a security over a specified period. This information is crucial for traders and analysts who need to evaluate the risk associated with price fluctuations in the market.", "operationId": "GetTimeSeriesVar", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesVar_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Variance", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Statistic functions", "x-order": "960", "x-url-hash": "var", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/vwap": { "get": { "description": "The Volume Weighted Average Price (VWAP) endpoint provides the VWAP value for a specified stock or asset over a given time period. This indicator calculates the average price at which a security has traded throughout the day, based on both volume and price. It is useful for identifying the true average price of an asset, helping traders to assess the current price relative to the day's average.", "operationId": "GetTimeSeriesVwap", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "The time period for the standard deviation calculation. Must be greater than `0`. Recommended value is `9`.\nThis parameter is only used together with `sd`.", "in": "query", "name": "sd_time_period", "schema": { "default": 0, "format": "int64", "type": "integer", "x-go-name": "SDTimePeriod", "x-order": "62" }, "x-go-name": "SDTimePeriod", "x-order": "62" }, { "description": "The standard deviation applied in the calculation. Must be greater than `0`. Recommended value is `2`.\nThis parameter is only used together with `sd_time_period`.", "in": "query", "name": "sd", "schema": { "default": 0, "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": "61" }, "x-go-name": "StandardDeviation", "x-order": "61" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesVwap_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Volume weighted average price", "tags": [ "technical_indicator" ], "x-additional-notes": "Take note that this endpoint is applicable to all instruments except currencies.", "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "970", "x-url-hash": "vwap", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/wclprice": { "get": { "description": "The Weighted Close Price (WCLPRICE) endpoint calculates a security's average price by giving additional weight to the closing price, using the formula: (High + Low + Close * 2) / 4.", "operationId": "GetTimeSeriesWclPrice", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWclPrice_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Weighted close price", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Price transform", "x-order": "980", "x-url-hash": "wclprice", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/willr": { "get": { "description": "The Williams %R (WILLR) endpoint calculates the Williams Percent Range, a momentum indicator that evaluates a security's closing price relative to its high-low range over a specified period. This endpoint returns data that helps users identify potential overbought or oversold conditions and possible trend reversals in the market.", "operationId": "GetTimeSeriesWillR", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 14, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWillR_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Williams %R", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Momentum indicators", "x-order": "990", "x-url-hash": "willr", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } }, "/wma": { "get": { "description": "The Weighted Moving Average (WMA) endpoint calculates and returns the WMA values for a given security over a specified period. This endpoint provides a time series of weighted averages, where recent prices have a higher influence, allowing users to track and analyze short-term price trends effectively.", "operationId": "GetTimeSeriesWma", "parameters": [ { "description": "Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...", "in": "query", "name": "symbol", "schema": { "type": "string", "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol" }, "x-go-name": "Symbol", "x-order": "10", "x-required-group": "symbol", "example": "AAPL" }, { "description": "Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section", "in": "query", "name": "isin", "schema": { "type": "string", "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol" }, "x-go-name": "Isin", "x-order": "25", "x-required-group": "symbol", "example": "US0378331005" }, { "description": "The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.", "in": "query", "name": "figi", "schema": { "type": "string", "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol" }, "x-go-name": "Figi", "x-order": "20", "x-required-group": "symbol", "example": "BBG000B9Y5X2" }, { "description": "The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section", "in": "query", "name": "cusip", "schema": { "type": "string", "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol" }, "x-go-name": "Cusip", "x-order": "26", "x-required-group": "symbol", "example": "594918104" }, { "description": "Interval between two consecutive points in time series", "in": "query", "name": "interval", "required": true, "schema": { "$ref": "#/components/schemas/IntervalEnum" }, "x-go-name": "Interval", "x-order": "30", "example": "1min" }, { "description": "Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum", "in": "query", "name": "outputsize", "schema": { "default": 30, "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": "80" }, "x-go-name": "PageSize", "x-order": "80" }, { "description": "Exchange where instrument is traded", "in": "query", "name": "exchange", "schema": { "type": "string", "x-go-name": "Exchange", "x-order": "40" }, "x-go-name": "Exchange", "x-order": "40", "example": "NASDAQ" }, { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "in": "query", "name": "mic_code", "schema": { "type": "string", "x-go-name": "MicCode", "x-order": "50" }, "x-go-name": "MicCode", "x-order": "50", "example": "XNAS" }, { "description": "The country where the instrument is traded, e.g., `United States` or `US`", "in": "query", "name": "country", "schema": { "type": "string", "x-go-name": "Country", "x-order": "60" }, "x-go-name": "Country", "x-order": "60", "example": "United States" }, { "description": "The asset class to which the instrument belongs", "in": "query", "name": "type", "schema": { "$ref": "#/components/schemas/TypeEnum" }, "x-go-name": "Type", "x-order": "70", "example": "Common Stock" }, { "description": "Timezone at which output datetime will be displayed. Supports:\n\n

Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.

\nTake note that the IANA Timezone name is case-sensitive", "in": "query", "name": "timezone", "schema": { "default": "Exchange", "type": "string", "x-go-name": "Timezone", "x-order": "135" }, "x-go-name": "Timezone", "x-order": "135" }, { "description": "Can be used separately and together with `end_date`. Format `2006-01-02` or `2006-01-02T15:04:05`\n\nDefault location:\n\nBoth parameters take into account if timezone parameter is provided.
\nIf timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n", "in": "query", "name": "start_date", "schema": { "type": "string", "x-go-name": "StartDate", "x-order": "150" }, "x-go-name": "StartDate", "x-order": "150", "example": "2024-08-22T15:04:05" }, { "description": "The ending date and time for data selection, see `start_date` description for details.", "in": "query", "name": "end_date", "schema": { "type": "string", "x-go-name": "EndDate", "x-order": "160" }, "x-go-name": "EndDate", "x-order": "160", "example": "2024-08-22T16:04:05" }, { "description": "Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`", "in": "query", "name": "date", "schema": { "type": "string", "x-go-name": "Date", "x-order": "140" }, "x-go-name": "Date", "x-order": "140", "example": "2021-10-27" }, { "description": "Sorting order of the output", "in": "query", "name": "order", "schema": { "$ref": "#/components/schemas/OrderEnum" }, "x-go-name": "Order", "x-order": "130" }, { "description": "Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.\nAvailable at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.\nOpen, high, low, close values are supplied without volume", "in": "query", "name": "prepost", "schema": { "default": false, "type": "boolean", "x-go-name": "Prepost", "x-order": "110" }, "x-go-name": "Prepost", "x-order": "110" }, { "description": "The format of the response data", "in": "query", "name": "format", "schema": { "$ref": "#/components/schemas/FormatEnum" }, "x-go-name": "Format", "x-order": "90" }, { "description": "The separator used in the CSV response data", "in": "query", "name": "delimiter", "schema": { "default": ";", "type": "string", "x-go-name": "Delimiter", "x-order": "100" }, "x-go-name": "Delimiter", "x-order": "100" }, { "description": "Specifies the number of decimal places for floating values.\nShould be in range [0, 11] inclusive.\nBy default, the number of decimal places is automatically determined based on the values provided", "in": "query", "name": "dp", "schema": { "default": -1, "format": "int64", "type": "integer", "x-go-name": "DecimalPlaces", "x-order": "120" }, "x-go-name": "DecimalPlaces", "x-order": "120" }, { "description": "A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object", "in": "query", "name": "previous_close", "schema": { "default": false, "type": "boolean", "x-go-name": "PreviousPrice", "x-order": "170" }, "x-go-name": "PreviousPrice", "x-order": "170" }, { "description": "Adjusting mode for prices", "in": "query", "name": "adjust", "schema": { "$ref": "#/components/schemas/AdjustEnum" }, "x-go-name": "Adjust", "x-order": "180" }, { "description": "Price type on which technical indicator is calculated", "in": "query", "name": "series_type", "schema": { "$ref": "#/components/schemas/SeriesTypeEnum" }, "x-go-name": "SeriesType", "x-order": "61" }, { "description": "Number of periods to average over. Takes values in the range from `1` to `800`", "in": "query", "name": "time_period", "schema": { "default": 9, "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": "62" }, "x-go-name": "TimePeriod", "x-order": "62" }, { "description": "Specify if OHLC values should be added in the output", "in": "query", "name": "include_ohlc", "schema": { "default": false, "type": "boolean", "x-go-name": "IncludeOHLC", "x-order": "132" }, "x-go-name": "IncludeOHLC", "x-order": "132" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWma_200_response" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "414": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" } }, "summary": "Weighted moving average", "tags": [ "technical_indicator" ], "x-api-credits-cost": "1", "x-api-credits-type": "symbol", "x-group": "Technical indicators/Overlap studies", "x-order": "1000", "x-url-hash": "wma", "x-required": { "anyOf": [ { "required": [ "symbol", "isin", "figi", "cusip" ] } ] } } } }, "components": { "responses": { "ApiBadRequestErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiBadRequestErrorResponseBody" } } }, "description": "" }, "ApiForbiddenErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiForbiddenErrorResponseBody" } } }, "description": "" }, "ApiInternalServerErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiInternalServerErrorResponseBody" } } }, "description": "" }, "ApiNotFoundErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiNotFoundErrorResponseBody" } } }, "description": "" }, "ApiParameterTooLongErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiParameterTooLongErrorResponseBody" } } }, "description": "" }, "ApiTooManyRequestsErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTooManyRequestsErrorResponseBody" } } }, "description": "" }, "ApiUnauthorizedErrorResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUnauthorizedErrorResponseBody" } } }, "description": "" }, "ApiUsageResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiUsage_200_response" } } }, "description": "" }, "BatchResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advanced_200_response" } } }, "description": "" }, "BondsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBonds_200_response" } } }, "description": "" }, "CommoditiesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommodities_200_response" } } }, "description": "" }, "CrossListingsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCrossListings_200_response" } } }, "description": "" }, "CryptocurrenciesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCryptocurrencies_200_response" } } }, "description": "" }, "CryptocurrencyExchangesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCryptocurrencyExchanges_200_response" } } }, "description": "" }, "CurrencyConversionResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCurrencyConversion_200_response" } } }, "description": "" }, "ETFsFamilyResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsFamily_200_response" } } }, "description": "" }, "ETFsListResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsList_200_response" } } }, "description": "" }, "ETFsTypeResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsType_200_response" } } }, "description": "" }, "EarliestTimestampResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarliestTimestamp_200_response" } } }, "description": "" }, "EarningsCalendarResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarningsCalendar_200_response" } } }, "description": "" }, "EarningsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarnings_200_response" } } }, "description": "" }, "EodResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEod_200_response" } } }, "description": "" }, "EtfResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEtf_200_response" } } }, "description": "" }, "ExchangeRateResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeRate_200_response" } } }, "description": "" }, "ExchangeScheduleResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchangeSchedule_200_response" } } }, "description": "" }, "ExchangesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExchanges_200_response" } } }, "description": "" }, "ForexResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetForexPairs_200_response" } } }, "description": "" }, "FundsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFunds_200_response" } } }, "description": "" }, "GetAssetsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object" } } }, "description": "" }, "GetCountriesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCountries_200_response" } } }, "description": "" }, "GetInstrumentTypeResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInstrumentType_200_response" } } }, "description": "" }, "IndicesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_1" } } }, "description": "" }, "IntervalsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntervals_200_response" } } }, "description": "" }, "MarketMoversResponseValue": { "content": {}, "description": "", "headers": { "volume": { "description": "The trading volume of the symbol today", "schema": { "examples": [ 108297 ], "format": "int64", "type": "integer" } }, "symbol": { "description": "The exchange symbol ticker", "schema": { "examples": [ "BSET" ], "type": "string" } }, "datetime": { "description": "The last updated datetime timestamp", "schema": { "examples": [ "2023-10-01 12:00:00Z" ], "type": "string" } }, "high": { "description": "The highest price for the symbol today", "schema": { "examples": [ 18 ], "format": "double", "type": "number" } }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "schema": { "examples": [ "XNAS" ], "type": "string" } }, "last": { "description": "The latest available price for the symbol today", "schema": { "examples": [ 17.25 ], "format": "double", "type": "number" } }, "low": { "description": "The lowest price for the symbol today", "schema": { "examples": [ 16.5 ], "format": "double", "type": "number" } }, "change": { "description": "The value of the change since the previous day", "schema": { "examples": [ 3.31 ], "format": "double", "type": "number" } }, "name": { "description": "The official name of the instrument", "schema": { "examples": [ "Bassett Furniture Industries Inc" ], "type": "string" } }, "exchange": { "description": "Exchange where instrument is traded", "schema": { "examples": [ "NASDAQ" ], "type": "string" } }, "percent_change": { "description": "The percentage change since the previous day", "schema": { "examples": [ 23.74462 ], "format": "double", "type": "number" } } } }, "MarketStateResponse": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MarketStateResponseItem" }, "type": "array" } } }, "description": "" }, "MoneyMarketFundsListResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMoneyMarketFundsList_200_response" } } }, "description": "" }, "MoneyMarketFundsWorldResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMoneyMarketFundsWorld_200_response" } } }, "description": "" }, "MutualFundsFamilyResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsFamily_200_response" } } }, "description": "" }, "MutualFundsListResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsList_200_response" } } }, "description": "" }, "MutualFundsTypeResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsType_200_response" } } }, "description": "" }, "PressReleasesListParametersResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PressReleasesListParameters_200_response" } } }, "description": "" }, "PriceResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPrice_200_response" } } }, "description": "" }, "QuoteResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuote_200_response" } } }, "description": "" }, "ResponseAnalystRatingsLight": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnalystRatingsLight_200_response" } } }, "description": "" }, "ResponseAnalystRatingsUsEquities": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnalystRatingsUsEquities_200_response" } } }, "description": "" }, "ResponseBalanceSheet": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBalanceSheet_200_response" } } }, "description": "" }, "ResponseBalanceSheetConsolidated": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBalanceSheetConsolidated_200_response" } } }, "description": "" }, "ResponseCashFlow": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCashFlow_200_response" } } }, "description": "" }, "ResponseCashFlowConsolidated": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCashFlowConsolidated_200_response" } } }, "description": "" }, "ResponseDirectHolders": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectHolders_200_response" } } }, "description": "" }, "ResponseDividends": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDividends_200_response" } } }, "description": "" }, "ResponseDividendsCalendar": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DividendsCalendarItem" }, "type": "array" } } }, "description": "" }, "ResponseETFsWorld": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorld_200_response" } } }, "description": "" }, "ResponseETFsWorldComposition": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldComposition_200_response" } } }, "description": "" }, "ResponseETFsWorldPerformance": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldPerformance_200_response" } } }, "description": "" }, "ResponseETFsWorldPurchaseInfo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_2" } } }, "description": "" }, "ResponseETFsWorldRatings": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_3" } } }, "description": "" }, "ResponseETFsWorldRisk": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldRisk_200_response" } } }, "description": "" }, "ResponseETFsWorldSummary": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetETFsWorldSummary_200_response" } } }, "description": "" }, "ResponseETFsWorldSustainability": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_4" } } }, "description": "" }, "ResponseEarningsEstimates": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response" } } }, "description": "" }, "ResponseEdgarFilingsArchive": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEdgarFilingsArchive_200_response" } } }, "description": "" }, "ResponseEpsRevisions": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEpsRevisions_200_response" } } }, "description": "" }, "ResponseEpsTrend": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEpsTrend_200_response" } } }, "description": "" }, "ResponseFundHolders": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFundHolders_200_response" } } }, "description": "" }, "ResponseGrowthEstimates": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGrowthEstimates_200_response" } } }, "description": "" }, "ResponseIncomeStatement": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncomeStatement_200_response" } } }, "description": "" }, "ResponseIncomeStatementConsolidated": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncomeStatementConsolidated_200_response" } } }, "description": "" }, "ResponseInsiderTransactions": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInsiderTransactions_200_response" } } }, "description": "" }, "ResponseInstitutionalHolders": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInstitutionalHolders_200_response" } } }, "description": "" }, "ResponseIpoCalendar": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "$ref": "#/components/schemas/GetIpoCalendar_200_response_value_inner" }, "type": "array" }, "type": "object" } } }, "description": "" }, "ResponseKeyExecutives": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKeyExecutives_200_response" } } }, "description": "" }, "ResponseLastChanges": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLastChanges_200_response" } } }, "description": "" }, "ResponseLogo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLogo_200_response" } } }, "description": "" }, "ResponseMarketCap": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketCap_200_response" } } }, "description": "" }, "ResponseMarketMovers": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketMoversResponseBody" } } }, "description": "" }, "ResponseMutualFundsWorld": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldComposition": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldComposition_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldPerformance": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldPerformance_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldPurchaseInfo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldPurchaseInfo_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldRatings": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldRatings_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldRisk": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldRisk_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldSummary": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldSummary_200_response" } } }, "description": "" }, "ResponseMutualFundsWorldSustainability": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMutualFundsWorldSustainability_200_response" } } }, "description": "" }, "ResponseOptionsChain": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_5" } } }, "description": "" }, "ResponseOptionsExpiration": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_6" } } }, "description": "" }, "ResponsePriceTarget": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPriceTarget_200_response" } } }, "description": "" }, "ResponseProfile": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProfile_200_response" } } }, "description": "" }, "ResponseRecommendations": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRecommendations_200_response" } } }, "description": "" }, "ResponseRevenueEstimate": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRevenueEstimate_200_response" } } }, "description": "" }, "ResponseSourceSanctionedEntities": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSourceSanctionedEntities_200_response" } } }, "description": "" }, "ResponseSplits": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSplits_200_response" } } }, "description": "" }, "ResponseSplitsCalendar": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SplitsCalendarResponseItem" }, "type": "array" } } }, "description": "" }, "ResponseStatistics": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStatistics_200_response" } } }, "description": "" }, "ResponseTaxInfo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaxInfo_200_response" } } }, "description": "" }, "StockExchangesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_7" } } }, "description": "" }, "StocksResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStocks_200_response" } } }, "description": "" }, "SymbolSearchResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSymbolSearch_200_response" } } }, "description": "" }, "TechnicalIndicatorsResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTechnicalIndicators_200_response" } } }, "description": "" }, "TimeSeriesCrossResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCross_200_response" } } }, "description": "" }, "TimeSeriesResponse": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeries_200_response" } } }, "description": "" }, "TimeSeriesResponseAcos": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_8" } } }, "description": "" }, "TimeSeriesResponseAd": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAd_200_response" } } }, "description": "" }, "TimeSeriesResponseAdOsc": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdOsc_200_response" } } }, "description": "" }, "TimeSeriesResponseAdd": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdd_200_response" } } }, "description": "" }, "TimeSeriesResponseAdx": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdx_200_response" } } }, "description": "" }, "TimeSeriesResponseAdxr": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAdxr_200_response" } } }, "description": "" }, "TimeSeriesResponseApo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesApo_200_response" } } }, "description": "" }, "TimeSeriesResponseAroon": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAroon_200_response" } } }, "description": "" }, "TimeSeriesResponseAroonOsc": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAroonOsc_200_response" } } }, "description": "" }, "TimeSeriesResponseAsin": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_9" } } }, "description": "" }, "TimeSeriesResponseAtan": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_10" } } }, "description": "" }, "TimeSeriesResponseAtr": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAtr_200_response" } } }, "description": "" }, "TimeSeriesResponseAvg": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAvg_200_response" } } }, "description": "" }, "TimeSeriesResponseAvgPrice": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesAvgPrice_200_response" } } }, "description": "" }, "TimeSeriesResponseBBands": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBBands_200_response" } } }, "description": "" }, "TimeSeriesResponseBeta": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBeta_200_response" } } }, "description": "" }, "TimeSeriesResponseBop": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesBop_200_response" } } }, "description": "" }, "TimeSeriesResponseCci": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCci_200_response" } } }, "description": "" }, "TimeSeriesResponseCeil": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCeil_200_response" } } }, "description": "" }, "TimeSeriesResponseCmo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCmo_200_response" } } }, "description": "" }, "TimeSeriesResponseCoppock": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCoppock_200_response" } } }, "description": "" }, "TimeSeriesResponseCorrel": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCorrel_200_response" } } }, "description": "" }, "TimeSeriesResponseCos": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_11" } } }, "description": "" }, "TimeSeriesResponseCosh": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_12" } } }, "description": "" }, "TimeSeriesResponseCrsi": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesCrsi_200_response" } } }, "description": "" }, "TimeSeriesResponseDema": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDema_200_response" } } }, "description": "" }, "TimeSeriesResponseDiv": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDiv_200_response" } } }, "description": "" }, "TimeSeriesResponseDpo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDpo_200_response" } } }, "description": "" }, "TimeSeriesResponseDx": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesDx_200_response" } } }, "description": "" }, "TimeSeriesResponseEma": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesEma_200_response" } } }, "description": "" }, "TimeSeriesResponseExp": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesExp_200_response" } } }, "description": "" }, "TimeSeriesResponseFloor": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesFloor_200_response" } } }, "description": "" }, "TimeSeriesResponseHeikinashiCandles": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response" } } }, "description": "" }, "TimeSeriesResponseHlc3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHlc3_200_response" } } }, "description": "" }, "TimeSeriesResponseHtDcPeriod": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPeriod_200_response" } } }, "description": "" }, "TimeSeriesResponseHtDcPhase": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPhase_200_response" } } }, "description": "" }, "TimeSeriesResponseHtPhasor": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtPhasor_200_response" } } }, "description": "" }, "TimeSeriesResponseHtSine": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtSine_200_response" } } }, "description": "" }, "TimeSeriesResponseHtTrendMode": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendMode_200_response" } } }, "description": "" }, "TimeSeriesResponseHtTrendline": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendline_200_response" } } }, "description": "" }, "TimeSeriesResponseIchimoku": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesIchimoku_200_response" } } }, "description": "" }, "TimeSeriesResponseKama": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKama_200_response" } } }, "description": "" }, "TimeSeriesResponseKeltner": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKeltner_200_response" } } }, "description": "" }, "TimeSeriesResponseKst": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesKst_200_response" } } }, "description": "" }, "TimeSeriesResponseLinearReg": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearReg_200_response" } } }, "description": "" }, "TimeSeriesResponseLinearRegAngle": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegAngle_200_response" } } }, "description": "" }, "TimeSeriesResponseLinearRegIntercept": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response" } } }, "description": "" }, "TimeSeriesResponseLinearRegSlope": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegSlope_200_response" } } }, "description": "" }, "TimeSeriesResponseLn": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLn_200_response" } } }, "description": "" }, "TimeSeriesResponseLog10": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesLog10_200_response" } } }, "description": "" }, "TimeSeriesResponseMa": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMa_200_response" } } }, "description": "" }, "TimeSeriesResponseMaVp": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_13" } } }, "description": "" }, "TimeSeriesResponseMacd": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacd_200_response" } } }, "description": "" }, "TimeSeriesResponseMacdExt": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacdExt_200_response" } } }, "description": "" }, "TimeSeriesResponseMacdSlope": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMacdSlope_200_response" } } }, "description": "" }, "TimeSeriesResponseMama": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMama_200_response" } } }, "description": "" }, "TimeSeriesResponseMax": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMax_200_response" } } }, "description": "" }, "TimeSeriesResponseMaxIndex": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMaxIndex_200_response" } } }, "description": "" }, "TimeSeriesResponseMcGinleyDynamic": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response" } } }, "description": "" }, "TimeSeriesResponseMedPrice": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMedPrice_200_response" } } }, "description": "" }, "TimeSeriesResponseMfi": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMfi_200_response" } } }, "description": "" }, "TimeSeriesResponseMidPoint": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMidPoint_200_response" } } }, "description": "" }, "TimeSeriesResponseMidPrice": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMidPrice_200_response" } } }, "description": "" }, "TimeSeriesResponseMin": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMin_200_response" } } }, "description": "" }, "TimeSeriesResponseMinIndex": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinIndex_200_response" } } }, "description": "" }, "TimeSeriesResponseMinMax": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinMax_200_response" } } }, "description": "" }, "TimeSeriesResponseMinMaxIndex": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinMaxIndex_200_response" } } }, "description": "" }, "TimeSeriesResponseMinusDI": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinusDI_200_response" } } }, "description": "" }, "TimeSeriesResponseMinusDM": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMinusDM_200_response" } } }, "description": "" }, "TimeSeriesResponseMom": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMom_200_response" } } }, "description": "" }, "TimeSeriesResponseMult": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesMult_200_response" } } }, "description": "" }, "TimeSeriesResponseNatr": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesNatr_200_response" } } }, "description": "" }, "TimeSeriesResponseObv": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesObv_200_response" } } }, "description": "" }, "TimeSeriesResponsePercent_B": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPercent_B_200_response" } } }, "description": "" }, "TimeSeriesResponsePivotPointsHL": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPivotPointsHL_200_response" } } }, "description": "" }, "TimeSeriesResponsePlusDI": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPlusDI_200_response" } } }, "description": "" }, "TimeSeriesResponsePlusDM": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPlusDM_200_response" } } }, "description": "" }, "TimeSeriesResponsePpo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesPpo_200_response" } } }, "description": "" }, "TimeSeriesResponseRoc": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRoc_200_response" } } }, "description": "" }, "TimeSeriesResponseRocp": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocp_200_response" } } }, "description": "" }, "TimeSeriesResponseRocr": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocr_200_response" } } }, "description": "" }, "TimeSeriesResponseRocr100": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRocr100_200_response" } } }, "description": "" }, "TimeSeriesResponseRsi": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRsi_200_response" } } }, "description": "" }, "TimeSeriesResponseRvol": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesRvol_200_response" } } }, "description": "" }, "TimeSeriesResponseSar": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSar_200_response" } } }, "description": "" }, "TimeSeriesResponseSarExt": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSarExt_200_response" } } }, "description": "" }, "TimeSeriesResponseSin": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_14" } } }, "description": "" }, "TimeSeriesResponseSinh": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_15" } } }, "description": "" }, "TimeSeriesResponseSma": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSma_200_response" } } }, "description": "" }, "TimeSeriesResponseSqrt": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSqrt_200_response" } } }, "description": "" }, "TimeSeriesResponseStdDev": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStdDev_200_response" } } }, "description": "" }, "TimeSeriesResponseStoch": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStoch_200_response" } } }, "description": "" }, "TimeSeriesResponseStochF": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStochF_200_response" } } }, "description": "" }, "TimeSeriesResponseStochRsi": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesStochRsi_200_response" } } }, "description": "" }, "TimeSeriesResponseSub": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSub_200_response" } } }, "description": "" }, "TimeSeriesResponseSum": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSum_200_response" } } }, "description": "" }, "TimeSeriesResponseSuperTrend": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrend_200_response" } } }, "description": "" }, "TimeSeriesResponseSuperTrendHeikinAshiCandles": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response" } } }, "description": "" }, "TimeSeriesResponseT3ma": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesT3ma_200_response" } } }, "description": "" }, "TimeSeriesResponseTRange": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTRange_200_response" } } }, "description": "" }, "TimeSeriesResponseTan": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_16" } } }, "description": "" }, "TimeSeriesResponseTanh": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_17" } } }, "description": "" }, "TimeSeriesResponseTema": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTema_200_response" } } }, "description": "" }, "TimeSeriesResponseTrima": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTrima_200_response" } } }, "description": "" }, "TimeSeriesResponseTsf": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTsf_200_response" } } }, "description": "" }, "TimeSeriesResponseTypPrice": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesTypPrice_200_response" } } }, "description": "" }, "TimeSeriesResponseUltOsc": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesUltOsc_200_response" } } }, "description": "" }, "TimeSeriesResponseVar": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesVar_200_response" } } }, "description": "" }, "TimeSeriesResponseVwap": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesVwap_200_response" } } }, "description": "" }, "TimeSeriesResponseWclPrice": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWclPrice_200_response" } } }, "description": "" }, "TimeSeriesResponseWillR": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWillR_200_response" } } }, "description": "" }, "TimeSeriesResponseWma": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSeriesWma_200_response" } } }, "description": "" } }, "schemas": { "ApiBadRequestErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 400 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "Invalid request" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiForbiddenErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 403 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "API key lacks permissions for the requested resource" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiInternalServerErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 500 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "Internal server error" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiNotFoundErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 404 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "symbol or figi parameter is missing or invalid" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiParameterTooLongErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 414 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "Input parameter array exceeds the allowed length" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiTooManyRequestsErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 429 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "You have run out of API credits for the current minute. 1000 API credits were used, with the current limit being 987. Wait for the next minute or consider upgrading your plan at https://twelvedata.com/pricing" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ApiUnauthorizedErrorResponseBody": { "properties": { "code": { "description": "Error code", "examples": [ 401 ], "format": "int64", "type": "integer", "x-go-name": "Code" }, "message": { "description": "Error message", "examples": [ "apikey parameter is incorrect or not specified" ], "type": "string", "x-go-name": "Message" }, "status": { "description": "Error status", "examples": [ "error" ], "type": "string", "x-go-name": "Status" } }, "required": [ "code", "message", "status" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "AssetsInfo": { "description": "AssetsInfo represents assets information in the balance sheet", "properties": { "total_assets": { "description": "Total assets", "examples": [ 352583000000 ], "format": "double", "type": "number", "x-go-name": "TotalAssets", "x-order": 10 }, "current_assets": { "$ref": "#/components/schemas/AssetsInfo_current_assets" }, "non_current_assets": { "$ref": "#/components/schemas/AssetsInfo_non_current_assets" }, "liabilities": { "$ref": "#/components/schemas/AssetsInfo_liabilities" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "BalanceSheetConsolidatedItem": { "description": "Balance sheet for a specific fiscal date", "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2023-09-30" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "assets": { "$ref": "#/components/schemas/AssetsInfo" } }, "required": [ "fiscal_date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "BondResponseItem": { "description": "BondResponseItem represents details of a bond", "properties": { "symbol": { "description": "Bond symbol", "examples": [ "US2Y" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of the bond", "examples": [ "US Treasury Yield 2 Years" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "country": { "description": "Country where the bond is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "currency": { "description": "Currency of the bond according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 40 }, "exchange": { "description": "Exchange where the bond is traded", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNYS" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the bond", "examples": [ "Bond" ], "type": "string", "x-go-name": "Type", "x-order": 70 }, "access": { "$ref": "#/components/schemas/BondsResponseItemAccess" } }, "required": [ "country", "currency", "exchange", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "BondsResponseItemAccess": { "description": "Info on which plan symbol is available (displayed then `show_plan` is `true`)", "properties": { "global": { "description": "Level of access to the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Global" }, "plan": { "description": "The individual plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Plan" }, "plan_business": { "description": "The business plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "PlanBusiness" } }, "required": [ "global", "plan", "plan_business" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CashFlowData": { "description": "CashFlowData represents cash flow data for a specific fiscal date", "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2023-09-30" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "year": { "description": "Year of the cash flow statement", "examples": [ 2024 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 15 }, "cash_flow_from_operating_activities": { "$ref": "#/components/schemas/CashFlowData_cash_flow_from_operating_activities" }, "cash_flow_from_investing_activities": { "$ref": "#/components/schemas/CashFlowData_cash_flow_from_investing_activities" }, "cash_flow_from_financing_activities": { "$ref": "#/components/schemas/CashFlowData_cash_flow_from_financing_activities" }, "supplemental_data": { "$ref": "#/components/schemas/CashFlowData_supplemental_data" }, "foreign_and_domestic_sales": { "$ref": "#/components/schemas/CashFlowData_foreign_and_domestic_sales" }, "cash_position": { "$ref": "#/components/schemas/CashFlowData_cash_position" }, "direct_method_cash_flow": { "$ref": "#/components/schemas/CashFlowData_direct_method_cash_flow" } }, "required": [ "fiscal_date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CashFlowStruct": { "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2021-12-31" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "quarter": { "description": "Fiscal quarter. Visible when `&period=quarterly`", "examples": [ "1" ], "type": "string", "x-go-name": "Quarter", "x-order": 20 }, "year": { "description": "Fiscal year", "examples": [ 2022 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 25 }, "operating_activities": { "$ref": "#/components/schemas/CashFlowStruct_operating_activities" }, "investing_activities": { "$ref": "#/components/schemas/CashFlowStruct_investing_activities" }, "financing_activities": { "$ref": "#/components/schemas/CashFlowStruct_financing_activities" }, "end_cash_position": { "description": "Returns the amount of cash a company has when adding the change in cash and beginning cash balance for the current fiscal period", "examples": [ 38630000000 ], "format": "double", "type": "number", "x-go-name": "EndCashPosition", "x-order": 60 }, "income_tax_paid": { "description": "Refers to supplemental data about income tax paid", "examples": [ 5235000000 ], "format": "double", "type": "number", "x-go-name": "IncomeTaxPaid", "x-order": 70 }, "interest_paid": { "description": "Refers to supplemental data about interest paid", "examples": [ 531000000 ], "format": "double", "type": "number", "x-go-name": "InterestPaid", "x-order": 80 }, "free_cash_flow": { "description": "Represents the cash a company generates after accounting for cash outflows to support operations and maintain its capital assets", "examples": [ 49769000000 ], "format": "double", "type": "number", "x-go-name": "FreeCashFlow", "x-order": 90 } }, "required": [ "fiscal_date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "CommoditiesResponseItem": { "description": "CommoditiesResponseItem represents details of a commodity", "properties": { "symbol": { "description": "Currency pair according to ISO 4217 standard codes with slash(/) delimiter", "examples": [ "XAU/USD" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of the instrument", "examples": [ "Gold Spot" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "category": { "description": "Category of commodity", "examples": [ "Precious Metal" ], "type": "string", "x-go-name": "Category", "x-order": 30 }, "description": { "description": "Short description of the commodity", "type": "string", "x-go-name": "Description", "x-order": 40 } }, "required": [ "category", "description", "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CountryResponseItem": { "description": "CountryResponseItem represents details of a country", "properties": { "iso2": { "description": "Two-letter country code defined in ISO 3166", "examples": [ "US" ], "type": "string", "x-go-name": "Iso2", "x-order": 10 }, "iso3": { "description": "Three-letter country code defined in ISO 3166", "examples": [ "USA" ], "type": "string", "x-go-name": "Iso3", "x-order": 20 }, "numeric": { "description": "Numeric country code defined in ISO 3166", "examples": [ "840" ], "type": "string", "x-go-name": "Numeric", "x-order": 30 }, "name": { "description": "The full name of country", "examples": [ "United States" ], "type": "string", "x-go-name": "Name", "x-order": 40 }, "official_name": { "description": "Official name of country", "examples": [ "United States of America" ], "type": "string", "x-go-name": "OfficialName", "x-order": 50 }, "capital": { "description": "Capital of country", "examples": [ "Washington D.C." ], "type": "string", "x-go-name": "Capital", "x-order": 60 }, "currency": { "description": "Currency of country", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 70 } }, "required": [ "capital", "currency", "iso2", "iso3", "name", "numeric", "official_name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CrossListingsItem": { "description": "Represents details of a cross listing", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "NVDA" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of symbol", "examples": [ "NVIDIA Corp" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 } }, "required": [ "exchange", "mic_code", "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CrossListingsResult": { "description": "Represents the result of cross listings", "properties": { "count": { "description": "Number of cross listings found", "examples": [ 4 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "list": { "description": "List of cross listings", "examples": [ [ { "exchange": "NASDAQ", "mic_code": "XNGS", "name": "NVIDIA Corporation", "symbol": "NVDA" }, { "exchange": "VSE", "mic_code": "XWBO", "name": "NVIDIA Corporation", "symbol": "NVDA" }, { "exchange": "BVS", "mic_code": "XSGO", "name": "NVIDIA Corporation", "symbol": "NVDACL" }, { "exchange": "BVS", "mic_code": "XSGO", "name": "NVIDIA Corporation", "symbol": "NVDA" } ] ], "items": { "$ref": "#/components/schemas/CrossListingsItem" }, "type": "array", "x-go-name": "List" } }, "required": [ "count", "list" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CrossMeta": { "description": "Json object with request general information", "properties": { "base_instrument": { "description": "Base instrument symbol", "examples": [ "JPY/USD" ], "type": "string", "x-go-name": "BaseInstrument", "x-order": 10 }, "base_currency": { "description": "Base currency", "type": "string", "x-go-name": "BaseCurrency", "x-order": 20 }, "base_exchange": { "description": "Base exchange", "examples": [ "PHYSICAL CURRENCY" ], "type": "string", "x-go-name": "BaseExchange", "x-order": 30 }, "interval": { "description": "Interval between two consecutive points in time series", "examples": [ "1min" ], "type": "string", "x-go-name": "Interval", "x-order": 40 }, "quote_instrument": { "description": "Quote instrument symbol", "examples": [ "BTC/USD" ], "type": "string", "x-go-name": "QuoteInstrument", "x-order": 50 }, "quote_currency": { "description": "Quote currency", "type": "string", "x-go-name": "QuoteCurrency", "x-order": 60 }, "quote_exchange": { "description": "Quote exchange", "examples": [ "Coinbase Pro" ], "type": "string", "x-go-name": "QuoteExchange", "x-order": 70 } }, "required": [ "base_currency", "base_exchange", "base_instrument", "interval", "quote_currency", "quote_exchange", "quote_instrument" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CryptocurrencyExchangesResponseItem": { "properties": { "name": { "description": "Name of cryptocurrency exchange", "examples": [ "Binance" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "CryptocurrencyResponseItem": { "description": "CryptocurrencyResponseItem represents details of a cryptocurrency", "properties": { "symbol": { "description": "Cryptocurrency pair codes with slash(/) delimiter", "examples": [ "BTC/USD" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "available_exchanges": { "description": "List of exchanges where the cryptocurrency is available", "examples": [ [ "ABCC", "Allcoin", "BTC-Alpha", "BTCTurk", "Bibox", "n.exchange", "p2pb2b", "xBTCe" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "AvailableExchanges", "x-order": 20 }, "currency_base": { "description": "Base currency of the cryptocurrency pair", "examples": [ "Bitcoin" ], "type": "string", "x-go-name": "CurrencyBase", "x-order": 30 }, "currency_quote": { "description": "Quote currency of the cryptocurrency pair", "examples": [ "US Dollar" ], "type": "string", "x-go-name": "CurrencyQuote", "x-order": 40 } }, "required": [ "available_exchanges", "currency_base", "currency_quote", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "DirectHolderItem": { "properties": { "entity_name": { "description": "Refers to the legal name of the institution", "examples": [ "Public Investment Fund (Investment Company)" ], "type": "string", "x-go-name": "EntityName", "x-order": 10 }, "date_reported": { "description": "Refers to date reported", "examples": [ "2025-03-13" ], "type": "string", "x-go-name": "DateReported", "x-order": 20 }, "shares": { "description": "Refers to the number of shares owned", "examples": [ 53600000 ], "format": "int64", "type": "integer", "x-go-name": "Shares", "x-order": 30 }, "value": { "description": "Total value of shares owned, calculated by multiplying `shares` by the current price", "examples": [ 43148000000 ], "format": "int64", "type": "integer", "x-go-name": "Value", "x-order": 40 }, "percent_held": { "description": "Represents the percentage of shares outstanding that are owned by the financial institution", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "PercentHeld", "x-order": 50 } }, "required": [ "entity_name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "DividendsCalendarItem": { "description": "DividendsCalendarItem represents details of a dividend", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "MSFT" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "ex_date": { "description": "Stands for the ex date", "examples": [ "2024-02-14" ], "type": "string", "x-go-name": "ExDate", "x-order": 40 }, "amount": { "description": "Dividend payment amount", "examples": [ 0.75 ], "format": "double", "type": "number", "x-go-name": "Amount", "x-order": 50 } }, "required": [ "amount", "ex_date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ETFsListResponseItem": { "properties": { "symbol": { "description": "Instrument symbol (ticker)", "examples": [ "IVV" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of the fund", "examples": [ "iShares Core S&P 500 ETF" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "country": { "description": "Country of fund incorporation", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "iShares" ], "type": "string", "x-go-name": "FundFamily", "x-order": 50 }, "fund_type": { "description": "Type of fund", "examples": [ "Large Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 60 } }, "required": [ "country", "fund_family", "fund_type", "mic_code", "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "EarningsItem": { "properties": { "date": { "description": "Date of earning release", "examples": [ "2020-04-30" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "time": { "description": "Time of earning release, can be either of the following values: `Pre Market`, `After Hours`, `Time Not Supplied`", "examples": [ "After Hours" ], "type": "string", "x-go-name": "Time", "x-order": 20 }, "eps_estimate": { "description": "Analyst estimate of the future company earning", "examples": [ 2.09 ], "format": "double", "type": "number", "x-go-name": "EpsEstimate", "x-order": 30 }, "eps_actual": { "description": "Actual value of reported earning", "examples": [ 2.55 ], "format": "double", "type": "number", "x-go-name": "EpsActual", "x-order": 40 }, "difference": { "description": "Delta between `eps_actual` and `eps_estimate`", "examples": [ 0.46 ], "format": "double", "type": "number", "x-go-name": "Difference", "x-order": 50 }, "surprise_prc": { "description": "Surprise in the percentage of the `eps_actual` related to `eps_estimate`", "examples": [ 22.01 ], "format": "double", "type": "number", "x-go-name": "SurprisePrc", "x-order": 60 } }, "required": [ "date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "EdgarFilingFile": { "description": "Filing file object", "properties": { "name": { "description": "File name", "examples": [ "primary_doc.html" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "size": { "description": "File size", "examples": [ 2980 ], "format": "int64", "type": "integer", "x-go-name": "Size", "x-order": 20 }, "type": { "description": "File type", "examples": [ "144" ], "type": "string", "x-go-name": "Type", "x-order": 30 }, "url": { "description": "File full url", "examples": [ "https://www.sec.gov/Archives/edgar/data/1711463/000197185724000581/primary_doc.xml" ], "type": "string", "x-go-name": "URL", "x-order": 40 } }, "required": [ "name", "type", "url" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "EdgarFilingValue": { "description": "Filing value object", "properties": { "cik": { "description": "CIK code", "examples": [ 1711463 ], "format": "int64", "type": "integer", "x-go-name": "Cik", "x-order": 10 }, "filed_at": { "description": "Filing date in UNIX timestamp", "examples": [ 1726617600 ], "format": "int64", "type": "integer", "x-go-name": "FiledAt", "x-order": 20 }, "files": { "description": "Filing files", "items": { "$ref": "#/components/schemas/EdgarFilingFile" }, "type": "array", "x-go-name": "Files", "x-order": 40 }, "filing_url": { "description": "Full URL of the filing", "examples": [ "https://www.sec.gov/Archives/edgar/data/1711463/0001971857-24-000581-index.htm" ], "type": "string", "x-go-name": "FilingURL", "x-order": 50 }, "form_type": { "description": "Filing form type", "examples": [ "144" ], "type": "string", "x-go-name": "FormType", "x-order": 55 }, "ticker": { "description": "Ticker symbols associated with the filing", "examples": [ [ "AAPL" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Ticker", "x-order": 60 } }, "required": [ "cik", "filed_at", "filing_url", "form_type", "ticker" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "EquityInfo": { "description": "EquityInfo represents equity information", "properties": { "total_equity_gross_minority_interest": { "description": "Total equity gross minority interest", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "TotalEquityGrossMinorityInterest", "x-order": 10 }, "stockholders_equity": { "description": "Stockholders equity", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "StockholdersEquity", "x-order": 20 }, "common_stock_equity": { "description": "Common stock equity", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "CommonStockEquity", "x-order": 30 }, "preferred_stock_equity": { "description": "Preferred stock equity", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "PreferredStockEquity", "x-order": 40 }, "other_equity_interest": { "description": "Other equity interest", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "OtherEquityInterest", "x-order": 50 }, "minority_interest": { "description": "Minority interest", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "MinorityInterest", "x-order": 60 }, "total_capitalization": { "description": "Total capitalization", "examples": [ 157427000000 ], "format": "double", "type": "number", "x-go-name": "TotalCapitalization", "x-order": 70 }, "net_tangible_assets": { "description": "Net tangible assets", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "NetTangibleAssets", "x-order": 80 }, "tangible_book_value": { "description": "Tangible book value", "examples": [ 62146000000 ], "format": "double", "type": "number", "x-go-name": "TangibleBookValue", "x-order": 90 }, "invested_capital": { "description": "Invested capital", "examples": [ 173234000000 ], "format": "double", "type": "number", "x-go-name": "InvestedCapital", "x-order": 100 }, "working_capital": { "description": "Working capital", "examples": [ -1742000000 ], "format": "double", "type": "number", "x-go-name": "WorkingCapital", "x-order": 110 }, "capital_stock": { "$ref": "#/components/schemas/EquityInfo_capital_stock" }, "equity_adjustments": { "$ref": "#/components/schemas/EquityInfo_equity_adjustments" }, "net_debt": { "description": "Net debt", "examples": [ 81123000000 ], "format": "double", "type": "number", "x-go-name": "NetDebt", "x-order": 140 }, "total_debt": { "description": "Total debt", "examples": [ 123930000000 ], "format": "double", "type": "number", "x-go-name": "TotalDebt", "x-order": 150 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "EtfResponseItem": { "description": "EtfResponseItem represents details of an ETF", "properties": { "symbol": { "description": "Instrument symbol (ticker)", "examples": [ "SPY" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of the ETF", "examples": [ "SPDR S&P 500 ETF Trust" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the ETF according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where the ETF is traded", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "ARCX" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "country": { "description": "Country where the ETF is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 60 }, "figi_code": { "description": "Financial instrument global identifier (FIGI)", "examples": [ "BBG000BDTF76" ], "type": "string", "x-go-name": "FigiCode", "x-order": 70 }, "cfi_code": { "description": "Classification of Financial Instruments (CFI)", "examples": [ "CECILU" ], "type": "string", "x-go-name": "CfiCode", "x-order": 80 }, "isin": { "description": "International securities identification number (ISIN)", "examples": [ "US78462F1030" ], "type": "string", "x-go-name": "Isin", "x-order": 100 }, "cusip": { "description": "A unique nine-character alphanumeric code used to identify financial securities, ensuring accurate data retrieval for the specified asset", "examples": [ "037833100" ], "type": "string", "x-go-name": "Cusip", "x-order": 110 }, "access": { "$ref": "#/components/schemas/EtfResponseItem_access" } }, "required": [ "cfi_code", "country", "currency", "cusip", "exchange", "figi_code", "isin", "mic_code", "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ExchangeScheduleResponseItem": { "description": "ExchangeScheduleResponseItem represents details of an exchange schedule", "properties": { "title": { "description": "Official name of exchange", "examples": [ "NASDAQ/NGS (Global Select Market)" ], "type": "string", "x-go-name": "Title", "x-order": 10 }, "name": { "description": "Name of exchange", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNYS" ], "type": "string", "x-go-name": "Code", "x-order": 30 }, "country": { "description": "Country to which stock exchange belongs to", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 40 }, "time_zone": { "description": "Time zone where exchange is located", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "TimeZone", "x-order": 50 }, "sessions": { "description": "Exchange trading hours", "items": { "$ref": "#/components/schemas/ExchangeScheduleSession" }, "type": "array", "x-go-name": "Sessions", "x-order": 60 } }, "required": [ "code", "country", "name", "sessions", "time_zone", "title" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ExchangeScheduleSession": { "description": "ExchangeScheduleSession represents a trading session", "properties": { "open_time": { "description": "Opening time of the session", "examples": [ "04:00:00" ], "type": "string", "x-go-name": "OpenTime", "x-order": 10 }, "close_time": { "description": "Closing time of the session", "examples": [ "09:30:00" ], "type": "string", "x-go-name": "CloseTime", "x-order": 20 }, "session_name": { "description": "Name of the session", "examples": [ "Pre market" ], "type": "string", "x-go-name": "SessionName", "x-order": 30 }, "session_type": { "description": "Type of the session", "examples": [ "pre" ], "type": "string", "x-go-name": "SessionType", "x-order": 40 } }, "required": [ "close_time", "open_time", "session_name", "session_type" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ExchangesResponseItem": { "description": "ExchangesResponseItem represents details of an exchange", "properties": { "title": { "description": "Title of exchange", "examples": [ "Argentinian Stock Exchange" ], "type": "string", "x-go-name": "Title", "x-order": 5 }, "name": { "description": "Name of exchange", "examples": [ "BCBA" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XBUE" ], "type": "string", "x-go-name": "Code", "x-order": 20 }, "country": { "description": "Country to which stock exchange belongs to", "examples": [ "Argentina" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "timezone": { "description": "Time zone where exchange is located", "examples": [ "America/Argentina/Buenos_Aires" ], "type": "string", "x-go-name": "Timezone", "x-order": 40 }, "access": { "$ref": "#/components/schemas/ExchangesResponseItemAccess" } }, "required": [ "code", "country", "name", "timezone", "title" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ExchangesResponseItemAccess": { "description": "Info on which plan symbol is available (displayed then `show_plan` is `true`)", "properties": { "global": { "description": "Level of access to the symbol", "examples": [ "Pro" ], "type": "string", "x-go-name": "Global" }, "plan": { "description": "The individual plan name for the symbol", "examples": [ "Pro" ], "type": "string", "x-go-name": "Plan" }, "plan_business": { "description": "The business plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "PlanBusiness" } }, "required": [ "global", "plan", "plan_business" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ForexResponseItem": { "description": "ForexResponseItem represents details of a forex pair", "properties": { "symbol": { "description": "Currency pair according to ISO 4217 standard codes with slash(/) delimiter", "examples": [ "EUR/USD" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "currency_group": { "description": "Group to which currency pair belongs to, could be: Major, Minor, Exotic and Exotic-Cross", "examples": [ "Major" ], "type": "string", "x-go-name": "CurrencyGroup", "x-order": 20 }, "currency_base": { "description": "Base currency name according to ISO 4217 standard", "examples": [ "EUR" ], "type": "string", "x-go-name": "CurrencyBase", "x-order": 30 }, "currency_quote": { "description": "Quote currency name according to ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "CurrencyQuote", "x-order": 40 } }, "required": [ "currency_base", "currency_group", "currency_quote", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "FundHolderItem": { "properties": { "entity_name": { "description": "Refers to the legal name of the institution", "examples": [ "VANGUARD INDEX FUNDS-Vanguard Total Stock Market Index Fund" ], "type": "string", "x-go-name": "EntityName", "x-order": 10 }, "date_reported": { "description": "Refers to date reported", "examples": [ "2025-09-30" ], "type": "string", "x-go-name": "DateReported", "x-order": 20 }, "shares": { "description": "Refers to the number of shares owned", "examples": [ 467135722 ], "format": "int64", "type": "integer", "x-go-name": "Shares", "x-order": 30 }, "value": { "description": "Total value of shares owned, calculated by multiplying `shares` by the current price", "examples": [ 129695568698 ], "format": "int64", "type": "integer", "x-go-name": "Value", "x-order": 40 }, "percent_held": { "description": "Represents the percentage of shares outstanding that are owned by the financial institution", "examples": [ 0.031600002 ], "format": "double", "type": "number", "x-go-name": "PercentHeld", "x-order": 50 } }, "required": [ "entity_name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "FundResponseItem": { "description": "FundResponseItem represents details of a fund", "properties": { "symbol": { "description": "Instrument symbol (ticker)", "examples": [ "DIVI" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of the fund", "examples": [ "AdvisorShares Athena High Dividend ETF" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "country": { "description": "Country where the fund is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "currency": { "description": "Currency of the fund according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 40 }, "exchange": { "description": "Exchange where the fund is traded", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "ARCX" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the fund", "examples": [ "ETF" ], "type": "string", "x-go-name": "Type", "x-order": 70 }, "figi_code": { "description": "Financial instrument global identifier (FIGI)", "examples": [ "BBG00161BCW4" ], "type": "string", "x-go-name": "FigiCode", "x-order": 80 }, "cfi_code": { "description": "Classification of Financial Instruments (CFI)", "examples": [ "CECILU" ], "type": "string", "x-go-name": "CfiCode", "x-order": 90 }, "isin": { "description": "International securities identification number (ISIN)", "examples": [ "GB00B65TLW28" ], "type": "string", "x-go-name": "Isin", "x-order": 100 }, "cusip": { "description": "A unique nine-character alphanumeric code used to identify financial securities, ensuring accurate data retrieval for the specified asset", "examples": [ "35473P108" ], "type": "string", "x-go-name": "Cusip", "x-order": 110 }, "access": { "$ref": "#/components/schemas/EtfResponseItem_access" } }, "required": [ "cfi_code", "country", "currency", "cusip", "exchange", "figi_code", "isin", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "GetAssetsResponseItem": { "properties": { "code": { "description": "Currency code", "examples": [ "AUD" ], "type": "string", "x-go-name": "Code" }, "description": { "description": "Description of the asset", "examples": [ "Australian Dollar" ], "type": "string", "x-go-name": "Description" }, "icon": { "description": "Icon of the asset", "examples": [ "https://twelvedata.com/icons/AUD.svg" ], "type": "string", "x-go-name": "Icon" }, "mic_code": { "description": "Market identifier code, e.g. DIGITAL_CURRENCY, PHYSICAL_CURRENCY, etc.", "examples": [ "PHYSICAL_CURRENCY" ], "type": "string", "x-go-name": "MicCode" }, "symbol": { "description": "Currency symbol", "examples": [ "A$" ], "type": "string", "x-go-name": "Symbol" } }, "required": [ "code", "mic_code" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "IncomeStatementBlock": { "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2021-12-31" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "quarter": { "description": "Fiscal quarter. Visible when `&period=quarterly`", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "Quarter", "x-order": 20 }, "year": { "description": "Fiscal year", "examples": [ 2022 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 30 }, "sales": { "description": "Refers to total reported revenue", "examples": [ 123945000000 ], "format": "int64", "type": "integer", "x-go-name": "Sales", "x-order": 40 }, "cost_of_goods": { "description": "Refers to cost of revenue", "examples": [ 69702000000 ], "format": "int64", "type": "integer", "x-go-name": "CostOfGoods", "x-order": 50 }, "gross_profit": { "description": "Refers to net gross profit: `sales` - `cost_of_goods`", "examples": [ 54243000000 ], "format": "int64", "type": "integer", "x-go-name": "GrossProfit", "x-order": 60 }, "operating_expense": { "$ref": "#/components/schemas/IncomeStatementBlock_operating_expense" }, "operating_income": { "description": "Refers to net operating income: `gross_profit` - `research_and_development` - `selling_general_and_administrative`", "examples": [ 41488000000 ], "format": "int64", "type": "integer", "x-go-name": "OperatingIncome", "x-order": 80 }, "non_operating_interest": { "$ref": "#/components/schemas/IncomeStatementBlock_non_operating_interest" }, "other_income_expense": { "description": "Refers to other incomes or expenses", "examples": [ -203000000 ], "format": "int64", "type": "integer", "x-go-name": "OtherIncomeExpense", "x-order": 100 }, "pretax_income": { "description": "Refers to earnings before tax: `operating_income` + `net_non_operating_interest` - `other_income_expense`", "examples": [ 41241000000 ], "format": "int64", "type": "integer", "x-go-name": "PretaxIncome", "x-order": 110 }, "income_tax": { "description": "Refers to a tax provision", "examples": [ 6611000000 ], "format": "int64", "type": "integer", "x-go-name": "IncomeTax", "x-order": 120 }, "net_income": { "description": "Refers to net income: `pretax_income` - `income_tax`", "examples": [ 34630000000 ], "format": "int64", "type": "integer", "x-go-name": "NetIncome", "x-order": 130 }, "eps_basic": { "description": "Refers to earnings per share (EPS)", "examples": [ 2.11 ], "format": "double", "type": "number", "x-go-name": "EPSBasic", "x-order": 140 }, "eps_diluted": { "description": "Refers to diluted earnings per share (EPS)", "examples": [ 2.1 ], "format": "double", "type": "number", "x-go-name": "EPSDiluted", "x-order": 150 }, "basic_shares_outstanding": { "description": "Refers for the shares outstanding held by all its shareholders", "examples": [ 16391724000 ], "format": "int64", "type": "integer", "x-go-name": "BasicSharesOutstanding", "x-order": 160 }, "diluted_shares_outstanding": { "description": "Refers to the total number of shares a company would have if all dilutive securities were exercised and converted into shares", "examples": [ 16391724000 ], "format": "int64", "type": "integer", "x-go-name": "DilutedSharesOutstanding", "x-order": 170 }, "ebit": { "description": "Refers to earnings before interest and taxes (EBIT) measure", "examples": [ 41488000000 ], "format": "int64", "type": "integer", "x-go-name": "EBIT", "x-order": 175 }, "ebitda": { "description": "Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure", "examples": [ 44632000000 ], "format": "int64", "type": "integer", "x-go-name": "EBITDA", "x-order": 180 }, "net_income_continuous_operations": { "description": "Refers to the after-tax earnings that a business has generated from its operational activities", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "NetIncomeContinuousOperations", "x-order": 190 }, "minority_interests": { "description": "Refers to amount of minority interests paid out", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "MinorityInterests", "x-order": 200 }, "preferred_stock_dividends": { "description": "Refers to dividend that is allocated to and paid on a company's preferred shares", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "PreferredStockDividends", "x-order": 210 } }, "required": [ "fiscal_date" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "IncomeStatementItem": { "description": "IncomeStatementItem represents a single income statement record", "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2023-09-30" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "year": { "description": "Fiscal year", "examples": [ 2022 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 15 }, "revenue": { "$ref": "#/components/schemas/IncomeStatementItem_revenue" }, "gross_profit": { "$ref": "#/components/schemas/IncomeStatementItem_gross_profit" }, "operating_income": { "$ref": "#/components/schemas/IncomeStatementItem_operating_income" }, "net_income": { "$ref": "#/components/schemas/IncomeStatementItem_net_income" }, "earnings_per_share": { "$ref": "#/components/schemas/IncomeStatementItem_earnings_per_share" }, "expenses": { "$ref": "#/components/schemas/IncomeStatementItem_expenses" }, "interest_income_and_expense": { "$ref": "#/components/schemas/IncomeStatementItem_interest_income_and_expense" }, "other_income_and_expenses": { "$ref": "#/components/schemas/IncomeStatementItem_other_income_and_expenses" }, "taxes": { "$ref": "#/components/schemas/IncomeStatementItem_taxes" }, "depreciation_and_amortization": { "$ref": "#/components/schemas/IncomeStatementItem_depreciation_and_amortization" }, "ebitda": { "$ref": "#/components/schemas/IncomeStatementItem_ebitda" }, "dividends_and_shares": { "$ref": "#/components/schemas/IncomeStatementItem_dividends_and_shares" }, "unusual_items": { "$ref": "#/components/schemas/IncomeStatementItem_unusual_items" }, "depreciation": { "$ref": "#/components/schemas/IncomeStatementItem_depreciation" }, "pretax_income": { "$ref": "#/components/schemas/IncomeStatementItem_pretax_income" }, "special_income_charges": { "$ref": "#/components/schemas/IncomeStatementItem_special_income_charges" } }, "required": [ "fiscal_date", "year" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "Index": { "description": "Indices info", "properties": { "country": { "type": "string", "x-go-name": "Country" }, "currency": { "type": "string", "x-go-name": "Currency" }, "exchange": { "type": "string", "x-go-name": "Exchange" }, "mic_code": { "type": "string", "x-go-name": "ExchangeCode" }, "name": { "type": "string", "x-go-name": "Name" }, "symbol": { "type": "string", "x-go-name": "Symbol" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/core-go/model/entity" }, "InstitutionalHolderItem": { "properties": { "entity_name": { "description": "Refers to the legal name of the institution", "examples": [ "Vanguard Group Inc" ], "type": "string", "x-go-name": "EntityName", "x-order": 10 }, "date_reported": { "description": "Refers to date reported", "examples": [ "2025-09-30" ], "type": "string", "x-go-name": "DateReported", "x-order": 20 }, "shares": { "description": "Refers to the number of shares owned", "examples": [ 1399427162 ], "format": "int64", "type": "integer", "x-go-name": "Shares", "x-order": 30 }, "value": { "description": "Total value of shares owned, calculated by multiplying `shares` by the current price", "examples": [ 388536977757 ], "format": "int64", "type": "integer", "x-go-name": "Value", "x-order": 40 }, "percent_held": { "description": "Represents the percentage of shares outstanding that are owned by the financial institution", "examples": [ 0.0947 ], "format": "double", "type": "number", "x-go-name": "PercentHeld", "x-order": 50 } }, "required": [ "entity_name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "LastChangeResponseItem": { "properties": { "symbol": { "description": "Ticker of the company", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 20 }, "last_change": { "description": "The date and time of last changes, in `2006-01-02 15:04:05` format", "examples": [ "2023-10-14 12:22:48" ], "type": "string", "x-go-name": "LastChange", "x-order": 30 } }, "required": [ "last_change", "mic_code", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "MarketMoversResponseBody": { "properties": { "values": { "description": "Market movers list", "items": { "$ref": "#/components/schemas/MarketMoversResponseValue" }, "type": "array", "x-go-name": "Values", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "status", "values" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "MarketMoversResponseValue": { "properties": { "symbol": { "description": "The exchange symbol ticker", "examples": [ "BSET" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "The official name of the instrument", "examples": [ "Bassett Furniture Industries Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "datetime": { "description": "The last updated datetime timestamp", "examples": [ "2023-10-01 12:00:00Z" ], "type": "string", "x-go-name": "Datetime", "x-order": 50 }, "last": { "description": "The latest available price for the symbol today", "examples": [ 17.25 ], "format": "double", "type": "number", "x-go-name": "Last", "x-order": 60 }, "high": { "description": "The highest price for the symbol today", "examples": [ 18 ], "format": "double", "type": "number", "x-go-name": "High", "x-order": 70 }, "low": { "description": "The lowest price for the symbol today", "examples": [ 16.5 ], "format": "double", "type": "number", "x-go-name": "Low", "x-order": 80 }, "volume": { "description": "The trading volume of the symbol today", "examples": [ 108297 ], "format": "int64", "type": "integer", "x-go-name": "Volume", "x-order": 90 }, "change": { "description": "The value of the change since the previous day", "examples": [ 3.31 ], "format": "double", "type": "number", "x-go-name": "Change", "x-order": 100 }, "percent_change": { "description": "The percentage change since the previous day", "examples": [ 23.74462 ], "format": "double", "type": "number", "x-go-name": "PercentChange", "x-order": 110 } }, "required": [ "change", "datetime", "high", "last", "low", "name", "percent_change", "symbol", "volume" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "MarketStateResponseItem": { "properties": { "name": { "description": "The full name of exchange", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNYS" ], "type": "string", "x-go-name": "Code", "x-order": 20 }, "country": { "description": "Country where the exchange is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "is_market_open": { "description": "Indicates if the market is currently open", "examples": [ true ], "type": "boolean", "x-go-name": "IsMarketOpen", "x-order": 40 }, "time_after_open": { "description": "Time after market opening in HH:MM:SS format; if currently closed - returns 00:00:00", "examples": [ "02:39:03" ], "type": "string", "x-go-name": "TimeAfterOpen", "x-order": 50 }, "time_to_open": { "description": "Time to market opening in HH:MM:SS format; if currently open - returns 00:00:00", "examples": [ "00:00:00" ], "type": "string", "x-go-name": "TimeToOpen", "x-order": 60 }, "time_to_close": { "description": "Time to market closing in HH:MM:SS format; if currently closed - returns 00:00:00", "examples": [ "05:20:57" ], "type": "string", "x-go-name": "TimeToClose", "x-order": 70 } }, "required": [ "code", "country", "is_market_open", "name", "time_after_open", "time_to_close", "time_to_open" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "MoneyMarketFundsListResponseListItem": { "properties": { "symbol": { "description": "Fund symbol (ISIN or ticker)", "examples": [ "IE00BK8M8M59" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "BlackRock ICS Sterling Liquid Environmentally Aware Fund" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the fund is denominated", "examples": [ "GBP" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "share_class": { "description": "Share class", "examples": [ "Premier Dis" ], "type": "string", "x-go-name": "ShareClass", "x-order": 40 }, "fund_family": { "description": "Investment company family that manages the fund", "examples": [ "BlackRock ICS" ], "type": "string", "x-go-name": "FundFamily", "x-order": 50 }, "fund_type": { "description": "Type of fund", "examples": [ "Short-Term Variable NAV" ], "type": "string", "x-go-name": "FundType", "x-order": 60 }, "regulatory_structure": { "description": "Regulatory structure", "examples": [ "UCITS" ], "type": "string", "x-go-name": "RegulatoryStructure", "x-order": 70 }, "domicile": { "description": "Country of fund domicile (ISO 3166-1 alpha-2 code)", "examples": [ "IE" ], "type": "string", "x-go-name": "Domicile", "x-order": 80 }, "issuing_company": { "description": "Company that issues the fund", "examples": [ "BlackRock Asset Management Ireland Limited" ], "type": "string", "x-go-name": "IssuingCompany", "x-order": 90 } }, "required": [ "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "MoneyMarketFundsWorldResponseItem": { "properties": { "symbol": { "description": "Fund symbol (ISIN or ticker)", "examples": [ "IE00BK8M8M59" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "BlackRock ICS Sterling Liquid Environmentally Aware Fund" ], "type": "string", "x-go-name": "Name", "x-order": 40 }, "currency": { "description": "Currency in which the fund is denominated", "examples": [ "GBP" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "share_class": { "description": "Share class", "examples": [ "Premier Dis" ], "type": "string", "x-go-name": "ShareClass", "x-order": 60 }, "fund_type": { "description": "Type of fund", "examples": [ "Short-Term Variable NAV" ], "type": "string", "x-go-name": "FundType", "x-order": 70 }, "total_fund_size_millions": { "description": "Total fund size in millions", "examples": [ 12345.67 ], "format": "double", "type": "number", "x-go-name": "TotalFundSizeMillions", "x-order": 80 }, "daily_factor": { "description": "Daily distribution factor", "format": "double", "type": "number", "x-go-name": "DailyFactor", "x-order": 90 }, "daily_liquidity_pct_nav": { "description": "Daily liquid assets as a percentage of NAV", "examples": [ 45.6 ], "format": "double", "type": "number", "x-go-name": "DailyLiquidityPctNav", "x-order": 100 }, "weekly_liquidity_pct_nav": { "description": "Weekly liquid assets as a percentage of NAV", "examples": [ 67.8 ], "format": "double", "type": "number", "x-go-name": "WeeklyLiquidityPctNav", "x-order": 110 }, "wam_days": { "description": "Weighted average maturity in days", "examples": [ 38 ], "format": "int64", "type": "integer", "x-go-name": "WamDays", "x-order": 120 }, "wal_days": { "description": "Weighted average life in days", "examples": [ 62 ], "format": "int64", "type": "integer", "x-go-name": "WalDays", "x-order": 130 }, "daily_netflows": { "description": "Daily net flows", "format": "double", "type": "number", "x-go-name": "DailyNetflows", "x-order": 140 }, "as_of_date": { "description": "Date the snapshot data is as of", "examples": [ "2024-12-31" ], "type": "string", "x-go-name": "AsOfDate", "x-order": 150 }, "fund_overview": { "description": "Fund overview text", "type": "string", "x-go-name": "FundOverview", "x-order": 160 }, "nav": { "description": "Net asset value", "examples": [ 1 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 170 }, "yield_1m": { "description": "1-month yield", "examples": [ 5.12 ], "format": "double", "type": "number", "x-go-name": "Yield1m", "x-order": 180 }, "yield_3m": { "description": "3-month yield", "examples": [ 5.05 ], "format": "double", "type": "number", "x-go-name": "Yield3m", "x-order": 200 }, "yield_6m": { "description": "6-month yield", "examples": [ 4.98 ], "format": "double", "type": "number", "x-go-name": "Yield6m", "x-order": 210 }, "yield_1y": { "description": "1-year yield", "examples": [ 4.85 ], "format": "double", "type": "number", "x-go-name": "Yield1y", "x-order": 220 }, "key_facts": { "description": "Key facts about the fund", "type": "object", "x-go-name": "KeyFacts", "x-order": 230 }, "risk_indicator": { "description": "Risk indicator details", "type": "object", "x-go-name": "RiskIndicator", "x-order": 240 }, "key_risks": { "description": "Key risks of the fund", "type": "object", "x-go-name": "KeyRisks", "x-order": 250 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "MutualFundsListResponseListItem": { "properties": { "symbol": { "description": "Fund symbol ticker", "examples": [ "0P0001LCQ3" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "JNL Small Cap Index Fund (I)" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "country": { "description": "Country of fund incorporation", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 30 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "Jackson National" ], "type": "string", "x-go-name": "FundFamily", "x-order": 40 }, "fund_type": { "description": "Type of fund", "examples": [ "Small Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 50 }, "performance_rating": { "description": "Performance rating from `0` to `5`", "examples": [ 2 ], "format": "int64", "type": "integer", "x-go-name": "PerformanceRating", "x-order": 60 }, "risk_rating": { "description": "Risk rating from `0` to `5`", "examples": [ 4 ], "format": "int64", "type": "integer", "x-go-name": "RiskRating", "x-order": 70 }, "currency": { "description": "Currency code in which the fund is denominated", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 80 }, "exchange": { "description": "Exchange name where the fund is listed", "examples": [ "OTC" ], "type": "string", "x-go-name": "Exchange", "x-order": 90 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "OTCM" ], "type": "string", "x-go-name": "MicCode", "x-order": 100 } }, "required": [ "country", "currency", "exchange", "fund_family", "fund_type", "mic_code", "name", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "OptionSide": { "properties": { "ask": { "format": "double", "type": "number", "x-go-name": "Ask" }, "bid": { "format": "double", "type": "number", "x-go-name": "Bid" }, "change": { "format": "double", "type": "number", "x-go-name": "Change" }, "contract_name": { "type": "string", "x-go-name": "ContractName" }, "implied_volatility": { "format": "double", "type": "number", "x-go-name": "ImpliedVolatility" }, "in_the_money": { "type": "boolean", "x-go-name": "InTheMoney" }, "last_price": { "format": "double", "type": "number", "x-go-name": "LastPrice" }, "last_trade_date": { "type": "string", "x-go-name": "LastTradeDate" }, "open_interest": { "format": "int64", "type": "integer", "x-go-name": "OpenInterest" }, "option_id": { "type": "string", "x-go-name": "OptionID" }, "percent_change": { "format": "double", "type": "number", "x-go-name": "PercentChange" }, "strike": { "format": "double", "type": "number", "x-go-name": "Strike" }, "volume": { "format": "int64", "type": "integer", "x-go-name": "Volume" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "PressRelease": { "properties": { "id": { "description": "Press release unique identifier", "examples": [ "20251201SF35699" ], "type": "string", "x-go-name": "ReleaseId", "x-order": 10 }, "datetime": { "description": "Press release date in ISO 8601 format", "examples": [ "2021-11-12T11:21:00+01:00" ], "type": "string", "x-go-name": "ReleaseDate", "x-order": 20 }, "title": { "description": "Press release title", "examples": [ "NVIDIA and Synopsys Announce Strategic Partnership to Revolutionize Engineering and Design" ], "type": "string", "x-go-name": "Title", "x-order": 30 }, "body": { "description": "Press release body in html format", "examples": [ "<b>Key Highlights</b><ul><li>Multi-year collaboration spans NVIDIA CUDA accelerated computing, agentic and physical AI, and Omniverse digital twins to achieve simulation speed and scale previously unattainable through traditional CPU computing – opening new market opportunities across engineering.</li><li>To further adoption of GPU-accelerated engineering solutions, the companies will collaborate in engineering and marketing activities.</li><li>NVIDIA invested $2 billion in Synopsys common stock.</li></ul>..." ], "type": "string", "x-go-name": "Body", "x-order": 40 }, "style": { "description": "Custom style applied to the release", "examples": [ "/* Style Definitions */ ..." ], "type": "string", "x-go-name": "Style", "x-order": 50 }, "language": { "description": "Press release language codes", "examples": [ [ "en", "en-US" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Language", "x-order": 60 } }, "required": [ "body", "datetime", "id", "title" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldComposition": { "description": "Mutual fund composition", "properties": { "major_market_sectors": { "description": "Breakdown of the fund’s portfolio by major industry sectors and their respective weights", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner" }, "type": "array", "x-go-name": "MajorMarketSectors", "x-order": 10 }, "asset_allocation": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation" }, "top_holdings": { "description": "Top holdings of the fund with their respective weights in the overall portfolio composition", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner" }, "type": "array", "x-go-name": "TopHoldings", "x-order": 20 }, "bond_breakdown": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldPerformance": { "description": "Detailed performance of a mutual fund", "properties": { "trailing_returns": { "description": "Trailing returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner" }, "type": "array", "x-go-name": "TrailingReturns", "x-order": 10 }, "annual_total_returns": { "description": "Annual total returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner" }, "type": "array", "x-go-name": "AnnualTotalReturns", "x-order": 20 }, "quarterly_total_returns": { "description": "Quarterly total returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner" }, "type": "array", "x-go-name": "QuarterlyTotalReturns", "x-order": 30 }, "load_adjusted_return": { "description": "Load adjusted return of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner" }, "type": "array", "x-go-name": "LoadAdjustedReturn", "x-order": 40 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldPurchaseInfo": { "description": "Purchase information for the mutual fund", "properties": { "expenses": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses" }, "minimums": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums" }, "pricing": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing" }, "brokerages": { "description": "List of brokerages where mutual fund can be purchased", "examples": [ [] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Brokerages", "x-order": 40 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldRatings": { "description": "Ratings of a mutual fund", "properties": { "performance_rating": { "description": "Performance rating from 0 to 5", "examples": [ 2 ], "format": "int64", "type": "integer", "x-go-name": "PerformanceRating", "x-order": 10 }, "risk_rating": { "description": "Risk rating from 0 to 5", "examples": [ 4 ], "format": "int64", "type": "integer", "x-go-name": "RiskRating", "x-order": 20 }, "return_rating": { "description": "Return rating from 0 to 5", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "ReturnRating", "x-order": 30 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldRisk": { "description": "Risk and volatility statistics of the fund and its category over different periods", "properties": { "volatility_measures": { "description": "Volatility statistics of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner" }, "type": "array", "x-go-name": "VolatilityMeasures", "x-order": 10 }, "valuation_metrics": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldSummary": { "description": "A brief summary of a mutual fund", "properties": { "symbol": { "description": "All available fund types segmented by country", "examples": [ "0P0001LCQ3" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "JNL Small Cap Index Fund (I)" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "Jackson National" ], "type": "string", "x-go-name": "FundFamily", "x-order": 30 }, "fund_type": { "description": "Type of the fund", "examples": [ "Small Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 40 }, "currency": { "description": "Currency of fund price", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "share_class_inception_date": { "description": "The date from which the fund started operations and the returns are calculated", "examples": [ "2021-04-26" ], "type": "string", "x-go-name": "ShareClassInceptionDate", "x-order": 60 }, "ytd_return": { "description": "Percentage of profit of the fund since the first trading day of the current calendar year", "examples": [ -0.02986 ], "format": "double", "type": "number", "x-go-name": "YtdReturn", "x-order": 70 }, "expense_ratio_net": { "description": "Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees", "examples": [ 0.001 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet", "x-order": 80 }, "yield": { "description": "Income returned to its investors through interest and dividends generated by the fund's investments", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Yield", "x-order": 90 }, "nav": { "description": "Net Asset Value: fund value minus liabilities", "examples": [ 10.09 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 100 }, "min_investment": { "description": "Investment minimum", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "MinInvestment", "x-order": 110 }, "turnover_rate": { "description": "Percentage rate at which mutual fund replaces its holdings on investment every year", "examples": [ 0.32 ], "format": "double", "type": "number", "x-go-name": "TurnoverRate", "x-order": 120 }, "net_assets": { "description": "Total assets of a fund minus its total liabilities", "examples": [ 2400762112 ], "format": "int64", "type": "integer", "x-go-name": "NetAssets", "x-order": 130 }, "overview": { "description": "Description of the fund", "examples": [ "The fund invests, normally, at least 80% of its assets in the stocks..." ], "type": "string", "x-go-name": "Overview", "x-order": 140 }, "people": { "description": "Information about the fund’s managers", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner" }, "type": "array", "x-go-name": "People", "x-order": 150 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseMutualFundWorldSustainability": { "description": "Sustainability score and ESG (Environmental, Social, Governance) metrics for the fund", "properties": { "score": { "description": "Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from `0` to `100`", "examples": [ 22 ], "format": "int64", "type": "integer", "x-go-name": "Score", "x-order": 10 }, "corporate_esg_pillars": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars" }, "sustainable_investment": { "description": "Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes", "examples": [ false ], "type": "boolean", "x-go-name": "SustainableInvestment", "x-order": 30 }, "corporate_aum": { "description": "Percentage of AUM used to calculate sustainability score", "examples": [ 0.99486 ], "format": "double", "type": "number", "x-go-name": "CorporateAum", "x-order": 40 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "ResponseSanctionItem": { "properties": { "source": { "description": "The sanction source", "examples": [ "ofac" ], "type": "string", "x-go-name": "Source", "x-order": 10 }, "program": { "description": "The sanction program", "examples": [ "RUSSIA-EO14024" ], "type": "string", "x-go-name": "Program", "x-order": 20 }, "notes": { "description": "Notes for the sanction", "examples": [ "Block" ], "type": "string", "x-go-name": "Notes", "x-order": 30 }, "lists": { "description": "Sanction lists", "items": { "$ref": "#/components/schemas/ResponseSanctionItemList" }, "type": "array", "x-go-name": "Lists", "x-order": 40 } }, "required": [ "lists", "notes", "program", "source" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ResponseSanctionItemList": { "properties": { "name": { "description": "The sanction list name", "examples": [ "SDN List" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "published_at": { "description": "The sanction published date in the current sanctions list", "examples": [ "2024-10-30" ], "type": "string", "x-go-name": "PublishedAt", "x-order": 20 } }, "required": [ "name" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "ResponseSanctionedEntitiy": { "properties": { "symbol": { "description": "The instrument symbol ticker", "examples": [ "LOKESHMACH" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "The instrument name", "examples": [ "Lokesh Machines Ltd." ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "NSE" ], "type": "string", "x-go-name": "MicCode", "x-order": 30 }, "country": { "description": "Country name", "examples": [ "India" ], "type": "string", "x-go-name": "Country", "x-order": 40 }, "sanction": { "$ref": "#/components/schemas/ResponseSanctionItem" } }, "required": [ "country", "mic_code", "name", "sanction", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "SplitsCalendarResponseItem": { "description": "List of stock splits", "properties": { "date": { "description": "Stands for the split date", "examples": [ "1987-06-16" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "symbol": { "description": "Ticker of the company", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 20 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 30 }, "exchange": { "description": "Exchange name where the company is listed", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "description": { "description": "Specification of the split event", "examples": [ "2-for-1 split" ], "type": "string", "x-go-name": "Description", "x-order": 50 }, "ratio": { "description": "The ratio by which the number of a company's outstanding shares of stock are increased following a stock split. For example, a `4-for-1 split` results in four times as many outstanding shares, with each share selling at one forth of its pre-split price", "examples": [ 0.5 ], "format": "double", "type": "number", "x-go-name": "Ratio", "x-order": 60 }, "from_factor": { "description": "From factor of the split", "examples": [ 2 ], "format": "double", "type": "number", "x-go-name": "FromFactor", "x-order": 70 }, "to_factor": { "description": "To factor of the split", "examples": [ 1 ], "format": "double", "type": "number", "x-go-name": "ToFactor", "x-order": 80 } }, "required": [ "date", "description", "from_factor", "ratio", "to_factor" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/model/repository" }, "StockExchange": { "description": "Stock info", "properties": { "country": { "type": "string", "x-go-name": "Country" }, "name": { "type": "string", "x-go-name": "Name" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/core-go/model/entity" }, "StocksResponseItem": { "description": "StocksResponseItem represents details of a stock instrument", "properties": { "symbol": { "description": "Instrument symbol (ticker)", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "ExchangeCode", "x-order": 50 }, "country": { "description": "Country where exchange is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 60 }, "type": { "description": "Common issue type", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 70 }, "figi_code": { "description": "Financial instrument global identifier (FIGI)", "examples": [ "BBG000B9Y5X2" ], "type": "string", "x-go-name": "FigiCode", "x-order": 80 }, "cfi_code": { "description": "Classification of Financial Instruments (CFI)", "examples": [ "ESVUFR" ], "type": "string", "x-go-name": "CfiCode", "x-order": 90 }, "isin": { "description": "International securities identification number (ISIN), available by individual request to support", "examples": [ "US0378331005" ], "type": "string", "x-go-name": "Isin", "x-order": 100 }, "cusip": { "description": "A unique nine-character alphanumeric code used to identify financial securities, ensuring accurate data retrieval for the specified asset", "examples": [ "037833100" ], "type": "string", "x-go-name": "Cusip", "x-order": 110 }, "access": { "$ref": "#/components/schemas/EtfResponseItem_access" } }, "required": [ "cfi_code", "country", "currency", "cusip", "exchange", "figi_code", "isin", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "SymbolSearchResponseItem": { "description": "SymbolSearchResponseItem represents details of a symbol search result", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AA" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "instrument_name": { "description": "Name of exchange", "examples": [ "Alcoa Corp" ], "type": "string", "x-go-name": "InstrumentName", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNYS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "exchange_timezone": { "description": "Time zone where exchange is located", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 50 }, "instrument_type": { "description": "Type of instrument", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "InstrumentType", "x-order": 60 }, "country": { "description": "Country to which stock exchange belongs to", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 70 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 80 }, "access": { "$ref": "#/components/schemas/SymbolSearchResponseItemAccess" } }, "required": [ "country", "currency", "exchange", "exchange_timezone", "instrument_name", "instrument_type", "mic_code", "symbol" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "SymbolSearchResponseItemAccess": { "description": "Info on which plan symbol is available (displayed then `show_plan` is `true`)", "properties": { "global": { "description": "Level of access to the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Global" }, "plan": { "description": "The individual plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Plan" }, "plan_business": { "description": "The business plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "PlanBusiness" } }, "required": [ "global", "plan", "plan_business" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TechnicalIndicatorsResponseMacdOutputValue": { "description": "Output parameter name. Example values: ad, add, adxr, aroonosc, macd, macd_signal, macd_hist, etc", "properties": { "default_color": { "description": "Suggested color for displaying returns hex color code", "examples": [ "#FF0000" ], "type": "string", "x-go-name": "DefaultColor", "x-order": 10 }, "display": { "description": "How output value should be rendered", "enum": [ "line", "histogram", "candle", "points" ], "examples": [ "line" ], "type": "string", "x-go-name": "Display", "x-order": 20 }, "min_range": { "description": "If output value has minimum bound", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "MinRange", "x-order": 30 }, "max_range": { "description": "If output value has maximum bound", "examples": [ 5 ], "format": "int64", "type": "integer", "x-go-name": "MaxRange", "x-order": 40 } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TechnicalIndicatorsResponseMacdOutputValues": { "description": "An array of output values", "properties": { "parameter_name": { "$ref": "#/components/schemas/TechnicalIndicatorsResponseMacdOutputValue" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TechnicalIndicatorsResponseMacdParameter": { "description": "Input parameter name. Example values: series_type, fast_period, slow_period, time_period, signal_period", "properties": { "default": { "description": "Specifies parameter value set by default", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "Default" }, "max_range": { "description": "If the parameter has upper bound in order to ensure correct calculation", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "MaxRange" }, "min_range": { "description": "If the parameter has lower bound in order to ensure correct calculation", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "MinRange" }, "range": { "description": "An array of available parameter values", "examples": [ [ "open", "high", "low", "close" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Range" }, "type": { "description": "Type of parameter might be string, int, float or array", "examples": [ "int" ], "type": "string", "x-go-name": "Type" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TechnicalIndicatorsResponseMacdParameters": { "description": "An array of input parameters for the indicator", "properties": { "parameter_name": { "$ref": "#/components/schemas/TechnicalIndicatorsResponseMacdParameter" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TechnicalIndicatorsResponseMacdTinting": { "description": "An array of tinting values used for proper indicator coloring", "properties": { "display": { "description": "How the tinting should be rendered", "examples": [ "fill" ], "type": "string", "x-go-name": "Display", "x-order": 10 }, "color": { "description": "Hex color code for the tinting", "examples": [ "#FF0000" ], "type": "string", "x-go-name": "Color", "x-order": 20 }, "transparency": { "description": "Transparency level, float value from 0 to 1", "examples": [ 0.5 ], "format": "double", "type": "number", "x-go-name": "Transparency", "x-order": 30 }, "lower_bound": { "description": "Lower bound of tinting, can be a number or a return parameter name", "examples": [ "0" ], "type": "object", "x-go-name": "LowerBound" }, "upper_bound": { "description": "Upper bound of tinting, can be a number or a return parameter name", "examples": [ "macd" ], "type": "object", "x-go-name": "UpperBound" } }, "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TimeSeriesCrossItem": { "description": "TimeSeriesCrossItem represents a single data point in the time series", "properties": { "datetime": { "description": "Datetime at local exchange time referring to when the bar with specified interval was opened", "examples": [ "2025-02-28 14:30:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "open": { "description": "Price at the opening of the current bar", "examples": [ "0.0000081115665" ], "type": "string", "x-go-name": "Open", "x-order": 20 }, "high": { "description": "Highest price which occurred during the current bar", "examples": [ "0.0000081273069" ], "type": "string", "x-go-name": "High", "x-order": 30 }, "low": { "description": "Lowest price which occurred during the current bar", "examples": [ "0.0000081088287" ], "type": "string", "x-go-name": "Low", "x-order": 40 }, "close": { "description": "Close price at the end of the bar", "examples": [ "0.0000081268066" ], "type": "string", "x-go-name": "Close", "x-order": 50 } }, "required": [ "close", "datetime", "high", "low", "open" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "TimeSeriesItem": { "properties": { "datetime": { "description": "Datetime at local exchange time referring to when the bar with specified interval was opened.", "examples": [ "2021-09-16 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "open": { "description": "Price at the opening of current bar", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 20 }, "high": { "description": "Highest price which occurred during the current bar.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 30 }, "low": { "description": "Lowest price which occurred during the current bar.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 40 }, "close": { "description": "Close price at the end of the bar.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 50 }, "volume": { "description": "Trading volume which occurred during the current bar", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 60 } }, "required": [ "close", "datetime", "high", "low", "open" ], "type": "object", "x-go-package": "gitlab.atlasgroup.ai/twelvedata/api/route/description" }, "GetTimeSeriesAd_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "AD - Chaikin A/D Line" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAd_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAd_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAd_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ad": { "description": "AD value", "examples": [ "2262629.83773" ], "type": "string", "x-go-name": "Ad", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "ad", "datetime" ], "type": "object" }, "GetTimeSeriesAd_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAd_200_response_meta" }, "values": { "items": { "$ref": "#/components/schemas/GetTimeSeriesAd_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAdd_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ADD - Arithmetic Addition" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "Price type used as the first part of technical indicator", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Price type used as the second part of technical indicator", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 } }, "required": [ "name", "series_type_1", "series_type_2" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAdd_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAdd_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAdd_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "add": { "description": "Add value", "examples": [ "402.10798" ], "type": "string", "x-go-name": "Add", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "add", "datetime" ], "type": "object" }, "GetTimeSeriesAdd_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAdd_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAdd_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAdOsc_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ADOSC - Chaikin A/D Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "fast_period": { "description": "Number of periods for fast moving average", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 20 }, "slow_period": { "description": "Number of periods for slow moving average", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 30 } }, "required": [ "fast_period", "name", "slow_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAdOsc_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAdOsc_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAdOsc_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "adosc": { "description": "Adosc value", "examples": [ "-233315.15185" ], "type": "string", "x-go-name": "AdOsc", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "adosc", "datetime" ], "type": "object" }, "GetTimeSeriesAdOsc_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAdOsc_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAdOsc_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAdx_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ADX - Average Directional Index" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAdx_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAdx_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAdx_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "adx": { "description": "ADX value", "examples": [ "49.22897" ], "type": "string", "x-go-name": "Adx", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "adx", "datetime" ], "type": "object" }, "GetTimeSeriesAdx_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAdx_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAdx_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAdxr_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ADXR - Average Directional Movement Index Rating" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAdxr_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAdxr_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAdxr_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "adxr": { "description": "Adxr value", "examples": [ "37.43665" ], "type": "string", "x-go-name": "Adxr", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "adxr", "datetime" ], "type": "object" }, "GetTimeSeriesAdxr_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAdxr_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAdxr_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetAnalystRatingsLight_200_response_meta": { "description": "Meta information about the instrument", "properties": { "symbol": { "description": "Symbol ticker of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 40 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the instrument", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetAnalystRatingsLight_200_response_ratings_inner": { "properties": { "date": { "description": "Date when the rating was released", "examples": [ "2022-08-19" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "firm": { "description": "Firm that issued the ranking", "examples": [ "Keybanc" ], "type": "string", "x-go-name": "Firm", "x-order": 20 }, "rating_change": { "description": "Defines the action of the firm to ranking, could be `Maintains`, `Upgrade`, `Downgrade`, `Initiates` or `Reiterates`", "examples": [ "Maintains" ], "type": "string", "x-go-name": "RatingChange", "x-order": 30 }, "rating_current": { "description": "Current firm's ranking of the instrument", "examples": [ "Overweight" ], "type": "string", "x-go-name": "RatingCurrent", "x-order": 40 }, "rating_prior": { "description": "Prior firm's ranking of the instrument", "examples": [ "Overweight" ], "type": "string", "x-go-name": "RatingPrior", "x-order": 50 } }, "required": [ "date", "firm" ], "type": "object" }, "GetAnalystRatingsLight_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetAnalystRatingsLight_200_response_meta" }, "ratings": { "description": "List of analyst ratings", "items": { "$ref": "#/components/schemas/GetAnalystRatingsLight_200_response_ratings_inner" }, "type": "array", "x-go-name": "Ratings", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status" ], "type": "object" }, "GetAnalystRatingsUsEquities_200_response_ratings_inner": { "properties": { "date": { "description": "Date when the rating was released", "examples": [ "2022-08-19" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "firm": { "description": "Firm that issued the ranking", "examples": [ "Keybanc" ], "type": "string", "x-go-name": "Firm", "x-order": 20 }, "analyst_name": { "description": "Name of an analyst", "examples": [ "Brandon Nispel" ], "type": "string", "x-go-name": "AnalystName", "x-order": 30 }, "rating_change": { "description": "Defines the action of the firm to ranking, could be `Maintains`, `Upgrade`, `Downgrade`, `Initiates`, `Reiterates`, `Assumes`, or `Reinstates`", "examples": [ "Maintains" ], "type": "string", "x-go-name": "RatingChange", "x-order": 40 }, "rating_current": { "description": "Current firm's ranking of the instrument", "examples": [ "Overweight" ], "type": "string", "x-go-name": "RatingCurrent", "x-order": 50 }, "rating_prior": { "description": "Prior firm's ranking of the instrument", "examples": [ "Overweight" ], "type": "string", "x-go-name": "RatingPrior", "x-order": 60 }, "time": { "description": "Time when the rating was released or updated", "examples": [ "08:29:48" ], "type": "string", "x-go-name": "Time", "x-order": 70 }, "action_price_target": { "description": "Action that firm took towards target price", "examples": [ "Raises" ], "type": "string", "x-go-name": "ActionPriceTarget", "x-order": 80 }, "price_target_current": { "description": "Current firm's price target for the instrument", "examples": [ 185.14 ], "format": "double", "type": "number", "x-go-name": "PriceTargetCurrent", "x-order": 90 }, "price_target_prior": { "description": "Prior firm's price target for the instrument", "examples": [ 177.01 ], "format": "double", "type": "number", "x-go-name": "PriceTargetPrior", "x-order": 100 } }, "required": [ "date", "firm" ], "type": "object" }, "GetAnalystRatingsUsEquities_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetAnalystRatingsLight_200_response_meta" }, "ratings": { "description": "List of analyst ratings", "items": { "$ref": "#/components/schemas/GetAnalystRatingsUsEquities_200_response_ratings_inner" }, "type": "array", "x-go-name": "Ratings", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status" ], "type": "object" }, "GetApiUsage_200_response": { "properties": { "timestamp": { "description": "Current timestamp in UTC timezone", "examples": [ "2025-05-07 11:10:12" ], "type": "string", "x-go-name": "Timestamp", "x-order": 10 }, "current_usage": { "description": "Number of requests made in last minute", "examples": [ 4003 ], "format": "int64", "type": "integer", "x-go-name": "CurrentUsage", "x-order": 20 }, "plan_limit": { "description": "Your personal API limit (requests/minute) depending on the plan", "examples": [ 20000 ], "format": "int64", "type": "integer", "x-go-name": "PlanLimit", "x-order": 30 }, "daily_usage": { "description": "Number of requests made in the current day. Returned only when the plan has a daily limit.", "examples": [ 12500 ], "format": "int64", "type": "integer", "x-go-name": "DailyUsage", "x-order": 35 }, "plan_daily_limit": { "description": "Your personal API limit (requests/day) depending on the plan. Returned only when the plan has a daily limit.", "examples": [ 100000 ], "format": "int64", "type": "integer", "x-go-name": "PlanDailyLimit", "x-order": 36 }, "plan_category": { "description": "Plan category name", "examples": [ "enterprise" ], "type": "string", "x-go-name": "PlanCategory", "x-order": 40 } }, "required": [ "current_usage", "plan_limit", "timestamp" ], "type": "object" }, "GetTimeSeriesApo_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "APO - Absolute Price Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "fast_period": { "description": "Number of periods for fast moving average", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 30 }, "slow_period": { "description": "Number of periods for slow moving average", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 40 }, "ma_type": { "description": "Type of moving average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 50 } }, "required": [ "fast_period", "ma_type", "name", "series_type", "slow_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesApo_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesApo_200_response_meta_indicator" } } } ] }, "GetTimeSeriesApo_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "apo": { "description": "APO value", "examples": [ "-0.54508" ], "type": "string", "x-go-name": "Apo", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "apo", "datetime" ], "type": "object" }, "GetTimeSeriesApo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesApo_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesApo_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAroon_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "AROON - Aroon Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAroon_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAroon_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAroon_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "aroon_down": { "description": "Aroon down value", "examples": [ "92.85714" ], "type": "string", "x-go-name": "AroonDown", "x-order": 20 }, "aroon_up": { "description": "Aroon up value", "examples": [ "0.0" ], "type": "string", "x-go-name": "AroonUp", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "aroon_down", "aroon_up", "datetime" ], "type": "object" }, "GetTimeSeriesAroon_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAroon_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAroon_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAroonOsc_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "AROONOSC - Aroon Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAroonOsc_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAroonOsc_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAroonOsc_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "aroonosc": { "description": "Aroon oscillator value", "examples": [ "-92.85714" ], "type": "string", "x-go-name": "AroonOsc", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "aroonosc", "datetime" ], "type": "object" }, "GetTimeSeriesAroonOsc_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAroonOsc_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAroonOsc_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAtr_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ATR - Average True Range" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAtr_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAtr_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAtr_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "atr": { "description": "ATR value", "examples": [ "0.19828" ], "type": "string", "x-go-name": "Atr", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "atr", "datetime" ], "type": "object" }, "GetTimeSeriesAtr_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAtr_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAtr_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAvg_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "AVG - Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAvg_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAvg_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAvg_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "avg": { "description": "Avg value", "examples": [ "201.53871" ], "type": "string", "x-go-name": "Avg", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "avg", "datetime" ], "type": "object" }, "GetTimeSeriesAvg_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAvg_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAvg_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesAvgPrice_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "AVGPRICE - Average Price" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesAvgPrice_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesAvgPrice_200_response_meta_indicator" } } } ] }, "GetTimeSeriesAvgPrice_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "avgprice": { "description": "Avgprice value", "examples": [ "201.02449" ], "type": "string", "x-go-name": "AvgPrice", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "avgprice", "datetime" ], "type": "object" }, "GetTimeSeriesAvgPrice_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesAvgPrice_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesAvgPrice_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetBalanceSheet_200_response_meta": { "description": "Metadata about the balance sheet", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the balance sheet according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Exchange timezone", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 }, "period": { "description": "Values can be annual or quarterly", "examples": [ "Quarterly" ], "type": "string", "x-go-name": "Period", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "period", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetBalanceSheet_200_response_balance_sheet_inner_assets_current_assets": { "description": "Current assets section", "properties": { "cash": { "description": "Cash includes currency, bank accounts, and undeposited checks", "examples": [ 17305000000 ], "format": "double", "type": "number", "x-go-name": "Cash", "x-order": 10 }, "cash_equivalents": { "description": "Represents cash equivalents that have high credit quality and are highly liquid", "examples": [ 17635000000 ], "format": "double", "type": "number", "x-go-name": "CashEquivalents", "x-order": 20 }, "cash_and_cash_equivalents": { "description": "Combined value of cash and cash equivalents when company doesn't report a breakdown", "examples": [ 34940000000 ], "format": "double", "type": "number", "x-go-name": "CashAndCashEquivalents", "x-order": 30 }, "other_short_term_investments": { "description": "Represents other short term investments", "examples": [ 27699000000 ], "format": "double", "type": "number", "x-go-name": "OtherShortTermInvestments", "x-order": 40 }, "accounts_receivable": { "description": "Represents the balance of money due to a firm for goods or services delivered or used but not yet paid for by customers", "examples": [ 26278000000 ], "format": "double", "type": "number", "x-go-name": "AccountsReceivable", "x-order": 50 }, "other_receivables": { "description": "Represents other receivables", "examples": [ 25228000000 ], "format": "double", "type": "number", "x-go-name": "OtherReceivables", "x-order": 60 }, "inventory": { "description": "Represents the goods available for sale and raw materials used to produce goods available for sale", "examples": [ 6580000000 ], "format": "double", "type": "number", "x-go-name": "Inventory", "x-order": 70 }, "prepaid_assets": { "description": "Represents expense that has already been paid for, but which has not yet been consumed", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "PrepaidAssets", "x-order": 80 }, "restricted_cash": { "description": "Represents money that is held for a specific purpose and thus not available to the company for immediate or general business use", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "RestrictedCash", "x-order": 90 }, "assets_held_for_sale": { "description": "Represents assets which company plans to sell", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "AssetsHeldForSale", "x-order": 100 }, "hedging_assets": { "description": "Represents money that is spent on hedging assets", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "HedgingAssets", "x-order": 110 }, "other_current_assets": { "description": "Represents other current assets", "examples": [ 14111000000 ], "format": "double", "type": "number", "x-go-name": "OtherCurrentAssets", "x-order": 120 }, "total_current_assets": { "description": "All current assets values in a total", "examples": [ 134836000000 ], "format": "double", "type": "number", "x-go-name": "TotalCurrentAssets", "x-order": 130 } }, "type": "object", "x-go-name": "CurrentAssets", "x-order": 10 }, "GetBalanceSheet_200_response_balance_sheet_inner_assets_non_current_assets": { "description": "Non-current assets section", "properties": { "properties": { "description": "Represents property owned", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Properties", "x-order": 10 }, "land_and_improvements": { "description": "Represents land and improvements owned", "examples": [ 20041000000 ], "format": "double", "type": "number", "x-go-name": "LandAndImprovements", "x-order": 20 }, "machinery_furniture_equipment": { "description": "Represents office equipment, furniture, and vehicles owned", "examples": [ 78659000000 ], "format": "double", "type": "number", "x-go-name": "MachineryFurnitureEquipment", "x-order": 30 }, "construction_in_progress": { "description": "Represents the cost of construction work, which is not yet completed", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "ConstructionInProgress", "x-order": 40 }, "leases": { "description": "Represents operating and financial leases", "examples": [ 11023000000 ], "format": "double", "type": "number", "x-go-name": "Leases", "x-order": 50 }, "accumulated_depreciation": { "description": "Represents the cumulative depreciation of an asset that has been recorded", "examples": [ -70283000000 ], "format": "double", "type": "number", "x-go-name": "AccumulatedDepreciation", "x-order": 60 }, "goodwill": { "description": "Represents the value of a brand name, solid customer base, good customer relations, good employee relations, and proprietary technology", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Goodwill", "x-order": 70 }, "investment_properties": { "description": "Represents real estate property purchased with the intention of earning a return on the investment", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "InvestmentProperties", "x-order": 80 }, "financial_assets": { "description": "Represents liquid asset that gets its value from a contractual right or ownership claim", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "FinancialAssets", "x-order": 90 }, "intangible_assets": { "description": "Represents the patents, trademarks, and other intellectual properties", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "IntangibleAssets", "x-order": 100 }, "investments_and_advances": { "description": "Represents available for sale financial securities", "examples": [ 127877000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsAndAdvances", "x-order": 110 }, "other_non_current_assets": { "description": "Represents other long-term assets", "examples": [ 48849000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCurrentAssets", "x-order": 120 }, "total_non_current_assets": { "description": "All long-term assets values in total", "examples": [ 216166000000 ], "format": "double", "type": "number", "x-go-name": "TotalNonCurrentAssets", "x-order": 130 } }, "type": "object", "x-go-name": "NonCurrentAssets", "x-order": 20 }, "GetBalanceSheet_200_response_balance_sheet_inner_assets": { "description": "Assets section of the balance sheet", "properties": { "current_assets": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_assets_current_assets" }, "non_current_assets": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_assets_non_current_assets" }, "total_assets": { "description": "The sum of total_current_assets + total_non_current_assets", "examples": [ 351002000000 ], "format": "double", "type": "number", "x-go-name": "TotalAssets", "x-order": 30 } }, "type": "object", "x-go-name": "Assets", "x-order": 20 }, "GetBalanceSheet_200_response_balance_sheet_inner_liabilities_current_liabilities": { "description": "Current liabilities section", "properties": { "accounts_payable": { "description": "Refers to an account within the general ledger that represents an obligation to pay off a short-term debt to creditors or suppliers", "examples": [ 54763000000 ], "format": "double", "type": "number", "x-go-name": "AccountsPayable", "x-order": 10 }, "accrued_expenses": { "description": "Represents payments that a company is obligated to pay in the future for which goods and services have already been delivered", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "AccruedExpenses", "x-order": 20 }, "short_term_debt": { "description": "Represents current debt and capital lease obligations", "examples": [ 15613000000 ], "format": "double", "type": "number", "x-go-name": "ShortTermDebt", "x-order": 30 }, "deferred_revenue": { "description": "Represents advance payments a company receives for products or services that are to be delivered or performed in the future", "examples": [ 7612000000 ], "format": "double", "type": "number", "x-go-name": "DeferredRevenue", "x-order": 40 }, "tax_payable": { "description": "Represents taxes due to the government within one year", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "TaxPayable", "x-order": 50 }, "pensions": { "description": "Represents to pensions to be paid out", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Pensions", "x-order": 60 }, "other_current_liabilities": { "description": "Represents other current liabilities", "examples": [ 47493000000 ], "format": "double", "type": "number", "x-go-name": "OtherCurrentLiabilities", "x-order": 70 }, "total_current_liabilities": { "description": "Represents total current liabilities", "examples": [ 125481000000 ], "format": "double", "type": "number", "x-go-name": "TotalCurrentLiabilities", "x-order": 80 } }, "type": "object", "x-go-name": "CurrentLiabilities", "x-order": 10 }, "GetBalanceSheet_200_response_balance_sheet_inner_liabilities_non_current_liabilities": { "description": "Non-current liabilities section", "properties": { "long_term_provisions": { "description": "Represents money set aside for employee benefits such as gratuity", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "LongTermProvisions", "x-order": 10 }, "long_term_debt": { "description": "Represents amount of outstanding debt that has a maturity of 12 months or longer", "examples": [ 109106000000 ], "format": "double", "type": "number", "x-go-name": "LongTermDebt", "x-order": 20 }, "provision_for_risks_and_charges": { "description": "Represents funds set aside as assets to pay for anticipated future losses", "examples": [ 24689000000 ], "format": "double", "type": "number", "x-go-name": "ProvisionForRisksAndCharges", "x-order": 30 }, "deferred_liabilities": { "description": "Represents revenue producing activity for which revenue has not yet been recognized, and is not expected to be recognized in the next 12 months", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "DeferredLiabilities", "x-order": 40 }, "derivative_product_liabilities": { "description": "Represents the value of derivative financial instruments that a company has issued", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "DerivativeProductLiabilities", "x-order": 50 }, "other_non_current_liabilities": { "description": "Represents other non-current liabilities", "examples": [ 28636000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCurrentLiabilities", "x-order": 60 }, "total_non_current_liabilities": { "description": "Represents total non-current liabilities", "examples": [ 162431000000 ], "format": "double", "type": "number", "x-go-name": "TotalNonCurrentLiabilities", "x-order": 70 } }, "type": "object", "x-go-name": "NonCurrentLiabilities", "x-order": 20 }, "GetBalanceSheet_200_response_balance_sheet_inner_liabilities": { "description": "Liabilities section of the balance sheet", "properties": { "current_liabilities": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_liabilities_current_liabilities" }, "non_current_liabilities": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_liabilities_non_current_liabilities" }, "total_liabilities": { "description": "The sum of total_current_liabilities + total_non_current_liabilities", "examples": [ 287912000000 ], "format": "double", "type": "number", "x-go-name": "TotalLiabilities", "x-order": 30 } }, "type": "object", "x-go-name": "Liabilities", "x-order": 30 }, "GetBalanceSheet_200_response_balance_sheet_inner_shareholders_equity": { "description": "Shareholders' equity section of the balance sheet", "properties": { "common_stock": { "description": "Represents net worth of investors shares, which is equal to the total_assets - total_liabilities", "examples": [ 57365000000 ], "format": "double", "type": "number", "x-go-name": "CommonStock", "x-order": 10 }, "retained_earnings": { "description": "Refers to the profits earned minus dividends paid", "examples": [ 5562000000 ], "format": "double", "type": "number", "x-go-name": "RetainedEarnings", "x-order": 20 }, "other_shareholders_equity": { "description": "Represents other not affecting retained earnings gains and looses", "examples": [ 163000000 ], "format": "double", "type": "number", "x-go-name": "OtherShareholdersEquity", "x-order": 30 }, "total_shareholders_equity": { "description": "Represents the net worth of a company, which is the amount that would be returned to shareholders if a company's total assets were liquidated, and all of its debts were repaid", "examples": [ 63090000000 ], "format": "double", "type": "number", "x-go-name": "TotalShareholdersEquity", "x-order": 40 }, "additional_paid_in_capital": { "description": "Represents the additional paid-in capital, which is the amount shareholders have invested in a company above the par value of its stock", "format": "double", "type": "number", "x-go-name": "AdditionalPaidInCapital", "x-order": 50 }, "treasury_stock": { "description": "Represents the value of shares that have been repurchased by the company and are held in its treasury", "format": "double", "type": "number", "x-go-name": "TreasuryStock", "x-order": 60 }, "minority_interest": { "description": "Represents the portion of shareholders' equity that is attributable to minority shareholders in a subsidiary company", "format": "double", "type": "number", "x-go-name": "MinorityInterest", "x-order": 70 } }, "type": "object", "x-go-name": "ShareholdersEquity", "x-order": 40 }, "GetBalanceSheet_200_response_balance_sheet_inner": { "properties": { "fiscal_date": { "description": "Date of fiscal period ending", "examples": [ "2021-09-30" ], "type": "string", "x-go-name": "FiscalDate", "x-order": 10 }, "year": { "description": "Fiscal year", "examples": [ 2022 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 15 }, "assets": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_assets" }, "liabilities": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_liabilities" }, "shareholders_equity": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner_shareholders_equity" } }, "required": [ "fiscal_date" ], "type": "object" }, "GetBalanceSheet_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_meta" }, "balance_sheet": { "description": "Array of balance sheet records", "items": { "$ref": "#/components/schemas/GetBalanceSheet_200_response_balance_sheet_inner" }, "type": "array", "x-go-name": "BalanceSheet", "x-order": 20 } }, "required": [ "balance_sheet", "meta" ], "type": "object" }, "GetBalanceSheetConsolidated_200_response": { "properties": { "balance_sheet": { "description": "Balance sheet data", "items": { "$ref": "#/components/schemas/BalanceSheetConsolidatedItem" }, "type": "array", "x-go-name": "BalanceSheet", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "balance_sheet" ], "type": "object" }, "advanced_request_value": { "properties": { "url": { "description": "Requested url", "examples": [ "/time_series?symbol=AAPL&interval=1min&apikey=demo&outputsize=2" ], "type": "string", "x-go-name": "Url" } }, "type": "object" }, "advanced_200_response": { "properties": { "code": { "description": "HTTP status code", "examples": [ 200 ], "format": "int64", "type": "integer", "x-go-name": "Code", "x-order": 10 }, "status": { "description": "Status of the request", "examples": [ "success" ], "type": "string", "x-go-name": "Status", "x-order": 20 }, "data": { "additionalProperties": { "properties": {}, "type": "object" }, "description": "Response data containing individual request results", "examples": [ { "req_1": { "response": { "meta": { "currency": "USD", "exchange": "NASDAQ", "exchange_timezone": "America/New_York", "interval": "1min", "mic_code": "XNGS", "symbol": "AAPL", "type": "Common Stock" }, "status": "ok", "values": [ { "close": "248.6", "datetime": "2025-02-21 12:51:00", "high": "248.6", "low": "248.4", "open": "248.5", "volume": "22290" }, { "close": "248.52", "datetime": "2025-02-21 12:50:00", "high": "248.59", "low": "248.43", "open": "248.52", "volume": "64085" } ] }, "status": "success" }, "req_2": { "response": { "rate": 149.25999, "symbol": "USD/JPY", "timestamp": 1740160260 }, "status": "success" }, "req_3": { "response": { "amount": 18209.71933, "rate": 149.25999, "symbol": "USD/JPY", "timestamp": 1740160260 }, "status": "success" } } ], "type": "object", "x-go-name": "Data", "x-order": 30 } }, "type": "object" }, "GetTimeSeriesBBands_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "BBANDS - Bollinger Bands®" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "sd": { "description": "Number of standard deviations", "examples": [ 2 ], "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": 40 }, "ma_type": { "description": "Moving average type", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 50 } }, "required": [ "ma_type", "name", "sd", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesBBands_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesBBands_200_response_meta_indicator" } } } ] }, "GetTimeSeriesBBands_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "upper_band": { "description": "Upper band value", "examples": [ "203.36511" ], "type": "string", "x-go-name": "UpperBand", "x-order": 20 }, "middle_band": { "description": "Middle band value", "examples": [ "202.04999" ], "type": "string", "x-go-name": "MiddleBand", "x-order": 30 }, "lower_band": { "description": "Lower band value", "examples": [ "200.73486" ], "type": "string", "x-go-name": "LowerBand", "x-order": 40 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "lower_band", "middle_band", "upper_band" ], "type": "object" }, "GetTimeSeriesBBands_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesBBands_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesBBands_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesBeta_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "BETA - Beta" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "Price type used as the first part of technical indicator", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Price type used as the second part of technical indicator", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 40 } }, "required": [ "name", "series_type_1", "series_type_2", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesBeta_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesBeta_200_response_meta_indicator" } } } ] }, "GetTimeSeriesBeta_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "beta": { "description": "Beta value", "examples": [ "-0.05742" ], "type": "string", "x-go-name": "Beta", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "beta", "datetime" ], "type": "object" }, "GetTimeSeriesBeta_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesBeta_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesBeta_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetBonds_200_response_result": { "properties": { "count": { "description": "Total number of matching instruments", "examples": [ 6 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "list": { "description": "List of bonds", "items": { "$ref": "#/components/schemas/BondResponseItem" }, "type": "array", "x-go-name": "Data" } }, "required": [ "count", "list" ], "type": "object", "x-go-name": "Result" }, "GetBonds_200_response": { "properties": { "result": { "$ref": "#/components/schemas/GetBonds_200_response_result" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "result", "status" ], "type": "object" }, "GetTimeSeriesBop_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "BOP - Balance of Power" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesBop_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesBop_200_response_meta_indicator" } } } ] }, "GetTimeSeriesBop_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "bop": { "description": "Bop value", "examples": [ "0.27231" ], "type": "string", "x-go-name": "Bop", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "bop", "datetime" ], "type": "object" }, "GetTimeSeriesBop_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesBop_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesBop_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetCashFlow_200_response_meta": { "description": "Meta information about the response", "properties": { "symbol": { "description": "Symbol ticker of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the cash flow data according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Exchange timezone", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 }, "period": { "description": "Period of the cash flow data (Annual or Quarterly)", "examples": [ "Quarterly" ], "type": "string", "x-go-name": "Period", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "period", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetCashFlow_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetCashFlow_200_response_meta" }, "cash_flow": { "description": "Cash flow data", "items": { "$ref": "#/components/schemas/CashFlowStruct" }, "type": "array", "x-go-name": "CashFlow", "x-order": 20 } }, "required": [ "cash_flow", "meta" ], "type": "object" }, "GetCashFlowConsolidated_200_response": { "properties": { "cash_flow": { "description": "Cash flow data", "items": { "$ref": "#/components/schemas/CashFlowData" }, "type": "array", "x-go-name": "CashFlow", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "cash_flow" ], "type": "object" }, "GetTimeSeriesCci_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "CCI - Commodity Channel Index" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCci_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCci_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCci_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "cci": { "description": "CCI value", "examples": [ "-122.30794" ], "type": "string", "x-go-name": "Cci", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "cci", "datetime" ], "type": "object" }, "GetTimeSeriesCci_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCci_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCci_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesCeil_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "CEIL - CEIL" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCeil_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCeil_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCeil_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ceil": { "description": "Ceil value", "examples": [ "202.0" ], "type": "string", "x-go-name": "Ceil", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "ceil", "datetime" ], "type": "object" }, "GetTimeSeriesCeil_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCeil_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCeil_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesCmo_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "CMO - Chande Momentum Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCmo_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCmo_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCmo_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "cmo": { "description": "CMO value", "examples": [ "-71.24979" ], "type": "string", "x-go-name": "Cmo", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "cmo", "datetime" ], "type": "object" }, "GetTimeSeriesCmo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCmo_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCmo_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetCommodities_200_response": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of commodities", "examples": [ [ { "category": "Agricultural Product", "description": "Standardized contract to buy or sell a set quantity of corn at a future date.", "name": "Corn Futures", "symbol": "C_1" }, { "category": "Agricultural Product", "description": "Agreement to transact cocoa beans at a predetermined price and date.", "name": "Cocoa Futures", "symbol": "CC1" }, { "category": "Precious Metal", "description": "Spot price per troy ounce of gold.", "name": "Gold Spot", "symbol": "XAU/USD" } ] ], "items": { "$ref": "#/components/schemas/CommoditiesResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "GetTimeSeriesCoppock_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "COPPOCK - Coppock Curve" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "wma_period": { "description": "Number of periods for weighted moving average", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "WMAPeriod", "x-order": 30 }, "long_roc_period": { "description": "Number of periods for long term rate of change", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "LongRocPeriod", "x-order": 40 }, "short_roc_period": { "description": "Number of periods for short term rate of change", "examples": [ 11 ], "format": "int64", "type": "integer", "x-go-name": "ShortRocPeriod", "x-order": 50 } }, "required": [ "long_roc_period", "name", "series_type", "short_roc_period", "wma_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCoppock_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCoppock_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCoppock_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "coppock": { "description": "Coppock value", "examples": [ "-1.37253" ], "type": "string", "x-go-name": "Coppock", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "coppock", "datetime" ], "type": "object" }, "GetTimeSeriesCoppock_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCoppock_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCoppock_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesCorrel_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "CORREL - Pearson's Correlation Coefficient" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "Price type used as the first part of technical indicator", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Price type used as the second part of technical indicator", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 40 } }, "required": [ "name", "series_type_1", "series_type_2", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCorrel_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCorrel_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCorrel_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "correl": { "description": "Correl value", "examples": [ "0.93282" ], "type": "string", "x-go-name": "Correl", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "correl", "datetime" ], "type": "object" }, "GetTimeSeriesCorrel_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCorrel_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCorrel_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetCountries_200_response": { "properties": { "data": { "description": "List of countries with their ISO codes, names, capital, and currency", "items": { "$ref": "#/components/schemas/CountryResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 } }, "required": [ "data" ], "type": "object" }, "GetCrossListings_200_response": { "properties": { "result": { "$ref": "#/components/schemas/CrossListingsResult" } }, "type": "object" }, "GetTimeSeriesCrsi_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "CRSI - ConnorsRSI" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "rsi_period": { "description": "Number of periods for RSI used to calculate price momentum", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "RsiPeriod", "x-order": 30 }, "up_down_length": { "description": "Number of periods for RSI used to calculate up/down trend", "examples": [ 2 ], "format": "int64", "type": "integer", "x-go-name": "UpDownLength", "x-order": 40 }, "percent_rank_period": { "description": "Number of periods used to calculate PercentRank", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "PercentRankPeriod", "x-order": 50 } }, "required": [ "name", "percent_rank_period", "rsi_period", "series_type", "up_down_length" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesCrsi_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesCrsi_200_response_meta_indicator" } } } ] }, "GetTimeSeriesCrsi_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "crsi": { "description": "crsi value", "examples": [ "74.76102" ], "type": "string", "x-go-name": "Crsi", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "crsi", "datetime" ], "type": "object" }, "GetTimeSeriesCrsi_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesCrsi_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesCrsi_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetCryptocurrencies_200_response": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of cryptocurrencies", "items": { "$ref": "#/components/schemas/CryptocurrencyResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "GetCryptocurrencyExchanges_200_response": { "properties": { "data": { "description": "List of cryptocurrency exchanges", "examples": [ [ { "name": "Binance" }, { "name": "Coinbase Pro" }, { "name": "Kraken" }, { "name": "OKX" } ] ], "items": { "$ref": "#/components/schemas/CryptocurrencyExchangesResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "data", "status" ], "type": "object" }, "GetCurrencyConversion_200_response": { "properties": { "symbol": { "description": "Requested currency symbol", "examples": [ "USD/JPY" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "rate": { "description": "Real-time exchange rate for the corresponding symbol", "examples": [ 105.12 ], "format": "double", "type": "number", "x-go-name": "Rate", "x-order": 20 }, "amount": { "description": "Amount of converted currency", "examples": [ 12824.64 ], "format": "double", "type": "number", "x-go-name": "Amount", "x-order": 30 }, "timestamp": { "description": "Unix timestamp of the rate", "examples": [ 1602714051 ], "format": "int64", "type": "integer", "x-go-name": "Timestamp", "x-order": 40 } }, "required": [ "rate", "symbol", "timestamp" ], "type": "object" }, "GetTimeSeriesDema_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "DEMA - Double Exponential Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesDema_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesDema_200_response_meta_indicator" } } } ] }, "GetTimeSeriesDema_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "dema": { "description": "Dema value", "examples": [ "200.93371" ], "type": "string", "x-go-name": "Dema", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "dema" ], "type": "object" }, "GetTimeSeriesDema_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesDema_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesDema_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetDirectHolders_200_response_meta": { "description": "Meta information about the financial instrument", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "7203" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of symbol", "examples": [ "Elm Co." ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument according to the ISO 4217 standard", "examples": [ "SAR" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "Tadawul" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XSAU" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "Asia/Riyadh" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetDirectHolders_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetDirectHolders_200_response_meta" }, "direct_holders": { "description": "List of direct holders for the financial instrument", "items": { "$ref": "#/components/schemas/DirectHolderItem" }, "type": "array", "x-go-name": "DirectHolders", "x-order": 20 } }, "required": [ "direct_holders", "meta" ], "type": "object" }, "GetTimeSeriesDiv_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "DIV - Arithmetic Division" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "Price type used as the first part of technical indicator", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Price type used as the second part of technical indicator", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 } }, "required": [ "name", "series_type_1", "series_type_2" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesDiv_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesDiv_200_response_meta_indicator" } } } ] }, "GetTimeSeriesDiv_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "div": { "description": "Div value", "examples": [ "1.00201" ], "type": "string", "x-go-name": "Div", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "div" ], "type": "object" }, "GetTimeSeriesDiv_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesDiv_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesDiv_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetDividends_200_response_meta": { "description": "Json object with request general information", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of symbol", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetDividends_200_response_dividends_inner": { "properties": { "ex_date": { "description": "Stands for the ex date", "examples": [ "2021-08-06" ], "type": "string", "x-go-name": "ExDate", "x-order": 10 }, "amount": { "description": "Stands for the payment amount", "examples": [ 0.22 ], "format": "double", "type": "number", "x-go-name": "Amount", "x-order": 20 } }, "required": [ "amount", "ex_date" ], "type": "object" }, "GetDividends_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetDividends_200_response_meta" }, "dividends": { "description": "List of dividends", "items": { "$ref": "#/components/schemas/GetDividends_200_response_dividends_inner" }, "type": "array", "x-go-name": "Dividends", "x-order": 20 } }, "required": [ "dividends", "meta" ], "type": "object" }, "GetTimeSeriesDpo_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "DPO - Detrended Price Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 21 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "centered": { "description": "Specifies if there should be a shift to match the current price", "examples": [ false ], "type": "boolean", "x-go-name": "Centered", "x-order": 40 } }, "required": [ "centered", "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesDpo_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesDpo_200_response_meta_indicator" } } } ] }, "GetTimeSeriesDpo_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-04-01" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "dpo": { "description": "DPO value", "examples": [ "-7.99619" ], "type": "string", "x-go-name": "Dpo", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "dpo" ], "type": "object" }, "GetTimeSeriesDpo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesDpo_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesDpo_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesDx_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "DX - Directional Movement Index" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesDx_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesDx_200_response_meta_indicator" } } } ] }, "GetTimeSeriesDx_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "dx": { "description": "dx value", "examples": [ "68.70803" ], "type": "string", "x-go-name": "Dx", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "dx" ], "type": "object" }, "GetTimeSeriesDx_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesDx_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesDx_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetEarliestTimestamp_200_response": { "properties": { "datetime": { "description": "Earliest datetime, the format depends on interval", "examples": [ "1980-12-12" ], "type": "string", "x-go-name": "Datetime", "x-order": 50 }, "unix_time": { "description": "Datetime converted to UNIX timestamp", "examples": [ 345479400 ], "format": "int64", "type": "integer", "x-go-name": "UnixTime", "x-order": 50 } }, "required": [ "datetime", "unix_time" ], "type": "object" }, "GetEarnings_200_response_meta": { "description": "Metadata about the instrument", "properties": { "symbol": { "description": "Symbol of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetEarnings_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarnings_200_response_meta" }, "earnings": { "description": "List of earnings data", "items": { "$ref": "#/components/schemas/EarningsItem" }, "type": "array", "x-go-name": "Earnings", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "earnings", "meta", "status" ], "type": "object" }, "GetEarningsCalendar_200_response_earnings_value_inner": { "properties": { "symbol": { "description": "Instrument symbol (ticker)", "examples": [ "BR" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Full name of instrument", "examples": [ "Broadridge Financial Solutions Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which instrument is traded by ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NYSE" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNYS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "country": { "description": "Country where exchange is located", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 60 }, "time": { "description": "Can be either of the following values: `Pre Market`, `After Hours`, `Time Not Supplied`", "examples": [ "Time Not Supplied" ], "type": "string", "x-go-name": "Time", "x-order": 70 }, "eps_estimate": { "description": "Analyst estimate of the future company earning", "examples": [ 1.72 ], "format": "double", "type": "number", "x-go-name": "EpsEstimate", "x-order": 80 }, "eps_actual": { "description": "Actual value of reported earning", "examples": [ 1.67 ], "format": "double", "type": "number", "x-go-name": "EpsActual", "x-order": 90 }, "difference": { "description": "Delta between `eps_actual` and `eps_estimate`", "examples": [ -0.05 ], "format": "double", "type": "number", "x-go-name": "Difference", "x-order": 100 }, "surprise_prc": { "description": "Surprise in percentage of the `eps_actual` related to `eps_estimate`", "examples": [ -2.9 ], "format": "double", "type": "number", "x-go-name": "SurprisePrc", "x-order": 110 } }, "type": "object" }, "GetEarningsCalendar_200_response": { "properties": { "earnings": { "additionalProperties": { "items": { "$ref": "#/components/schemas/GetEarningsCalendar_200_response_earnings_value_inner" }, "type": "array" }, "description": "Map of dates to earnings data", "type": "object", "x-example-key": "2020-04-30", "x-go-name": "Earnings", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "earnings", "status" ], "type": "object" }, "GetEarningsEstimate_200_response_meta": { "description": "Meta information about the symbol", "properties": { "symbol": { "description": "Symbol ticker of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 40 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the instrument", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetEarningsEstimate_200_response_earnings_estimate_inner": { "properties": { "date": { "description": "Date of the earnings estimate", "examples": [ "2022-09-30" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "period": { "description": "Period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`", "examples": [ "current_quarter" ], "type": "string", "x-go-name": "Period", "x-order": 20 }, "number_of_analysts": { "description": "Number of analysts that made the estimation", "examples": [ 27 ], "format": "int64", "type": "integer", "x-go-name": "NumberOfAnalysts", "x-order": 30 }, "avg_estimate": { "description": "Average estimation across analysts", "examples": [ 1.26 ], "format": "double", "type": "number", "x-go-name": "AvgEstimate", "x-order": 40 }, "low_estimate": { "description": "Lowest estimation given by an analyst", "examples": [ 1.13 ], "format": "double", "type": "number", "x-go-name": "LowEstimate", "x-order": 50 }, "high_estimate": { "description": "Highest estimation given by an analyst", "examples": [ 1.35 ], "format": "double", "type": "number", "x-go-name": "HighEstimate", "x-order": 60 }, "year_ago_eps": { "description": "Average estimation of this period's earnings given a year ago", "examples": [ 1.24 ], "format": "double", "type": "number", "x-go-name": "YearAgoEPS", "x-order": 70 } }, "required": [ "date", "period" ], "type": "object" }, "GetEarningsEstimate_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_meta" }, "earnings_estimate": { "description": "List of earnings estimates", "items": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_earnings_estimate_inner" }, "type": "array", "x-go-name": "EarningsEstimate", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "earnings_estimate", "meta", "status" ], "type": "object" }, "GetEdgarFilingsArchive_200_response_meta": { "description": "Meta information about the company and listing", "properties": { "symbol": { "description": "Ticker of the company", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "exchange": { "description": "Exchange name where the company is listed", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 20 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 30 }, "type": { "description": "Issue type of the stock", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 40 } }, "required": [ "exchange", "mic_code", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetEdgarFilingsArchive_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEdgarFilingsArchive_200_response_meta" }, "values": { "description": "List of filings", "items": { "$ref": "#/components/schemas/EdgarFilingValue" }, "type": "array", "x-go-name": "Values", "x-order": 20 } }, "required": [ "meta", "values" ], "type": "object" }, "GetTimeSeriesEma_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "EMA - Exponential Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesEma_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesEma_200_response_meta_indicator" } } } ] }, "GetTimeSeriesEma_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ema": { "description": "EMA value", "examples": [ "201.38109" ], "type": "string", "x-go-name": "Ema", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ema" ], "type": "object" }, "GetTimeSeriesEma_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesEma_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesEma_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetEod_200_response": { "properties": { "symbol": { "description": "Symbol passed", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 20 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 30 }, "currency": { "description": "Currency in which instrument is denominated", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 40 }, "datetime": { "description": "Datetime in defined timezone referring to when the bar with specified interval was opened", "examples": [ "2021-09-16" ], "type": "string", "x-go-name": "Datetime", "x-order": 50 }, "close": { "description": "The most recent end of day close price", "examples": [ "148.79" ], "type": "string", "x-go-name": "Close", "x-order": 60 } }, "required": [ "close", "datetime", "exchange", "symbol" ], "type": "object" }, "GetEpsRevisions_200_response_eps_revision_inner": { "properties": { "date": { "description": "Date of the EPS estimate", "examples": [ "2022-09-30" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "period": { "description": "Period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`", "examples": [ "current_quarter" ], "type": "string", "x-go-name": "Period", "x-order": 20 }, "up_last_week": { "description": "Number of up revisions over the last 7 days", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "UpLastWeek", "x-order": 30 }, "up_last_month": { "description": "Number of up revisions over the last 30 days", "examples": [ 5 ], "format": "int64", "type": "integer", "x-go-name": "UpLastMonth", "x-order": 40 }, "down_last_week": { "description": "Number of down revisions over the last 7 days", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "DownLastWeek", "x-order": 50 }, "down_last_month": { "description": "Number of down revisions over the last 30 days", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "DownLastMonth", "x-order": 60 } }, "required": [ "date", "period" ], "type": "object" }, "GetEpsRevisions_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_meta" }, "eps_revision": { "description": "EPS revision data", "items": { "$ref": "#/components/schemas/GetEpsRevisions_200_response_eps_revision_inner" }, "type": "array", "x-go-name": "EpsRevision", "x-order": 20 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "eps_revision", "meta", "status" ], "type": "object" }, "GetEpsTrend_200_response_eps_trend_inner": { "properties": { "date": { "description": "Date of the estimation", "examples": [ "2022-09-30" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "period": { "description": "Period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`", "examples": [ "current_quarter" ], "type": "string", "x-go-name": "Period", "x-order": 20 }, "current_estimate": { "description": "Actual EPS estimation for the period", "examples": [ 1.26 ], "format": "double", "type": "number", "x-go-name": "CurrentEstimate", "x-order": 30 }, "7_days_ago": { "description": "EPS estimation value 7 days ago", "examples": [ 1.26 ], "format": "double", "type": "number", "x-go-name": "SevenDaysAgo", "x-order": 40 }, "30_days_ago": { "description": "EPS estimation value 30 days ago", "examples": [ 1.31 ], "format": "double", "type": "number", "x-go-name": "ThirtyDaysAgo", "x-order": 50 }, "60_days_ago": { "description": "EPS estimation value 60 days ago", "examples": [ 1.32 ], "format": "double", "type": "number", "x-go-name": "SixtyDaysAgo", "x-order": 60 }, "90_days_ago": { "description": "EPS estimation value 90 days ago", "examples": [ 1.33 ], "format": "double", "type": "number", "x-go-name": "NinetyDaysAgo", "x-order": 70 } }, "required": [ "date", "period" ], "type": "object" }, "GetEpsTrend_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_meta" }, "eps_trend": { "description": "EPS trend data", "items": { "$ref": "#/components/schemas/GetEpsTrend_200_response_eps_trend_inner" }, "type": "array", "x-go-name": "EpsTrend", "x-order": 20 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "eps_trend", "meta", "status" ], "type": "object" }, "GetEtf_200_response": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of ETFs", "items": { "$ref": "#/components/schemas/EtfResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "GetETFsFamily_200_response": { "properties": { "result": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "List of fund families by country", "examples": [ { "India": [ "Aberdeen Standard Fund Managers Limited", "Aditya Birla Sun Life AMC Ltd" ], "United States": [ "Aegon Asset Management UK PLC", "Ampega Investment GmbH", "Aviva SpA" ] } ], "type": "object", "x-go-name": "Result", "x-order": 10 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "result", "status" ], "type": "object" }, "GetETFsList_200_response_result": { "properties": { "count": { "description": "Total number of matching funds", "examples": [ 1000 ], "format": "int64", "type": "integer", "x-go-name": "Count", "x-order": 10 }, "list": { "description": "List of ETFs", "items": { "$ref": "#/components/schemas/ETFsListResponseItem" }, "type": "array", "x-go-name": "List", "x-order": 20 } }, "required": [ "count", "list" ], "type": "object", "x-go-name": "Result", "x-order": 10 }, "GetETFsList_200_response": { "properties": { "result": { "$ref": "#/components/schemas/GetETFsList_200_response_result" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "result", "status" ], "type": "object" }, "GetETFsType_200_response": { "properties": { "result": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "List of fund types by country", "examples": [ { "Singapore": [ "Property - Indirect Asia", "Sector Equity Water" ], "United States": [ "Asia-Pacific ex-Japan Equity", "EUR Flexible Allocation - Global" ] } ], "type": "object", "x-go-name": "Result", "x-order": 10 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "result", "status" ], "type": "object" }, "GetETFsWorld_200_response_etf_summary": { "description": "A brief summary of a etf", "properties": { "symbol": { "description": "All available fund types segmented by country", "examples": [ "IVV" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "iShares Core S&P 500 ETF" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "iShares" ], "type": "string", "x-go-name": "FundFamily", "x-order": 30 }, "fund_type": { "description": "Type of the fund", "examples": [ "Large Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 40 }, "currency": { "description": "Currency of fund price", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "share_class_inception_date": { "description": "The date from which the fund started operations and the returns are calculated", "examples": [ "2000-11-13" ], "type": "string", "x-go-name": "ShareClassInceptionDate", "x-order": 60 }, "ytd_return": { "description": "Percentage of profit of the fund since the first trading day of the current calendar year", "examples": [ -0.0537 ], "format": "double", "type": "number", "x-go-name": "YtdReturn", "x-order": 70 }, "expense_ratio_net": { "description": "Percentage of ETF assets steered toward a fund's operating expenses and fund management fees", "examples": [ -0.004 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet", "x-order": 80 }, "yield": { "description": "Income returned to its investors through interest and dividends generated by the fund's investments", "examples": [ 0.0133 ], "format": "double", "type": "number", "x-go-name": "Yield", "x-order": 90 }, "nav": { "description": "Net Asset Value: fund value minus liabilities", "examples": [ 413.24 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 100 }, "last_price": { "description": "Last price of the fund", "examples": [ 413.24 ], "format": "double", "type": "number", "x-go-name": "LastPrice", "x-order": 110 }, "turnover_rate": { "description": "Percentage rate at which ETF replaces its holdings on investment every year", "examples": [ 0.04 ], "format": "double", "type": "number", "x-go-name": "TurnoverRate", "x-order": 130 }, "net_assets": { "description": "Total assets of a fund minus its total liabilities", "examples": [ 753409982464 ], "format": "int64", "type": "integer", "x-go-name": "NetAssets", "x-order": 140 }, "overview": { "description": "Description of the fund", "examples": [ "The investment seeks to track the performance of the Standard & Poor's 500..." ], "type": "string", "x-go-name": "Overview", "x-order": 150 } }, "required": [ "name", "symbol" ], "type": "object", "x-go-name": "Summary", "x-order": 10 }, "GetETFsWorld_200_response_etf_performance_trailing_returns_inner": { "properties": { "period": { "description": "Period of trailing returns", "examples": [ "ytd" ], "type": "string", "x-go-name": "Period", "x-order": 10 }, "share_class_return": { "description": "Fund returns (%) generated over a given period", "examples": [ -0.0751 ], "format": "double", "type": "number", "x-go-name": "ShareClassReturn", "x-order": 20 }, "category_return": { "description": "Same category average returns (%) generated over a given period", "examples": [ 0.1484 ], "format": "double", "type": "number", "x-go-name": "CategoryReturn", "x-order": 30 } }, "type": "object" }, "GetETFsWorld_200_response_etf_performance_annual_total_returns_inner": { "properties": { "year": { "description": "Year of total returns", "examples": [ 2021 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 10 }, "share_class_return": { "description": "Fund total returns (%) generated over a given year", "examples": [ 0.2866 ], "format": "double", "type": "number", "x-go-name": "ShareClassReturn", "x-order": 20 }, "category_return": { "description": "Same category average total returns (%) generated over a given year", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "CategoryReturn", "x-order": 30 } }, "type": "object" }, "GetETFsWorld_200_response_etf_performance": { "description": "Detailed performance of a etf", "properties": { "trailing_returns": { "description": "Performance returns of the fund and its category over various trailing time periods", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_performance_trailing_returns_inner" }, "type": "array", "x-go-name": "TrailingReturns", "x-order": 10 }, "annual_total_returns": { "description": "Fund and category total returns (%) for each calendar year", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_performance_annual_total_returns_inner" }, "type": "array", "x-go-name": "AnnualTotalReturns", "x-order": 20 } }, "type": "object", "x-go-name": "Performance", "x-order": 20 }, "GetETFsWorld_200_response_etf_risk_volatility_measures_inner": { "properties": { "period": { "description": "Period of a measure", "examples": [ "3_year" ], "type": "string", "x-go-name": "Period", "x-order": 10 }, "alpha": { "description": "Alpha score of a fund", "examples": [ -0.03 ], "format": "double", "type": "number", "x-go-name": "Alpha", "x-order": 20 }, "alpha_category": { "description": "Average alpha score of a fund's category", "examples": [ -0.02 ], "format": "double", "type": "number", "x-go-name": "AlphaCategory", "x-order": 30 }, "beta": { "description": "Beta score of a fund", "examples": [ 1 ], "format": "double", "type": "number", "x-go-name": "Beta", "x-order": 40 }, "beta_category": { "description": "Average beta score of a fund's category", "examples": [ 0.01 ], "format": "double", "type": "number", "x-go-name": "BetaCategory", "x-order": 50 }, "mean_annual_return": { "description": "Mean annual return of a fund", "examples": [ 1.58 ], "format": "double", "type": "number", "x-go-name": "MeanAnnualReturn", "x-order": 60 }, "mean_annual_return_category": { "description": "Average mean annual return of a fund's category", "examples": [ 0.01 ], "format": "double", "type": "number", "x-go-name": "MeanAnnualReturnCategory", "x-order": 70 }, "r_squared": { "description": "R-squared metric of a fund", "examples": [ 100 ], "format": "double", "type": "number", "x-go-name": "RSquared", "x-order": 80 }, "r_squared_category": { "description": "Average r-squared metric of a fund's category", "examples": [ 0.95 ], "format": "double", "type": "number", "x-go-name": "RSquaredCategory", "x-order": 90 }, "std": { "description": "Standard deviation of a fund", "examples": [ 18.52 ], "format": "double", "type": "number", "x-go-name": "Std", "x-order": 100 }, "std_category": { "description": "Average standard deviation of a fund's category", "examples": [ 0.19 ], "format": "double", "type": "number", "x-go-name": "StdCategory", "x-order": 110 }, "sharpe_ratio": { "description": "Sharpe ratio of a fund", "examples": [ 0.95 ], "format": "double", "type": "number", "x-go-name": "SharpeRatio", "x-order": 120 }, "sharpe_ratio_category": { "description": "Average sharpe ratio of a fund's category", "examples": [ 0.01 ], "format": "double", "type": "number", "x-go-name": "SharpeRatioCategory", "x-order": 130 }, "treynor_ratio": { "description": "Treynor ratio of a fund", "examples": [ 17.41 ], "format": "double", "type": "number", "x-go-name": "TreynorRatio", "x-order": 140 }, "treynor_ratio_category": { "description": "Average treynor ratio of a fund's category", "examples": [ 0.16 ], "format": "double", "type": "number", "x-go-name": "TreynorRatioCategory", "x-order": 150 } }, "type": "object" }, "GetETFsWorld_200_response_etf_risk_valuation_metrics": { "description": "Valuation ratios and metrics of the fund and its category", "properties": { "price_to_earnings": { "description": "Fund price to earnings metric", "examples": [ 26.46 ], "format": "double", "type": "number", "x-go-name": "PriceToEarnings", "x-order": 10 }, "price_to_book": { "description": "Fund price to book metric", "examples": [ 4.42 ], "format": "double", "type": "number", "x-go-name": "PriceToBook", "x-order": 30 }, "price_to_sales": { "description": "Fund price to sales metric", "examples": [ 2.96 ], "format": "double", "type": "number", "x-go-name": "PriceToSales", "x-order": 50 }, "price_to_cashflow": { "description": "Fund price to cashflow metric", "examples": [ 17.57 ], "format": "double", "type": "number", "x-go-name": "PriceToCashflow", "x-order": 70 } }, "type": "object", "x-go-name": "ValuationMetrics", "x-order": 20 }, "GetETFsWorld_200_response_etf_risk": { "description": "Risk metrics of a etf", "properties": { "volatility_measures": { "description": "Risk and volatility statistics of the fund and its category over different periods", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_risk_volatility_measures_inner" }, "type": "array", "x-go-name": "VolatilityMeasures", "x-order": 10 }, "valuation_metrics": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_risk_valuation_metrics" } }, "type": "object", "x-go-name": "Risk", "x-order": 30 }, "GetETFsWorld_200_response_etf_composition_major_market_sectors_inner": { "properties": { "sector": { "description": "Sector category of a fund exposure", "examples": [ "Technology" ], "type": "string", "x-go-name": "Sector", "x-order": 10 }, "weight": { "description": "Weight of a fund exposure in a sector", "examples": [ 0.2424 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 20 } }, "type": "object" }, "GetETFsWorld_200_response_etf_composition_country_allocation_inner": { "properties": { "country": { "description": "Country name", "examples": [ "United Kingdom" ], "type": "string", "x-go-name": "Country", "x-order": 10 }, "allocation": { "description": "Percentages of a fund's net assets distributed to securities of the country", "examples": [ 0.9855 ], "format": "double", "type": "number", "x-go-name": "Allocation", "x-order": 20 } }, "type": "object" }, "GetETFsWorld_200_response_etf_composition_asset_allocation": { "description": "Asset allocation of a fund by different asset classes and their respective weights", "properties": { "cash": { "description": "Percentage of overall portfolio composition in cash", "examples": [ 0.0004 ], "format": "double", "type": "number", "x-go-name": "Cash", "x-order": 10 }, "stocks": { "description": "Percentage of overall portfolio composition in stocks", "examples": [ 0.9996 ], "format": "double", "type": "number", "x-go-name": "Stocks", "x-order": 20 }, "preferred_stocks": { "description": "Percentage of overall portfolio composition in preferred stocks", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "PreferredStocks", "x-order": 30 }, "convertables": { "description": "Percentage of overall portfolio composition in convertable securities", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Convertables", "x-order": 40 }, "bonds": { "description": "Percentage of overall portfolio composition in bond", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Bonds", "x-order": 50 }, "others": { "description": "Percentage of overall portfolio composition in other forms of holding", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Others", "x-order": 60 } }, "type": "object", "x-go-name": "AssetAllocation", "x-order": 30 }, "GetETFsWorld_200_response_etf_composition_top_holdings_inner": { "properties": { "symbol": { "description": "Symbol ticker of a holding instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of a holding instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "weight": { "description": "Weight of a holding instrument in overall portfolio composition", "examples": [ 0.0592 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 50 } }, "type": "object" }, "GetETFsWorld_200_response_etf_composition_bond_breakdown_average_maturity": { "description": "Average credit rating of bond holding of a fund", "properties": { "fund": { "description": "Average maturity of bond holding of a fund", "examples": [ 6.65 ], "format": "double", "type": "number", "x-go-name": "Fund", "x-order": 10 }, "category": { "description": "Average maturity of bond holding of funds in the same category", "examples": [ 7.81 ], "format": "double", "type": "number", "x-go-name": "Category", "x-order": 20 } }, "type": "object", "x-go-name": "AverageMaturity", "x-order": 10 }, "GetETFsWorld_200_response_etf_composition_bond_breakdown_average_duration": { "description": "Average duration of bond holding of a fund", "properties": { "fund": { "description": "Average duration of bond holding of a fund", "examples": [ 5.72 ], "format": "double", "type": "number", "x-go-name": "Fund", "x-order": 10 }, "category": { "description": "Average duration of bond holding of funds in the same category", "examples": [ 5.64 ], "format": "double", "type": "number", "x-go-name": "Category", "x-order": 20 } }, "type": "object", "x-go-name": "AverageDuration", "x-order": 20 }, "GetETFsWorld_200_response_etf_composition_bond_breakdown_credit_quality_inner": { "properties": { "grade": { "description": "Rating of bond holding of a fund from AAA to below B", "examples": [ "AAA" ], "type": "string", "x-go-name": "Grade", "x-order": 10 }, "weight": { "description": "Weight of bond holding in fund portfolio", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 20 } }, "type": "object" }, "GetETFsWorld_200_response_etf_composition_bond_breakdown": { "description": "Breakdown of the fund’s portfolio by bond holding characteristics", "properties": { "average_maturity": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_bond_breakdown_average_maturity" }, "average_duration": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_bond_breakdown_average_duration" }, "credit_quality": { "description": "Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_bond_breakdown_credit_quality_inner" }, "type": "array", "x-go-name": "CreditQuality", "x-order": 30 } }, "type": "object", "x-go-name": "BondBreakdown", "x-order": 50 }, "GetETFsWorld_200_response_etf_composition": { "description": "Composition of a etf", "properties": { "major_market_sectors": { "description": "Breakdown of the fund’s portfolio by major industry sectors and their respective weights", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_major_market_sectors_inner" }, "type": "array", "x-go-name": "MajorMarketSectors", "x-order": 10 }, "country_allocation": { "description": "Breakdown of the fund’s portfolio by country and their respective weights", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_country_allocation_inner" }, "type": "array", "x-go-name": "CountryAllocation", "x-order": 20 }, "asset_allocation": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_asset_allocation" }, "top_holdings": { "description": "Top holdings of a fund with their respective weights in the overall portfolio composition", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_top_holdings_inner" }, "type": "array", "x-go-name": "TopHoldings", "x-order": 40 }, "bond_breakdown": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_bond_breakdown" } }, "type": "object", "x-go-name": "Composition", "x-order": 40 }, "GetETFsWorld_200_response_etf": { "description": "Etf information", "properties": { "summary": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_summary" }, "performance": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_performance" }, "risk": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_risk" }, "composition": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition" } }, "type": "object", "x-go-name": "Etf", "x-order": 10 }, "GetETFsWorld_200_response": { "properties": { "etf": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "etf", "status" ], "type": "object" }, "GetETFsWorldComposition_200_response_etf_composition": { "description": "Composition of a etf", "properties": { "major_market_sectors": { "description": "Breakdown of the fund’s portfolio by major industry sectors and their respective weights", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_major_market_sectors_inner" }, "type": "array", "x-go-name": "MajorMarketSectors", "x-order": 10 }, "country_allocation": { "description": "Breakdown of the fund’s portfolio by country and their respective weights", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_country_allocation_inner" }, "type": "array", "x-go-name": "CountryAllocation", "x-order": 20 }, "asset_allocation": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_asset_allocation" }, "top_holdings": { "description": "Top holdings of a fund with their respective weights in the overall portfolio composition", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_top_holdings_inner" }, "type": "array", "x-go-name": "TopHoldings", "x-order": 40 }, "bond_breakdown": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_composition_bond_breakdown" } }, "type": "object", "x-go-name": "Composition", "x-order": 10 }, "GetETFsWorldComposition_200_response_etf": { "description": "Etf information", "properties": { "composition": { "$ref": "#/components/schemas/GetETFsWorldComposition_200_response_etf_composition" } }, "type": "object", "x-go-name": "Etf", "x-order": 10 }, "GetETFsWorldComposition_200_response": { "properties": { "etf": { "$ref": "#/components/schemas/GetETFsWorldComposition_200_response_etf" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "etf", "status" ], "type": "object" }, "GetETFsWorldPerformance_200_response_etf_performance": { "description": "Detailed performance of a etf", "properties": { "trailing_returns": { "description": "Performance returns of the fund and its category over various trailing time periods", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_performance_trailing_returns_inner" }, "type": "array", "x-go-name": "TrailingReturns", "x-order": 10 }, "annual_total_returns": { "description": "Fund and category total returns (%) for each calendar year", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_performance_annual_total_returns_inner" }, "type": "array", "x-go-name": "AnnualTotalReturns", "x-order": 20 } }, "type": "object", "x-go-name": "Performance", "x-order": 10 }, "GetETFsWorldPerformance_200_response_etf": { "description": "Etf information", "properties": { "performance": { "$ref": "#/components/schemas/GetETFsWorldPerformance_200_response_etf_performance" } }, "type": "object", "x-go-name": "Etf", "x-order": 10 }, "GetETFsWorldPerformance_200_response": { "properties": { "etf": { "$ref": "#/components/schemas/GetETFsWorldPerformance_200_response_etf" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "etf", "status" ], "type": "object" }, "GetETFsWorldRisk_200_response_etf_risk": { "description": "Risk metrics of a etf", "properties": { "volatility_measures": { "description": "Risk and volatility statistics of the fund and its category over different periods", "items": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_risk_volatility_measures_inner" }, "type": "array", "x-go-name": "VolatilityMeasures", "x-order": 10 }, "valuation_metrics": { "$ref": "#/components/schemas/GetETFsWorld_200_response_etf_risk_valuation_metrics" } }, "type": "object", "x-go-name": "Risk", "x-order": 10 }, "GetETFsWorldRisk_200_response_etf": { "description": "Etf information", "properties": { "risk": { "$ref": "#/components/schemas/GetETFsWorldRisk_200_response_etf_risk" } }, "type": "object", "x-go-name": "Etf", "x-order": 10 }, "GetETFsWorldRisk_200_response": { "properties": { "etf": { "$ref": "#/components/schemas/GetETFsWorldRisk_200_response_etf" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "etf", "status" ], "type": "object" }, "GetETFsWorldSummary_200_response_etf_summary": { "description": "A brief summary of a ETF", "properties": { "symbol": { "description": "All available fund types segmented by country", "examples": [ "IVV" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "iShares Core S&P 500 ETF" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "iShares" ], "type": "string", "x-go-name": "FundFamily", "x-order": 30 }, "fund_type": { "description": "Type of the fund", "examples": [ "Large Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 40 }, "currency": { "description": "Currency of fund price", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "share_class_inception_date": { "description": "The date from which the fund started operations and the returns are calculated", "examples": [ "2000-11-13" ], "type": "string", "x-go-name": "ShareClassInceptionDate", "x-order": 60 }, "ytd_return": { "description": "Percentage of profit of the fund since the first trading day of the current calendar year", "examples": [ -0.0537 ], "format": "double", "type": "number", "x-go-name": "YtdReturn", "x-order": 70 }, "expense_ratio_net": { "description": "Percentage of ETF assets steered toward a fund's operating expenses and fund management fees", "examples": [ -0.004 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet", "x-order": 80 }, "yield": { "description": "Income returned to its investors through interest and dividends generated by the fund's investments", "examples": [ 0.0133 ], "format": "double", "type": "number", "x-go-name": "Yield", "x-order": 90 }, "nav": { "description": "Net Asset Value: fund value minus liabilities", "examples": [ 413.24 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 100 }, "last_price": { "description": "Last price of the fund", "examples": [ 413.24 ], "format": "double", "type": "number", "x-go-name": "LastPrice", "x-order": 110 }, "turnover_rate": { "description": "Percentage rate at which ETF replaces its holdings on investment every year", "examples": [ 0.04 ], "format": "double", "type": "number", "x-go-name": "TurnoverRate", "x-order": 130 }, "net_assets": { "description": "Total assets of a fund minus its total liabilities", "examples": [ 753409982464 ], "format": "int64", "type": "integer", "x-go-name": "NetAssets", "x-order": 140 }, "overview": { "description": "Description of the fund", "examples": [ "The investment seeks to track the performance of the Standard & Poor's 500..." ], "type": "string", "x-go-name": "Overview", "x-order": 150 } }, "required": [ "name", "symbol" ], "type": "object", "x-go-name": "Summary", "x-order": 10 }, "GetETFsWorldSummary_200_response_etf": { "description": "Etf information", "properties": { "summary": { "$ref": "#/components/schemas/GetETFsWorldSummary_200_response_etf_summary" } }, "type": "object", "x-go-name": "Etf", "x-order": 10 }, "GetETFsWorldSummary_200_response": { "properties": { "etf": { "$ref": "#/components/schemas/GetETFsWorldSummary_200_response_etf" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "etf", "status" ], "type": "object" }, "GetExchangeRate_200_response": { "properties": { "symbol": { "description": "Requested currency symbol", "examples": [ "USD/JPY" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "rate": { "description": "Real-time exchange rate for the corresponding symbol", "examples": [ 105.12 ], "format": "double", "type": "number", "x-go-name": "Rate", "x-order": 20 }, "timestamp": { "description": "Unix timestamp of the rate", "examples": [ 1602714051 ], "format": "int64", "type": "integer", "x-go-name": "Timestamp", "x-order": 30 } }, "required": [ "rate", "symbol", "timestamp" ], "type": "object" }, "GetExchangeSchedule_200_response": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ExchangeScheduleResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 } }, "required": [ "data" ], "type": "object" }, "GetExchanges_200_response": { "properties": { "data": { "description": "List of exchanges", "items": { "$ref": "#/components/schemas/ExchangesResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "data", "status" ], "type": "object" }, "GetTimeSeriesExp_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "EXP - Exponential" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesExp_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesExp_200_response_meta_indicator" } } } ] }, "GetTimeSeriesExp_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "exp": { "description": "Exp value", "examples": [ "2.0649375034375067e+87" ], "type": "string", "x-go-name": "Exp", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "exp" ], "type": "object" }, "GetTimeSeriesExp_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesExp_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesExp_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesFloor_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "FLOOR - FLOOR" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesFloor_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesFloor_200_response_meta_indicator" } } } ] }, "GetTimeSeriesFloor_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "floor": { "description": "Floor value", "examples": [ "201.0" ], "type": "string", "x-go-name": "Floor", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "floor" ], "type": "object" }, "GetTimeSeriesFloor_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesFloor_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesFloor_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetForexPairs_200_response": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of forex pairs", "items": { "$ref": "#/components/schemas/ForexResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "GetFundHolders_200_response_meta": { "description": "Meta information about the financial instrument", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of symbol", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetFundHolders_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetFundHolders_200_response_meta" }, "fund_holders": { "description": "List of fund holders for the financial instrument", "items": { "$ref": "#/components/schemas/FundHolderItem" }, "type": "array", "x-go-name": "FundHolders", "x-order": 20 } }, "required": [ "fund_holders", "meta" ], "type": "object" }, "GetFunds_200_response_result": { "properties": { "count": { "description": "Total number of matching instruments", "examples": [ 84799 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "list": { "description": "List of funds", "items": { "$ref": "#/components/schemas/FundResponseItem" }, "type": "array", "x-go-name": "Data" } }, "required": [ "count", "list" ], "type": "object", "x-go-name": "Result" }, "GetFunds_200_response": { "properties": { "result": { "$ref": "#/components/schemas/GetFunds_200_response_result" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "result", "status" ], "type": "object" }, "GetGrowthEstimates_200_response_growth_estimates": { "description": "Growth estimates data", "properties": { "current_quarter": { "description": "Projected growth of the current quarter in percentage (%)", "examples": [ 0.016 ], "format": "double", "type": "number", "x-go-name": "CurrentQuarter", "x-order": 10 }, "next_quarter": { "description": "Projected growth of the next quarter in percentage (%)", "examples": [ 0.01 ], "format": "double", "type": "number", "x-go-name": "NextQuarter", "x-order": 20 }, "current_year": { "description": "Projected growth of the current year in percentage (%)", "examples": [ 0.087 ], "format": "double", "type": "number", "x-go-name": "CurrentYear", "x-order": 30 }, "next_year": { "description": "Projected growth of the next year in percentage (%)", "examples": [ 0.055999998 ], "format": "double", "type": "number", "x-go-name": "NextYear", "x-order": 40 }, "next_5_years_pa": { "description": "Projected growth during the next 5 years in percentage (%) per annum", "examples": [ 0.094799995 ], "format": "double", "type": "number", "x-go-name": "Next5YearsPA", "x-order": 50 }, "past_5_years_pa": { "description": "Actual growth over the last 5 years in percentage (%) per annum", "examples": [ 0.23867 ], "format": "double", "type": "number", "x-go-name": "Past5YearsPA", "x-order": 60 } }, "type": "object", "x-go-name": "GrowthEstimates", "x-order": 20 }, "GetGrowthEstimates_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_meta" }, "growth_estimates": { "$ref": "#/components/schemas/GetGrowthEstimates_200_response_growth_estimates" }, "status": { "description": "Status of the request", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status" ], "type": "object" }, "GetTimeSeriesHeikinashiCandles_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HEIKINASHICANDLES - Heikin-Ashi Candles" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHeikinashiCandles_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHeikinashiCandles_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "heikinhighs": { "description": "Heikin-Ashi highs value", "examples": [ "201.25599" ], "type": "string", "x-go-name": "HeikinHighs", "x-order": 20 }, "heikinopens": { "description": "Heikin-Ashi opens value", "examples": [ "200.9825" ], "type": "string", "x-go-name": "HeikinOpens", "x-order": 30 }, "heikincloses": { "description": "Heikin-Ashi closes value", "examples": [ "201.02449" ], "type": "string", "x-go-name": "HeikinCloses", "x-order": 40 }, "heikinlows": { "description": "Heikin-Ashi lows value", "examples": [ "200.85199" ], "type": "string", "x-go-name": "HeikinLows", "x-order": 50 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "heikincloses", "heikinhighs", "heikinlows", "heikinopens" ], "type": "object" }, "GetTimeSeriesHeikinashiCandles_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHlc3_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HLC3 - High, Low, Close Average Values" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHlc3_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHlc3_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHlc3_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "hlc3": { "description": "hlc3 value", "examples": [ "201.05266" ], "type": "string", "x-go-name": "Hlc3", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "hlc3" ], "type": "object" }, "GetTimeSeriesHlc3_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHlc3_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHlc3_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtDcPeriod_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_DCPERIOD - Hilbert Transform Dominant Cycle Period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtDcPeriod_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPeriod_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtDcPeriod_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ht_dcperiod": { "description": "ht_dcperiod value", "examples": [ "28.12565" ], "type": "string", "x-go-name": "HtDcPeriod", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ht_dcperiod" ], "type": "object" }, "GetTimeSeriesHtDcPeriod_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPeriod_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPeriod_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtDcPhase_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_DCPHASE - Hilbert Transform Dominant Cycle Phase" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtDcPhase_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPhase_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtDcPhase_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ht_dcphase": { "description": "HT_DCPHASE value", "examples": [ "-38.50975" ], "type": "string", "x-go-name": "HtDcPhase", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ht_dcphase" ], "type": "object" }, "GetTimeSeriesHtDcPhase_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPhase_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtDcPhase_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtPhasor_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_PHASOR - Hilbert Transform Phasor Components" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtPhasor_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtPhasor_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtPhasor_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "in_phase": { "description": "In_phase value", "examples": [ "-0.56826" ], "type": "string", "x-go-name": "InPhase", "x-order": 20 }, "quadrature": { "description": "Quadrature value", "examples": [ "-0.43318" ], "type": "string", "x-go-name": "Quadrature", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "in_phase", "quadrature" ], "type": "object" }, "GetTimeSeriesHtPhasor_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtPhasor_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtPhasor_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtSine_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_SINE - Hilbert Transform SineWave" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtSine_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtSine_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtSine_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ht_sine": { "description": "ht_sine value", "examples": [ "-0.62265" ], "type": "string", "x-go-name": "HtSine", "x-order": 20 }, "ht_leadsine": { "description": "ht_leadsine value", "examples": [ "0.11303" ], "type": "string", "x-go-name": "HtLeadSine", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ht_leadsine", "ht_sine" ], "type": "object" }, "GetTimeSeriesHtSine_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtSine_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtSine_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtTrendline_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_TRENDLINE - Hilbert Transform Instantaneous Trendline" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtTrendline_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendline_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtTrendline_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ht_trendline": { "description": "HT_TRENDLINE value", "examples": [ "202.26597" ], "type": "string", "x-go-name": "HtTrendline", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ht_trendline" ], "type": "object" }, "GetTimeSeriesHtTrendline_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendline_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendline_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesHtTrendMode_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "HT_TRENDMODE - Hilbert Transform Trend vs Cycle Mode" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesHtTrendMode_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendMode_200_response_meta_indicator" } } } ] }, "GetTimeSeriesHtTrendMode_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "ht_trendmode": { "description": "ht_trendmode value", "examples": [ "0" ], "type": "string", "x-go-name": "HtTrendMode", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ht_trendmode" ], "type": "object" }, "GetTimeSeriesHtTrendMode_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendMode_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesHtTrendMode_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesIchimoku_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ICHIMOKU - Ichimoku Kinkō Hyō" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "conversion_line_period": { "description": "The time period used for generating the conversation line", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "ConversionLinePeriod", "x-order": 20 }, "base_line_period": { "description": "The time period used for generating the base line", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "BaseLinePeriod", "x-order": 30 }, "leading_span_b_period": { "description": "The time period used for generating the leading span B line", "examples": [ 52 ], "format": "int64", "type": "integer", "x-go-name": "LeadingSpanBPeriod", "x-order": 40 }, "lagging_span_period": { "description": "The time period used for generating the lagging span line", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "LaggingSpanPeriod", "x-order": 50 }, "include_ahead_span_period": { "description": "Indicates whether to include ahead span period", "examples": [ true ], "type": "boolean", "x-go-name": "IncludeAheadSpanPeriod", "x-order": 60 } }, "required": [ "base_line_period", "conversion_line_period", "include_ahead_span_period", "lagging_span_period", "leading_span_b_period", "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesIchimoku_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesIchimoku_200_response_meta_indicator" } } } ] }, "GetTimeSeriesIchimoku_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "tenkan_sen": { "description": "Tenkan-sen value", "examples": [ "200.33" ], "type": "string", "x-go-name": "TenkanSen", "x-order": 20 }, "kijun_sen": { "description": "Kijun-sen value", "examples": [ "201.42" ], "type": "string", "x-go-name": "KijunSen", "x-order": 30 }, "senkou_span_a": { "description": "Senkou span A value", "examples": [ "201.49" ], "type": "string", "x-go-name": "SenkouSpanA", "x-order": 40 }, "senkou_span_b": { "description": "Senkou span B value", "examples": [ "200.35501" ], "type": "string", "x-go-name": "SenkouSpanB", "x-order": 50 }, "chikou_span": { "description": "Chikou span value", "examples": [ "199.95499" ], "type": "string", "x-go-name": "ChikouSpan", "x-order": 60 } }, "required": [ "datetime", "senkou_span_a", "senkou_span_b" ], "type": "object" }, "GetTimeSeriesIchimoku_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesIchimoku_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesIchimoku_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetIncomeStatement_200_response_meta": { "description": "Meta information about the instrument", "properties": { "symbol": { "description": "Symbol ticker of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Exchange timezone", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 }, "period": { "description": "Period of the income statement (Annual or Quarterly)", "examples": [ "Quarterly" ], "type": "string", "x-go-name": "Period", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "period", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetIncomeStatement_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetIncomeStatement_200_response_meta" }, "income_statement": { "description": "Income statement data", "items": { "$ref": "#/components/schemas/IncomeStatementBlock" }, "type": "array", "x-go-name": "IncomeStatement", "x-order": 20 } }, "required": [ "meta" ], "type": "object" }, "GetIncomeStatementConsolidated_200_response": { "properties": { "income_statement": { "description": "Income statement data", "items": { "$ref": "#/components/schemas/IncomeStatementItem" }, "type": "array", "x-go-name": "IncomeStatement", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "type": "object" }, "GetInsiderTransactions_200_response_meta": { "description": "Metadata about the instrument", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument according to the ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetInsiderTransactions_200_response_insider_transactions_inner": { "properties": { "full_name": { "description": "Full name of an individual, including first name, middle name, last name, and suffix", "examples": [ "ADAMS KATHERINE L" ], "type": "string", "x-go-name": "FullName", "x-order": 10 }, "position": { "description": "Job position of insider", "examples": [ "General Counsel" ], "type": "string", "x-go-name": "Position", "x-order": 20 }, "date_reported": { "description": "Date the transaction was reported", "examples": [ "2021-05-03" ], "type": "string", "x-go-name": "DateReported", "x-order": 30 }, "is_direct": { "description": "`true` if direct, `false` if indirect", "examples": [ true ], "type": "boolean", "x-go-name": "IsDirect", "x-order": 40 }, "shares": { "description": "As per report the number of shares acquired or disposed of the transaction", "examples": [ 17000 ], "format": "int64", "type": "integer", "x-go-name": "Shares", "x-order": 50 }, "value": { "description": "Represents the value of transaction, calculated as price multiplied by the volume", "examples": [ 2257631 ], "format": "int64", "type": "integer", "x-go-name": "Value", "x-order": 60 }, "description": { "description": "Exact price or price range of the transaction if available", "examples": [ "Sale at price 132.57 - 133.93 per share." ], "type": "string", "x-go-name": "Description", "x-order": 70 } }, "required": [ "date_reported", "description", "full_name", "position" ], "type": "object" }, "GetInsiderTransactions_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetInsiderTransactions_200_response_meta" }, "insider_transactions": { "description": "List of insider transactions", "items": { "$ref": "#/components/schemas/GetInsiderTransactions_200_response_insider_transactions_inner" }, "type": "array", "x-go-name": "InsiderTransactions", "x-order": 20 } }, "required": [ "insider_transactions", "meta" ], "type": "object" }, "GetInstitutionalHolders_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetFundHolders_200_response_meta" }, "institutional_holders": { "description": "List of institutional holders for the financial instrument", "items": { "$ref": "#/components/schemas/InstitutionalHolderItem" }, "type": "array", "x-go-name": "InstitutionalHolders", "x-order": 20 } }, "required": [ "institutional_holders", "meta" ], "type": "object" }, "GetInstrumentType_200_response": { "properties": { "result": { "description": "List of instrument types available at Twelve Data API.", "examples": [ [ "Agricultural Product", "American Depositary Receipt", "Bond", "Bond Fund", "Closed-end Fund", "Common Stock", "Depositary Receipt", "Digital Currency", "Energy Resource", "ETF", "Exchange-Traded Note", "Global Depositary Receipt", "Index", "Industrial Metal", "Limited Partnership", "Livestock", "Mutual Fund", "Physical Currency", "Precious Metal", "Preferred Stock", "REIT", "Right", "Structured Product", "Trust", "Unit", "Warrant" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Result" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "result", "status" ], "type": "object" }, "GetIntervals_200_response": { "properties": { "data": { "description": "List of available intervals", "examples": [ [ "1min", "5min", "15min", "30min", "45min", "1h", "2h", "4h", "8h", "1day", "1week", "1month" ] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "data", "status" ], "type": "object" }, "GetIpoCalendar_200_response_value_inner": { "properties": { "symbol": { "description": "Ticker of the company", "examples": [ "DWACU" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Digital World Acquisition Corp." ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange name where the company is listed", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MICCode", "x-order": 40 }, "price_range_low": { "description": "The lower bound of stock price range if available", "examples": [ 10 ], "format": "double", "type": "number", "x-go-name": "PriceRangeLow", "x-order": 50 }, "price_range_high": { "description": "The upper bound of stock price range if available", "examples": [ 10 ], "format": "double", "type": "number", "x-go-name": "PriceRangeHigh", "x-order": 60 }, "offer_price": { "description": "Initial offer price if available", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "OfferPrice", "x-order": 70 }, "currency": { "description": "Currency of the stock", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 80 }, "shares": { "description": "Number of shares, if available", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "Shares", "x-order": 90 } }, "required": [ "currency", "exchange", "mic_code", "name", "symbol" ], "type": "object" }, "GetTimeSeriesKama_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "KAMA - Kaufman's Adaptive Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesKama_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesKama_200_response_meta_indicator" } } } ] }, "GetTimeSeriesKama_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Datetime", "x-order": 10 }, "kama": { "description": "Kama value", "examples": [ "201.06741" ], "type": "string", "x-go-name": "Kama", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "kama" ], "type": "object" }, "GetTimeSeriesKama_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesKama_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesKama_200_response_values_inner" }, "type": "array", "x-go-name": "Values", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesKeltner_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "KELTNER - Keltner Channels" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 }, "atr_time_period": { "description": "The time period used for calculating the Average True Range", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "ATRTimePeriod", "x-order": 30 }, "multiplier": { "description": "The factor used to adjust the indicator's sensitivity", "examples": [ 2 ], "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": 40 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 50 }, "ma_type": { "description": "The type of moving average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 60 } }, "required": [ "atr_time_period", "ma_type", "multiplier", "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesKeltner_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesKeltner_200_response_meta_indicator" } } } ] }, "GetTimeSeriesKeltner_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "upper_line": { "description": "Upper line value", "examples": [ "202.25298" ], "type": "string", "x-go-name": "KeltnerUpper", "x-order": 20 }, "middle_line": { "description": "Middle line value", "examples": [ "201.80985" ], "type": "string", "x-go-name": "KeltnerMiddle", "x-order": 30 }, "lower_line": { "description": "Lower line value", "examples": [ "201.36672" ], "type": "string", "x-go-name": "KeltnerLower", "x-order": 40 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "lower_line", "middle_line", "upper_line" ], "type": "object" }, "GetTimeSeriesKeltner_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesKeltner_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesKeltner_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetKeyExecutives_200_response_meta": { "description": "Meta information about the instrument", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency code in which the instrument is denominated", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetKeyExecutives_200_response_key_executives_inner": { "properties": { "name": { "description": "Full name of an executive, including first name, middle name, last name, and suffix", "examples": [ "Mr. Timothy D. Cook" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "title": { "description": "Refers to job title", "examples": [ "CEO & Director" ], "type": "string", "x-go-name": "Title", "x-order": 20 }, "age": { "description": "Current age of an executive if available", "examples": [ 59 ], "format": "int64", "type": "integer", "x-go-name": "Age", "x-order": 30 }, "year_born": { "description": "Year of birth of an executive if available", "examples": [ 1961 ], "format": "int64", "type": "integer", "x-go-name": "YearBorn", "x-order": 40 }, "pay": { "description": "Total salary of an executive if available", "examples": [ 14769259 ], "format": "int64", "type": "integer", "x-go-name": "Pay", "x-order": 50 } }, "required": [ "name", "title" ], "type": "object" }, "GetKeyExecutives_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetKeyExecutives_200_response_meta" }, "key_executives": { "description": "List of key executives", "items": { "$ref": "#/components/schemas/GetKeyExecutives_200_response_key_executives_inner" }, "type": "array", "x-go-name": "KeyExecutives", "x-order": 20 } }, "required": [ "meta" ], "type": "object" }, "GetTimeSeriesKst_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "KST - Know Sure Thing" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "roc_period_1": { "description": "The time period for the first Rate of Change calculation", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "RocPeriod1", "x-order": 20 }, "roc_period_2": { "description": "The time period for the second Rate of Change calculation", "examples": [ 15 ], "format": "int64", "type": "integer", "x-go-name": "RocPeriod2", "x-order": 30 }, "roc_period_3": { "description": "The time period for the third Rate of Change calculation", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "RocPeriod3", "x-order": 40 }, "roc_period_4": { "description": "The time period for the forth Rate of Change calculation", "examples": [ 30 ], "format": "int64", "type": "integer", "x-go-name": "RocPeriod4", "x-order": 50 }, "sma_period_1": { "description": "The time period for the first Simple Moving Average", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "SmaPeriod1", "x-order": 60 }, "sma_period_2": { "description": "The time period for the second Simple Moving Average", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "SmaPeriod2", "x-order": 70 }, "sma_period_3": { "description": "The time period for the third Simple Moving Average", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "SmaPeriod3", "x-order": 80 }, "sma_period_4": { "description": "The time period for the forth Simple Moving Average", "examples": [ 15 ], "format": "int64", "type": "integer", "x-go-name": "SmaPeriod4", "x-order": 90 }, "signal_period": { "description": "The time period used for generating the signal line", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": 100 } }, "required": [ "name", "roc_period_1", "roc_period_2", "roc_period_3", "roc_period_4", "signal_period", "sma_period_1", "sma_period_2", "sma_period_3", "sma_period_4" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesKst_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesKst_200_response_meta_indicator" } } } ] }, "GetTimeSeriesKst_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "kst": { "description": "KST value", "examples": [ "-4.58644" ], "type": "string", "x-go-name": "Kst", "x-order": 20 }, "kst_signal": { "description": "KST signal value", "examples": [ "-2.05236" ], "type": "string", "x-go-name": "KstSignal", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "kst", "kst_signal" ], "type": "object" }, "GetTimeSeriesKst_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesKst_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesKst_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetLastChanges_200_response_pagination": { "description": "Pagination information", "properties": { "current_page": { "description": "Current page number", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "CurrentPage", "x-order": 10 }, "per_page": { "description": "Records per page", "examples": [ 30 ], "format": "int64", "type": "integer", "x-go-name": "PerPage", "x-order": 20 } }, "required": [ "current_page", "per_page" ], "type": "object", "x-go-name": "Pagination", "x-order": 10 }, "GetLastChanges_200_response": { "properties": { "pagination": { "$ref": "#/components/schemas/GetLastChanges_200_response_pagination" }, "data": { "description": "Data contains the list of last changes", "items": { "$ref": "#/components/schemas/LastChangeResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 20 } }, "required": [ "data", "pagination" ], "type": "object" }, "GetTimeSeriesLinearReg_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LINEARREG - Linear Regression" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLinearReg_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLinearReg_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLinearReg_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "linearreg": { "description": "linearreg value", "examples": [ "200.79327" ], "type": "string", "x-go-name": "LinearReg", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "linearreg" ], "type": "object" }, "GetTimeSeriesLinearReg_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLinearReg_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLinearReg_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesLinearRegAngle_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LINEARREGANGLE - Linear Regression Angle" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLinearRegAngle_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegAngle_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLinearRegAngle_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "linearregangle": { "description": "Linear regression angle value", "examples": [ "-8.79357" ], "type": "string", "x-go-name": "LinearRegAngle", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "linearregangle" ], "type": "object" }, "GetTimeSeriesLinearRegAngle_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegAngle_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegAngle_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesLinearRegIntercept_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LINEARREGINTERCEPT - Linear Regression Intercept" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLinearRegIntercept_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLinearRegIntercept_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "linearregintercept": { "description": "Linear Regression Intercept value", "examples": [ "202.03082" ], "type": "string", "x-go-name": "LinearRegIntercept", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "linearregintercept" ], "type": "object" }, "GetTimeSeriesLinearRegIntercept_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesLinearRegSlope_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LINEARREGSLOPE - Linear Regression Slope" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLinearRegSlope_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegSlope_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLinearRegSlope_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "linearregslope": { "description": "linearregslope value", "examples": [ "-0.15469" ], "type": "string", "x-go-name": "LinearRegSlope", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "linearregslope" ], "type": "object" }, "GetTimeSeriesLinearRegSlope_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegSlope_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLinearRegSlope_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesLn_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LN - Natural Logarithm to the base of constant e" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLn_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLn_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLn_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ln": { "description": "Natural logarithm value", "examples": [ "5.30355" ], "type": "string", "x-go-name": "Ln", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ln" ], "type": "object" }, "GetTimeSeriesLn_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLn_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLn_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesLog10_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "LOG10 - Logarithm to base 10" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesLog10_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesLog10_200_response_meta_indicator" } } } ] }, "GetTimeSeriesLog10_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "log10": { "description": "Log10 value", "examples": [ "2.3033" ], "type": "string", "x-go-name": "Log10", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "log10" ], "type": "object" }, "GetTimeSeriesLog10_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesLog10_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesLog10_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetLogo_200_response_meta": { "description": "Meta information about the instrument", "properties": { "symbol": { "description": "The ticker symbol of an instrument", "examples": [ "BTC/USD" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "exchange": { "description": "The exchange where the instrument is traded (for `crypto` only)", "examples": [ "Coinbase Pro" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 } }, "required": [ "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetLogo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetLogo_200_response_meta" }, "url": { "description": "Link to download the logo (for stocks only)", "examples": [ "https://api.twelvedata.com/logo/apple.com" ], "type": "string", "x-go-name": "URL", "x-order": 20 }, "logo_base": { "description": "Link to download the base currency logo (for `forex` and `crypto` only)", "examples": [ "https://logo.twelvedata.com/crypto/btc.png" ], "type": "string", "x-go-name": "LogoBase", "x-order": 30 }, "logo_quote": { "description": "Link to download the quote currency logo (for `forex` and `crypto` only)", "examples": [ "https://logo.twelvedata.com/crypto/usd.png" ], "type": "string", "x-go-name": "LogoQuote", "x-order": 40 } }, "required": [ "meta" ], "type": "object" }, "GetTimeSeriesMa_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MA - Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "ma_type": { "description": "The type of moving average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 40 } }, "required": [ "ma_type", "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMa_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMa_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMa_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ma": { "description": "MA value", "examples": [ "201.41205" ], "type": "string", "x-go-name": "Ma", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ma" ], "type": "object" }, "GetTimeSeriesMa_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMa_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMa_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMacd_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MACD - Moving Average Convergence Divergence" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "fast_period": { "description": "Fast period value", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 30 }, "slow_period": { "description": "Slow period value", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 40 }, "signal_period": { "description": "Signal period value", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": 50 } }, "required": [ "fast_period", "name", "series_type", "signal_period", "slow_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMacd_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMacd_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMacd_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "macd": { "description": "MACD value", "examples": [ "-0.3998" ], "type": "string", "x-go-name": "Macd", "x-order": 20 }, "macd_signal": { "description": "MACD signal line value", "examples": [ "-0.25279" ], "type": "string", "x-go-name": "MacdSignal", "x-order": 30 }, "macd_hist": { "description": "MACD histogram value", "examples": [ "-0.147" ], "type": "string", "x-go-name": "MacdHist", "x-order": 40 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "macd", "macd_hist", "macd_signal" ], "type": "object" }, "GetTimeSeriesMacd_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMacd_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMacd_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMacdSlope_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MACD_SLOPE - Moving Average Convergence Divergence Regression Slope" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "fast_period": { "description": "The shorter time period for calculation", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 30 }, "slow_period": { "description": "The longer time period for calculation", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 40 }, "signal_period": { "description": "The time period used for generating the signal line", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": 50 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 60 } }, "required": [ "fast_period", "name", "series_type", "signal_period", "slow_period", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMacdSlope_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMacdSlope_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMacdSlope_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "macd_slope": { "description": "MACD slope value", "examples": [ "0.13358" ], "type": "string", "x-go-name": "MacdSlope", "x-order": 20 }, "macd_signal_slope": { "description": "MACD signal slope value", "examples": [ "0.05345" ], "type": "string", "x-go-name": "MacdSignalSlope", "x-order": 30 }, "macd_hist_slope": { "description": "MACD histogram slope value", "examples": [ "0.08013" ], "type": "string", "x-go-name": "MacdHistSlope", "x-order": 40 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "macd_hist_slope", "macd_signal_slope", "macd_slope" ], "type": "object" }, "GetTimeSeriesMacdSlope_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMacdSlope_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMacdSlope_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMacdExt_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MACDEXT - Moving Average Convergence Divergence Extended" ], "type": "string", "x-go-name": "Name", "x-order": 5 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 10 }, "fast_period": { "description": "The shorter time period for calculation", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 20 }, "fast_ma_type": { "description": "The type of fast moving average used in the calculation", "examples": [ "SMA" ], "type": "string", "x-go-name": "FastMAType", "x-order": 30 }, "slow_period": { "description": "The longer time period for calculation", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 40 }, "slow_ma_type": { "description": "The type of slow moving average used in the calculation", "examples": [ "SMA" ], "type": "string", "x-go-name": "SlowMAType", "x-order": 50 }, "signal_period": { "description": "The time period used for generating the signal line", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "SignalPeriod", "x-order": 60 }, "signal_ma_type": { "description": "The type of moving average used for generating the signal line", "examples": [ "SMA" ], "type": "string", "x-go-name": "SignalMAType", "x-order": 70 } }, "required": [ "fast_ma_type", "fast_period", "name", "series_type", "signal_ma_type", "signal_period", "slow_ma_type", "slow_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMacdExt_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMacdExt_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMacdExt_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "macd": { "description": "MACD value", "examples": [ "-0.54508" ], "type": "string", "x-go-name": "Macd", "x-order": 20 }, "macd_signal": { "description": "MACD signal line value", "examples": [ "-0.25615" ], "type": "string", "x-go-name": "MacdSignal", "x-order": 30 }, "macd_hist": { "description": "MACD histogram value", "examples": [ "-0.28894" ], "type": "string", "x-go-name": "MacdHist", "x-order": 40 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "macd", "macd_hist", "macd_signal" ], "type": "object" }, "GetTimeSeriesMacdExt_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMacdExt_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMacdExt_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMama_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MAMA - MESA Adaptive Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "fast_limit": { "description": "The limit for the fast moving average", "examples": [ 0.5 ], "format": "double", "type": "number", "x-go-name": "FastLimit", "x-order": 30 }, "slow_limit": { "description": "The limit for the slow moving average", "examples": [ 0.05 ], "format": "double", "type": "number", "x-go-name": "SlowLimit", "x-order": 40 } }, "required": [ "fast_limit", "name", "series_type", "slow_limit" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMama_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMama_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMama_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "mama": { "description": "MAMA value", "examples": [ "201.38887" ], "type": "string", "x-go-name": "Mama", "x-order": 20 }, "fama": { "description": "FAMA value", "examples": [ "202.05517" ], "type": "string", "x-go-name": "Fama", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "fama", "mama" ], "type": "object" }, "GetTimeSeriesMama_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMama_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMama_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetMarketCap_200_response_meta": { "description": "Meta information about the company", "properties": { "symbol": { "description": "Ticker of the company", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which instrument is traded by ISO 4217 standard", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange name where the company is listed", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Exchange timezone", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetMarketCap_200_response_market_cap_inner": { "properties": { "date": { "description": "Market capitalization date", "examples": [ "2025-07-14" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "value": { "description": "Market capitalization value", "examples": [ 3115906555944 ], "format": "int64", "type": "integer", "x-go-name": "Value", "x-order": 20 } }, "required": [ "date", "value" ], "type": "object" }, "GetMarketCap_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetMarketCap_200_response_meta" }, "market_cap": { "description": "Market capitalization values", "examples": [ [ { "date": "2025-07-14", "value": 3115906555944 }, { "date": "2025-07-11", "value": 3153843487457 }, { "date": "2025-07-10", "value": 3172513237217 } ] ], "items": { "$ref": "#/components/schemas/GetMarketCap_200_response_market_cap_inner" }, "type": "array", "x-go-name": "MarketCap", "x-order": 20 } }, "required": [ "market_cap", "meta" ], "type": "object" }, "GetTimeSeriesMax_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MAX - Highest value over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMax_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMax_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMax_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "max": { "description": "Max value", "examples": [ "202.05" ], "type": "string", "x-go-name": "Max", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "max" ], "type": "object" }, "GetTimeSeriesMax_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMax_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMax_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMaxIndex_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MAXINDEX - Index of highest value over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMaxIndex_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMaxIndex_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMaxIndex_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "maxidx": { "description": "maxidx value", "examples": [ "491" ], "type": "string", "x-go-name": "MaxIndex", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "maxidx" ], "type": "object" }, "GetTimeSeriesMaxIndex_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMaxIndex_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMaxIndex_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMcGinleyDynamic_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MCGINLEY_DYNAMIC - McGinley Dynamic" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMcGinleyDynamic_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMcGinleyDynamic_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "mcginley_dynamic": { "description": "McGinley Dynamic value", "examples": [ "201.93983" ], "type": "string", "x-go-name": "McGinleyDynamic", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "mcginley_dynamic" ], "type": "object" }, "GetTimeSeriesMcGinleyDynamic_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMedPrice_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MEDPRICE - Median Price" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMedPrice_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMedPrice_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMedPrice_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "medprice": { "description": "Medprice value", "examples": [ "201.05399" ], "type": "string", "x-go-name": "MedPrice", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "medprice" ], "type": "object" }, "GetTimeSeriesMedPrice_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMedPrice_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMedPrice_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMfi_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MFI - Money Flow Index" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMfi_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMfi_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMfi_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "mfi": { "description": "MFI value", "examples": [ "22.68525" ], "type": "string", "x-go-name": "Mfi", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "mfi" ], "type": "object" }, "GetTimeSeriesMfi_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMfi_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMfi_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMidPoint_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MIDPOINT - MidPoint over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMidPoint_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMidPoint_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMidPoint_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "midpoint": { "description": "Midpoint value", "examples": [ "201.4925" ], "type": "string", "x-go-name": "MidPoint", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "midpoint" ], "type": "object" }, "GetTimeSeriesMidPoint_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMidPoint_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMidPoint_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMidPrice_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MIDPRICE - Midpoint Price over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMidPrice_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMidPrice_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMidPrice_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "midprice": { "description": "Midprice value", "examples": [ "201.535" ], "type": "string", "x-go-name": "MidPrice", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "midprice" ], "type": "object" }, "GetTimeSeriesMidPrice_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMidPrice_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMidPrice_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMin_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MIN - Lowest value over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMin_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMin_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMin_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "min": { "description": "Min value", "examples": [ "200.935" ], "type": "string", "x-go-name": "Min", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "min" ], "type": "object" }, "GetTimeSeriesMin_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMin_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMin_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMinIndex_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MININDEX - Index of lowest value over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMinIndex_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMinIndex_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMinIndex_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "minidx": { "description": "Index of lowest value over period", "examples": [ "498" ], "type": "string", "x-go-name": "MinIndex", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "minidx" ], "type": "object" }, "GetTimeSeriesMinIndex_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMinIndex_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMinIndex_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMinMax_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MINMAX - Lowest and highest values over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMinMax_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMinMax_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMinMax_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "min": { "description": "Min value", "examples": [ "200.935" ], "type": "string", "x-go-name": "Min", "x-order": 20 }, "max": { "description": "Max value", "examples": [ "202.05" ], "type": "string", "x-go-name": "Max", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "max", "min" ], "type": "object" }, "GetTimeSeriesMinMax_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMinMax_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMinMax_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMinMaxIndex_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MINMAXINDEX - Indexes of lowest and highest values over period" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMinMaxIndex_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMinMaxIndex_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMinMaxIndex_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "minidx": { "description": "Index of the lowest value over the specified period", "examples": [ "498" ], "type": "string", "x-go-name": "MinIndex", "x-order": 20 }, "maxidx": { "description": "Index of the highest value over the specified period", "examples": [ "491" ], "type": "string", "x-go-name": "MaxIndex", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "maxidx", "minidx" ], "type": "object" }, "GetTimeSeriesMinMaxIndex_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMinMaxIndex_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMinMaxIndex_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMinusDI_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MINUS_DI - Minus Directional Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMinusDI_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMinusDI_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMinusDI_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "minus_di": { "description": "Minus_di value", "examples": [ "46.60579" ], "type": "string", "x-go-name": "MinusDI", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "minus_di" ], "type": "object" }, "GetTimeSeriesMinusDI_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMinusDI_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMinusDI_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMinusDM_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MINUS_DM - Minus Directional Movement" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMinusDM_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMinusDM_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMinusDM_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "minus_dm": { "description": "Minus Directional Movement value", "examples": [ "0.96291" ], "type": "string", "x-go-name": "MinusDM", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "minus_dm" ], "type": "object" }, "GetTimeSeriesMinusDM_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMinusDM_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMinusDM_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesMom_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MOM - Momentum" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMom_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMom_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMom_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "mom": { "description": "Mom value", "examples": [ "-1.14" ], "type": "string", "x-go-name": "Mom", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "mom" ], "type": "object" }, "GetTimeSeriesMom_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMom_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMom_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetMoneyMarketFundsList_200_response": { "properties": { "data": { "description": "List of money market funds", "items": { "$ref": "#/components/schemas/MoneyMarketFundsListResponseListItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 }, "count": { "description": "Total number of matching funds", "examples": [ 168 ], "format": "int64", "type": "integer", "x-go-name": "Count", "x-order": 20 }, "page": { "description": "Current page number", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "Page", "x-order": 30 }, "page_size": { "description": "Number of records per page", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "PageSize", "x-order": 40 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 50 } }, "required": [ "count", "data", "page", "page_size", "status" ], "type": "object" }, "GetMoneyMarketFundsWorld_200_response": { "properties": { "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 }, "money_market_fund": { "$ref": "#/components/schemas/MoneyMarketFundsWorldResponseItem" } }, "required": [ "money_market_fund", "status" ], "type": "object" }, "GetTimeSeriesMult_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "MULT - Arithmetic Multiply" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "Specifies the first price data type", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Specifies the second price data type", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 } }, "required": [ "name", "series_type_1", "series_type_2" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesMult_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesMult_200_response_meta_indicator" } } } ] }, "GetTimeSeriesMult_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "mult": { "description": "Mult value", "examples": [ "40422.66609" ], "type": "string", "x-go-name": "Mult", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "mult" ], "type": "object" }, "GetTimeSeriesMult_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesMult_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesMult_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetMutualFundsFamily_200_response": { "properties": { "result": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "List of fund families by country", "examples": [ { "India": [ "Aberdeen Standard Fund Managers Limited", "Aditya Birla Sun Life AMC Ltd" ], "United States": [ "Aegon Asset Management UK PLC", "Ampega Investment GmbH", "Aviva SpA" ] } ], "type": "object", "x-go-name": "Result", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "result", "status" ], "type": "object" }, "GetMutualFundsList_200_response_result": { "description": "Response result", "properties": { "count": { "description": "Total number of matching funds", "examples": [ 1000 ], "format": "int64", "type": "integer", "x-go-name": "Count", "x-order": 10 }, "list": { "description": "List of mutual funds", "items": { "$ref": "#/components/schemas/MutualFundsListResponseListItem" }, "type": "array", "x-go-name": "Data", "x-order": 20 } }, "required": [ "count", "list" ], "type": "object", "x-go-name": "Result" }, "GetMutualFundsList_200_response": { "properties": { "result": { "$ref": "#/components/schemas/GetMutualFundsList_200_response_result" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "status" ], "type": "object" }, "GetMutualFundsType_200_response": { "properties": { "result": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "List of fund types by country", "examples": [ { "Singapore": [ "Property - Indirect Asia", "Sector Equity Water", "SGD Bond", "Singapore Equity", "Taiwan Large-Cap Equity" ], "United States": [ "Asia-Pacific ex-Japan Equity", "EUR Flexible Allocation - Global", "Euro Short Bond PP", "Large Blend", "Other Allocation" ] } ], "type": "object", "x-go-name": "Result", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "result", "status" ], "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner": { "properties": { "name": { "description": "Manager name", "examples": [ "John Doe" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "tenure_since": { "description": "Manager tenuring date", "examples": [ "2018-01-01" ], "type": "string", "x-go-name": "TenureSince", "x-order": 20 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_summary": { "description": "A brief summary of a mutual fund", "properties": { "symbol": { "description": "All available fund types segmented by country", "examples": [ "0P0001LCQ3" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Fund name", "examples": [ "JNL Small Cap Index Fund (I)" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "fund_family": { "description": "Investment company that manages the fund", "examples": [ "Jackson National" ], "type": "string", "x-go-name": "FundFamily", "x-order": 30 }, "fund_type": { "description": "Type of the fund", "examples": [ "Small Blend" ], "type": "string", "x-go-name": "FundType", "x-order": 40 }, "currency": { "description": "Currency of fund price", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "share_class_inception_date": { "description": "The date from which the fund started operations and the returns are calculated", "examples": [ "2021-04-26" ], "type": "string", "x-go-name": "ShareClassInceptionDate", "x-order": 60 }, "ytd_return": { "description": "Percentage of profit of the fund since the first trading day of the current calendar year", "examples": [ -0.02986 ], "format": "double", "type": "number", "x-go-name": "YtdReturn", "x-order": 70 }, "expense_ratio_net": { "description": "Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees", "examples": [ 0.001 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet", "x-order": 80 }, "yield": { "description": "Income returned to its investors through interest and dividends generated by the fund's investments", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Yield", "x-order": 90 }, "nav": { "description": "Net Asset Value: fund value minus liabilities", "examples": [ 10.09 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 100 }, "min_investment": { "description": "Investment minimum", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "MinInvestment", "x-order": 110 }, "turnover_rate": { "description": "Percentage rate at which mutual fund replaces its holdings on investment every year", "examples": [ 0.32 ], "format": "double", "type": "number", "x-go-name": "TurnoverRate", "x-order": 120 }, "net_assets": { "description": "Total assets of a fund minus its total liabilities", "examples": [ 2400762112 ], "format": "int64", "type": "integer", "x-go-name": "NetAssets", "x-order": 130 }, "overview": { "description": "Description of the fund", "examples": [ "The fund invests, normally, at least 80% of its assets in the stocks..." ], "type": "string", "x-go-name": "Overview", "x-order": 140 }, "people": { "description": "Information about the fund’s managers", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary_people_inner" }, "type": "array", "x-go-name": "People", "x-order": 150 } }, "type": "object", "x-go-name": "Summary", "x-order": 10 }, "GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner": { "properties": { "period": { "description": "Period of trailing returns", "examples": [ "ytd" ], "type": "string", "x-go-name": "Period", "x-order": 10 }, "share_class_return": { "description": "Fund returns (%) generated over a given period", "examples": [ -0.02986 ], "format": "double", "type": "number", "x-go-name": "ShareClassReturn", "x-order": 20 }, "category_return": { "description": "Same category average returns (%) generated over a given period", "examples": [ 0.2019 ], "format": "double", "type": "number", "x-go-name": "CategoryReturn", "x-order": 30 }, "rank_in_category": { "description": "Rank of a fund in category by total returns", "examples": [ 76 ], "format": "int64", "type": "integer", "x-go-name": "RankInCategory", "x-order": 40 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner": { "properties": { "year": { "description": "Year of total returns", "examples": [ 2024 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 10 }, "share_class_return": { "description": "Fund total returns (%) generated over a given year", "examples": [ 0.08546 ], "format": "double", "type": "number", "x-go-name": "ShareClassReturn", "x-order": 20 }, "category_return": { "description": "Same category average total returns (%) generated over a given year", "examples": [ 0.1119 ], "format": "double", "type": "number", "x-go-name": "CategoryReturn", "x-order": 30 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner": { "properties": { "year": { "description": "Year of a fund quarter return", "examples": [ 2024 ], "format": "int64", "type": "integer", "x-go-name": "Year", "x-order": 10 }, "q1": { "description": "Total return (%) of a fund in the first quarter", "examples": [ 0.02358 ], "format": "double", "type": "number", "x-go-name": "Q1", "x-order": 20 }, "q2": { "description": "Total return (%) of a fund in the second quarter", "examples": [ -0.03071 ], "format": "double", "type": "number", "x-go-name": "Q2", "x-order": 30 }, "q3": { "description": "Total return (%) of a fund in the third quarter", "examples": [ 0.10099 ], "format": "double", "type": "number", "x-go-name": "Q3", "x-order": 40 }, "q4": { "description": "Total return (%) of a fund in the fourth quarter", "examples": [ -0.00629 ], "format": "double", "type": "number", "x-go-name": "Q4", "x-order": 50 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner": { "properties": { "period": { "description": "Period of a load adjusted return", "examples": [ "1_year" ], "type": "string", "x-go-name": "Period", "x-order": 10 }, "return": { "description": "Actual return (%) an investor sees after accounting for fees and sales charges are deducted from a mutual fund's performance", "examples": [ 0.06139 ], "format": "double", "type": "number", "x-go-name": "Return", "x-order": 20 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_performance": { "description": "Detailed performance of a mutual fund", "properties": { "trailing_returns": { "description": "Trailing returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_trailing_returns_inner" }, "type": "array", "x-go-name": "TrailingReturns", "x-order": 10 }, "annual_total_returns": { "description": "Annual total returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_annual_total_returns_inner" }, "type": "array", "x-go-name": "AnnualTotalReturns", "x-order": 20 }, "quarterly_total_returns": { "description": "Quarterly total returns of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_quarterly_total_returns_inner" }, "type": "array", "x-go-name": "QuarterlyTotalReturns", "x-order": 30 }, "load_adjusted_return": { "description": "Load adjusted return of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance_load_adjusted_return_inner" }, "type": "array", "x-go-name": "LoadAdjustedReturn", "x-order": 40 } }, "type": "object", "x-go-name": "Performance", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner": { "properties": { "period": { "description": "Period of a measure", "examples": [ "3_year" ], "type": "string", "x-go-name": "Period", "x-order": 10 }, "alpha": { "description": "Alpha score of a fund", "examples": [ -9.12 ], "format": "double", "type": "number", "x-go-name": "Alpha", "x-order": 20 }, "alpha_category": { "description": "Average alpha score of a fund's category", "examples": [ -0.0939 ], "format": "double", "type": "number", "x-go-name": "AlphaCategory", "x-order": 30 }, "beta": { "description": "Beta score of a fund", "examples": [ 1 ], "format": "double", "type": "number", "x-go-name": "Beta", "x-order": 40 }, "beta_category": { "description": "Average beta score of a fund's category", "examples": [ 0.0126 ], "format": "double", "type": "number", "x-go-name": "BetaCategory", "x-order": 50 }, "mean_annual_return": { "description": "Mean annual return of a fund", "examples": [ 0.45 ], "format": "double", "type": "number", "x-go-name": "MeanAnnualReturn", "x-order": 60 }, "mean_annual_return_category": { "description": "Average mean annual return of a fund's category", "examples": [ 0.0117 ], "format": "double", "type": "number", "x-go-name": "MeanAnnualReturnCategory", "x-order": 70 }, "r_squared": { "description": "R-squared metric of a fund", "examples": [ 69 ], "format": "double", "type": "number", "x-go-name": "RSquared", "x-order": 80 }, "r_squared_category": { "description": "Average r-squared metric of a fund's category", "examples": [ 0.8309 ], "format": "double", "type": "number", "x-go-name": "RSquaredCategory", "x-order": 90 }, "std": { "description": "Standard deviation of a fund", "examples": [ 23.15 ], "format": "double", "type": "number", "x-go-name": "Std", "x-order": 100 }, "std_category": { "description": "Average standard deviation of a fund's category", "examples": [ 0.2554 ], "format": "double", "type": "number", "x-go-name": "StdCategory", "x-order": 110 }, "sharpe_ratio": { "description": "Sharpe ratio of a fund", "examples": [ 0.04 ], "format": "double", "type": "number", "x-go-name": "SharpeRatio", "x-order": 120 }, "sharpe_ratio_category": { "description": "Average sharpe ratio of a fund's category", "examples": [ 0.005 ], "format": "double", "type": "number", "x-go-name": "SharpeRatioCategory", "x-order": 130 }, "treynor_ratio": { "description": "Treynor ratio of a fund", "examples": [ -1.41 ], "format": "double", "type": "number", "x-go-name": "TreynorRatio", "x-order": 140 }, "treynor_ratio_category": { "description": "Average treynor ratio of a fund's category", "examples": [ 0.0806 ], "format": "double", "type": "number", "x-go-name": "TreynorRatioCategory", "x-order": 150 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics": { "description": "Valuation ratios and metrics of the fund and its category", "properties": { "price_to_earnings": { "description": "Fund price to earnings metric", "examples": [ 0.05695 ], "format": "double", "type": "number", "x-go-name": "PriceToEarnings", "x-order": 10 }, "price_to_earnings_category": { "description": "Average price to earnings metric of funds in the same category", "examples": [ 20.63 ], "format": "double", "type": "number", "x-go-name": "PriceToEarningsCategory", "x-order": 20 }, "price_to_book": { "description": "Fund price to book metric", "examples": [ 0.55626 ], "format": "double", "type": "number", "x-go-name": "PriceToBook", "x-order": 30 }, "price_to_book_category": { "description": "Average price to book metric of funds in the same category", "examples": [ 2.87 ], "format": "double", "type": "number", "x-go-name": "PriceToBookCategory", "x-order": 40 }, "price_to_sales": { "description": "Fund price to sales metric", "examples": [ 0.97803 ], "format": "double", "type": "number", "x-go-name": "PriceToSales", "x-order": 50 }, "price_to_sales_category": { "description": "Average price to sales metric of funds in the same category", "examples": [ 1.34 ], "format": "double", "type": "number", "x-go-name": "PriceToSalesCategory", "x-order": 60 }, "price_to_cashflow": { "description": "Fund price to cashflow metric", "examples": [ 0.10564 ], "format": "double", "type": "number", "x-go-name": "PriceToCashflow", "x-order": 70 }, "price_to_cashflow_category": { "description": "Average price to cashflow metric of funds in the same category", "examples": [ 11.81 ], "format": "double", "type": "number", "x-go-name": "PriceToCashflowCategory", "x-order": 80 }, "median_market_capitalization": { "description": "Median market capitalization of a fund", "examples": [ 2965 ], "format": "int64", "type": "integer", "x-go-name": "MedianMarketCapitalization", "x-order": 90 }, "median_market_capitalization_category": { "description": "Median market capitalization of funds in the same category", "examples": [ 4925 ], "format": "int64", "type": "integer", "x-go-name": "MedianMarketCapitalizationCategory", "x-order": 100 }, "3_year_earnings_growth": { "description": "Earnings growth over the last three years", "examples": [ 16.32 ], "format": "double", "type": "number", "x-go-name": "ThreeYearEarningsGrowth", "x-order": 110 }, "3_year_earnings_growths_category": { "description": "Earnings growth over the last three years of funds in the same category", "examples": [ 10.55 ], "format": "double", "type": "number", "x-go-name": "ThreeYearEarningsGrowthCategory", "x-order": 120 } }, "type": "object", "x-go-name": "ValuationMetrics", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_risk": { "description": "Risk metrics of a mutual fund", "properties": { "volatility_measures": { "description": "Volatility statistics of the fund", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_volatility_measures_inner" }, "type": "array", "x-go-name": "VolatilityMeasures", "x-order": 10 }, "valuation_metrics": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk_valuation_metrics" } }, "type": "object", "x-go-name": "Risk", "x-order": 30 }, "GetMutualFundsWorld_200_response_mutual_fund_ratings": { "description": "Ratings of a mutual fund", "properties": { "performance_rating": { "description": "Performance rating from 0 to 5", "examples": [ 2 ], "format": "int64", "type": "integer", "x-go-name": "PerformanceRating", "x-order": 10 }, "risk_rating": { "description": "Risk rating from 0 to 5", "examples": [ 4 ], "format": "int64", "type": "integer", "x-go-name": "RiskRating", "x-order": 20 }, "return_rating": { "description": "Return rating from 0 to 5", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "ReturnRating", "x-order": 30 } }, "type": "object", "x-go-name": "Ratings", "x-order": 40 }, "GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner": { "properties": { "sector": { "description": "Sector category of a fund exposure", "examples": [ "Industrials" ], "type": "string", "x-go-name": "Sector", "x-order": 10 }, "weight": { "description": "Weight of a fund exposure in a sector", "examples": [ 0.1742 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 20 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation": { "description": "Asset allocation of the fund by different asset classes and their respective weights", "properties": { "cash": { "description": "Percentage of overall portfolio composition in cash", "examples": [ 0.0043 ], "format": "double", "type": "number", "x-go-name": "Cash", "x-order": 10 }, "stocks": { "description": "Percentage of overall portfolio composition in stocks", "examples": [ 0.9956 ], "format": "double", "type": "number", "x-go-name": "Stocks", "x-order": 20 }, "preferred_stocks": { "description": "Percentage of overall portfolio composition in preferred stocks", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "PreferredStocks", "x-order": 30 }, "convertables": { "description": "Percentage of overall portfolio composition in convertable securities", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Convertables", "x-order": 40 }, "bonds": { "description": "Percentage of overall portfolio composition in bond", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Bonds", "x-order": 50 }, "others": { "description": "Percentage of overall portfolio composition in other forms of holding", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Others", "x-order": 60 } }, "type": "object", "x-go-name": "AssetAllocation", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner": { "properties": { "symbol": { "description": "Symbol ticker of a holding instrument", "examples": [ "BBWI" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of a holding instrument", "examples": [ "Bath & Body Works Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "weight": { "description": "Weight of a holding instrument in overall portfolio composition", "examples": [ 0.00624 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 50 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_maturity": { "description": "Average maturity of bond holdings for the fund and its category", "properties": { "fund": { "description": "Average maturity of bond holding of a fund", "format": "double", "type": "number", "x-go-name": "Fund", "x-order": 10 }, "category": { "description": "Average maturity of bond holding of funds in the same category", "examples": [ 1.97 ], "format": "double", "type": "number", "x-go-name": "Category", "x-order": 20 } }, "type": "object", "x-go-name": "AverageMaturity", "x-order": 10 }, "GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_duration": { "description": "Average duration of bond holdings for the fund and its category", "properties": { "fund": { "description": "Average duration of bond holding of a fund", "format": "double", "type": "number", "x-go-name": "Fund", "x-order": 10 }, "category": { "description": "Average duration of bond holding of funds in the same category", "examples": [ 1.64 ], "format": "double", "type": "number", "x-go-name": "Category", "x-order": 20 } }, "type": "object", "x-go-name": "AverageDuration", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_credit_quality_inner": { "properties": { "grade": { "description": "Rating of bond holding of a fund from AAA to below B", "examples": [ "U.S. Government" ], "type": "string", "x-go-name": "Grade", "x-order": 10 }, "weight": { "description": "Weight of bond holding in fund portfolio", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Weight", "x-order": 20 } }, "type": "object" }, "GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown": { "description": "Breakdown of the fund’s bond holdings by maturity, duration, and credit quality", "properties": { "average_maturity": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_maturity" }, "average_duration": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_average_duration" }, "credit_quality": { "description": "Breakdown of the fund’s bond holdings by credit rating and their respective portfolio weights", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown_credit_quality_inner" }, "type": "array", "x-go-name": "CreditQuality", "x-order": 20 } }, "type": "object", "x-go-name": "BondBreakdown", "x-order": 30 }, "GetMutualFundsWorld_200_response_mutual_fund_composition": { "description": "Composition of a mutual fund", "properties": { "major_market_sectors": { "description": "Breakdown of the fund’s portfolio by major industry sectors and their respective weights", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_major_market_sectors_inner" }, "type": "array", "x-go-name": "MajorMarketSectors", "x-order": 10 }, "asset_allocation": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_asset_allocation" }, "top_holdings": { "description": "Top holdings of the fund with their respective weights in the overall portfolio composition", "items": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_top_holdings_inner" }, "type": "array", "x-go-name": "TopHoldings", "x-order": 20 }, "bond_breakdown": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition_bond_breakdown" } }, "type": "object", "x-go-name": "Composition", "x-order": 50 }, "GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses": { "description": "Costs associated with investing in the mutual fund, including gross and net expense ratios", "properties": { "expense_ratio_gross": { "description": "Cost of investing in a mutual fund", "examples": [ 0.0022 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioGross", "x-order": 10 }, "expense_ratio_net": { "description": "Percentage of mutual fund assets steered toward a fund's operating expenses and fund management fees", "examples": [ 0.001 ], "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet", "x-order": 20 } }, "type": "object", "x-go-name": "Expenses", "x-order": 10 }, "GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums": { "description": "Minimum investment amounts required to purchase or add to the mutual fund, including IRA minimums", "properties": { "initial_investment": { "description": "Investment minimum", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "InitialInvestment", "x-order": 10 }, "additional_investment": { "description": "Minimum amount of additional investment", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "AdditionalInvestment", "x-order": 20 }, "initial_ira_investment": { "description": "Investment minimum for IRA", "format": "int64", "type": "integer", "x-go-name": "InitialIraInvestment", "x-order": 30 }, "additional_ira_investment": { "description": "Minimum amount of additional investment for IRA", "format": "int64", "type": "integer", "x-go-name": "AdditionalIraInvestment", "x-order": 40 } }, "type": "object", "x-go-name": "Minimums", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing": { "description": "Pricing information for the mutual fund", "properties": { "nav": { "description": "Net Asset Value: fund value minus liabilities", "examples": [ 10.09 ], "format": "double", "type": "number", "x-go-name": "Nav", "x-order": 10 }, "12_month_low": { "description": "Lowest price of the fund over the last year", "examples": [ 9.630000114441 ], "format": "double", "type": "number", "x-go-name": "TwelveMonthLow", "x-order": 20 }, "12_month_high": { "description": "Highest price of the fund over the last year", "examples": [ 12.10000038147 ], "format": "double", "type": "number", "x-go-name": "TwelveMonthHigh", "x-order": 30 }, "last_month": { "description": "Fund price at the end of the last month", "examples": [ 11.050000190735 ], "format": "double", "type": "number", "x-go-name": "LastMonth", "x-order": 40 } }, "type": "object", "x-go-name": "Pricing", "x-order": 30 }, "GetMutualFundsWorld_200_response_mutual_fund_purchase_info": { "description": "Purchase information of a mutual fund", "properties": { "expenses": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_expenses" }, "minimums": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_minimums" }, "pricing": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info_pricing" }, "brokerages": { "description": "List of brokerages where mutual fund can be purchased", "examples": [ [] ], "items": { "type": "string" }, "type": "array", "x-go-name": "Brokerages", "x-order": 40 } }, "type": "object", "x-go-name": "PurchaseInfo", "x-order": 60 }, "GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars": { "description": "Corporate ESG pillars", "properties": { "environmental": { "description": "ESG environmental score", "examples": [ 3.73 ], "format": "double", "type": "number", "x-go-name": "Environmental", "x-order": 10 }, "social": { "description": "ESG social score", "examples": [ 10.44 ], "format": "double", "type": "number", "x-go-name": "Social", "x-order": 20 }, "governance": { "description": "ESG governance score", "examples": [ 7.86 ], "format": "double", "type": "number", "x-go-name": "Governance", "x-order": 30 } }, "type": "object", "x-go-name": "CorporateEsgPillars", "x-order": 20 }, "GetMutualFundsWorld_200_response_mutual_fund_sustainability": { "description": "Sustainability information of a mutual fund", "properties": { "score": { "description": "Sustainability score: asset-weighted average of normalized company-level ESG Scores for the covered holdings in the portfolio from `0` to `100`", "examples": [ 22 ], "format": "int64", "type": "integer", "x-go-name": "Score", "x-order": 10 }, "corporate_esg_pillars": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability_corporate_esg_pillars" }, "sustainable_investment": { "description": "Indication that the fund discloses in their prospectus that they employ socially responsible or ESG principles in their investment selection processes", "examples": [ false ], "type": "boolean", "x-go-name": "SustainableInvestment", "x-order": 30 }, "corporate_aum": { "description": "Percentage of AUM used to calculate sustainability score", "examples": [ 0.99486 ], "format": "double", "type": "number", "x-go-name": "CorporateAum", "x-order": 40 } }, "type": "object", "x-go-name": "Sustainability", "x-order": 70 }, "GetMutualFundsWorld_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "summary": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_summary" }, "performance": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_performance" }, "risk": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_risk" }, "ratings": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_ratings" }, "composition": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_composition" }, "purchase_info": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_purchase_info" }, "sustainability": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund_sustainability" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorld_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorld_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldComposition_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "composition": { "$ref": "#/components/schemas/ResponseMutualFundWorldComposition" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldComposition_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldComposition_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldPerformance_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "performance": { "$ref": "#/components/schemas/ResponseMutualFundWorldPerformance" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldPerformance_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldPerformance_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldPurchaseInfo_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "purchase_info": { "$ref": "#/components/schemas/ResponseMutualFundWorldPurchaseInfo" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldPurchaseInfo_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldPurchaseInfo_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldRatings_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "ratings": { "$ref": "#/components/schemas/ResponseMutualFundWorldRatings" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldRatings_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldRatings_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldRisk_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "risk": { "$ref": "#/components/schemas/ResponseMutualFundWorldRisk" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldRisk_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldRisk_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldSummary_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "summary": { "$ref": "#/components/schemas/ResponseMutualFundWorldSummary" } }, "type": "object", "x-go-name": "MutualFund", "x-order": 10 }, "GetMutualFundsWorldSummary_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldSummary_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetMutualFundsWorldSustainability_200_response_mutual_fund": { "description": "Mutual fund information", "properties": { "sustainability": { "$ref": "#/components/schemas/ResponseMutualFundWorldSustainability" } }, "type": "object", "x-go-name": "Sustainability", "x-order": 10 }, "GetMutualFundsWorldSustainability_200_response": { "properties": { "mutual_fund": { "$ref": "#/components/schemas/GetMutualFundsWorldSustainability_200_response_mutual_fund" }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "mutual_fund", "status" ], "type": "object" }, "GetTimeSeriesNatr_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "NATR - Normalized Average True Range" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesNatr_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesNatr_200_response_meta_indicator" } } } ] }, "GetTimeSeriesNatr_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "natr": { "description": "natr value", "examples": [ "0.09862" ], "type": "string", "x-go-name": "Natr", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "natr" ], "type": "object" }, "GetTimeSeriesNatr_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesNatr_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesNatr_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesObv_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "OBV - On Balance Volume" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesObv_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesObv_200_response_meta_indicator" } } } ] }, "GetTimeSeriesObv_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "obv": { "description": "obv value", "examples": [ "540374.0" ], "type": "string", "x-go-name": "Obv", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "obv" ], "type": "object" }, "GetTimeSeriesObv_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesObv_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesObv_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesPercent_B_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "PERCENT_B - %B Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "sd": { "description": "The standard deviation applied in the calculation", "examples": [ 2 ], "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": 40 }, "ma_type": { "description": "The type of moving average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 50 } }, "required": [ "ma_type", "name", "sd", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesPercent_B_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesPercent_B_200_response_meta_indicator" } } } ] }, "GetTimeSeriesPercent_B_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "percent_b": { "description": "Percent_b value", "examples": [ "0.11981" ], "type": "string", "x-go-name": "Percent_B", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "percent_b" ], "type": "object" }, "GetTimeSeriesPercent_B_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesPercent_B_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesPercent_B_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesPivotPointsHL_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "PIVOT_POINTS_HL - Pivot Points (High/Low)" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesPivotPointsHL_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesPivotPointsHL_200_response_meta_indicator" } } } ] }, "GetTimeSeriesPivotPointsHL_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "pivot_point_h": { "description": "`1` if it is a high pivot point, otherwise `0`", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "PivotPointH", "x-order": 20 }, "pivot_point_l": { "description": "`1` if it is a low pivot point, otherwise `0`", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "PivotPointL", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "pivot_point_h", "pivot_point_l" ], "type": "object" }, "GetTimeSeriesPivotPointsHL_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesPivotPointsHL_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesPivotPointsHL_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesPlusDI_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "PLUS_DI - Plus Directional Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesPlusDI_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesPlusDI_200_response_meta_indicator" } } } ] }, "GetTimeSeriesPlusDI_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "plus_di": { "description": "plus_di value", "examples": [ "7.69578" ], "type": "string", "x-go-name": "PlusDI", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "plus_di" ], "type": "object" }, "GetTimeSeriesPlusDI_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesPlusDI_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesPlusDI_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesPlusDM_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "PLUS_DM - Plus Directional Movement" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesPlusDM_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesPlusDM_200_response_meta_indicator" } } } ] }, "GetTimeSeriesPlusDM_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "plus_dm": { "description": "plus_dm value", "examples": [ "0.159" ], "type": "string", "x-go-name": "PlusDM", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "plus_dm" ], "type": "object" }, "GetTimeSeriesPlusDM_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesPlusDM_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesPlusDM_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesPpo_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "PPO - Percentage Price Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 5 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 10 }, "fast_period": { "description": "The shorter time period for calculation", "examples": [ 12 ], "format": "int64", "type": "integer", "x-go-name": "FastPeriod", "x-order": 20 }, "slow_period": { "description": "The longer time period for calculation", "examples": [ 26 ], "format": "int64", "type": "integer", "x-go-name": "SlowPeriod", "x-order": 30 }, "ma_type": { "description": "The type of moving average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "MAType", "x-order": 40 } }, "required": [ "fast_period", "ma_type", "name", "series_type", "slow_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesPpo_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesPpo_200_response_meta_indicator" } } } ] }, "GetTimeSeriesPpo_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ppo": { "description": "PPO value", "examples": [ "-0.2696" ], "type": "string", "x-go-name": "Ppo", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ppo" ], "type": "object" }, "GetTimeSeriesPpo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesPpo_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesPpo_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "PressReleasesListParameters_200_response": { "properties": { "press_releases": { "description": "List of press releases", "items": { "$ref": "#/components/schemas/PressRelease" }, "type": "array", "x-go-name": "PressReleases", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "press_releases", "status" ], "type": "object" }, "GetPrice_200_response": { "properties": { "price": { "description": "Real-time or the latest available price", "examples": [ "200.99001" ], "type": "string", "x-go-name": "Price" } }, "required": [ "price" ], "type": "object" }, "GetPriceTarget_200_response_meta": { "description": "Meta information about the security", "properties": { "symbol": { "description": "Symbol ticker of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 40 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the instrument", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetPriceTarget_200_response_price_target": { "description": "Price target information", "properties": { "high": { "description": "Highest price target given by an analyst", "examples": [ 220 ], "format": "double", "type": "number", "x-go-name": "High", "x-order": 10 }, "median": { "description": "Median price target given across analysts", "examples": [ 185 ], "format": "double", "type": "number", "x-go-name": "Median", "x-order": 20 }, "low": { "description": "Lowest price target given by an analyst", "examples": [ 136 ], "format": "double", "type": "number", "x-go-name": "Low", "x-order": 30 }, "average": { "description": "Average price target given across analysts", "examples": [ 184.01 ], "format": "double", "type": "number", "x-go-name": "Average", "x-order": 40 }, "current": { "description": "Current price from of a security", "examples": [ 169.5672 ], "format": "double", "type": "number", "x-go-name": "Current", "x-order": 50 }, "currency": { "description": "Currency in which the price targets values are quoted", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 60 } }, "required": [ "currency" ], "type": "object", "x-go-name": "PriceTarget", "x-order": 20 }, "GetPriceTarget_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetPriceTarget_200_response_meta" }, "price_target": { "$ref": "#/components/schemas/GetPriceTarget_200_response_price_target" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "price_target", "status" ], "type": "object" }, "GetProfile_200_response": { "properties": { "symbol": { "description": "Ticker of the company", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange name where the company is listed", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market Identifier Code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "sector": { "description": "Sector at which the company operates", "examples": [ "Technology" ], "type": "string", "x-go-name": "Sector", "x-order": 50 }, "industry": { "description": "Industry at which company operates", "examples": [ "Consumer Electronics" ], "type": "string", "x-go-name": "Industry", "x-order": 60 }, "employees": { "description": "Number of employees in the company", "examples": [ 147000 ], "format": "int64", "type": "integer", "x-go-name": "Employees", "x-order": 70 }, "website": { "description": "Website of the company", "examples": [ "http://www.apple.com" ], "type": "string", "x-go-name": "Website", "x-order": 80 }, "description": { "description": "Description of the company activities", "examples": [ "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and..." ], "type": "string", "x-go-name": "Description", "x-order": 90 }, "type": { "description": "Issue type of the stock", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 100 }, "CEO": { "description": "Name of the CEO of the company", "examples": [ "Mr. Timothy D. Cook" ], "type": "string", "x-order": 110 }, "address": { "description": "Street address of the company if presented", "examples": [ "One Apple Park Way" ], "type": "string", "x-go-name": "Address", "x-order": 120 }, "address2": { "description": "Secondary address of the company if presented", "examples": [ "Cupertino, CA 95014" ], "type": "string", "x-go-name": "Address2", "x-order": 130 }, "city": { "description": "City of the company if presented", "examples": [ "Cupertino" ], "type": "string", "x-go-name": "City", "x-order": 140 }, "zip": { "description": "ZIP code of the company if presented", "examples": [ "95014" ], "type": "string", "x-go-name": "Zip", "x-order": 150 }, "state": { "description": "State of the company if presented", "examples": [ "CA" ], "type": "string", "x-go-name": "State", "x-order": 160 }, "country": { "description": "Country of the company if presented", "examples": [ "US" ], "type": "string", "x-go-name": "Country", "x-order": 170 }, "phone": { "description": "Phone number of the company if presented", "examples": [ "408-996-1010" ], "type": "string", "x-go-name": "Phone", "x-order": 180 } }, "required": [ "exchange", "mic_code", "name", "symbol" ], "type": "object" }, "GetQuote_200_response_fifty_two_week": { "description": "Collection of 52-week metrics", "properties": { "low": { "description": "52-week low price", "examples": [ "103.10000" ], "type": "string", "x-go-name": "Low", "x-order": 10 }, "high": { "description": "52-week high price", "examples": [ "157.25999" ], "type": "string", "x-go-name": "High", "x-order": 20 }, "low_change": { "description": "Current price - 52-week low", "examples": [ "45.75001" ], "type": "string", "x-go-name": "LowChange", "x-order": 30 }, "high_change": { "description": "Current price - 52-week high", "examples": [ "-8.40999" ], "type": "string", "x-go-name": "HighChange", "x-order": 40 }, "low_change_percent": { "description": "Percentage change from 52-week low", "examples": [ "44.37440" ], "type": "string", "x-go-name": "LowChangePercent", "x-order": 50 }, "high_change_percent": { "description": "Percentage change from 52-week high", "examples": [ "-5.34782" ], "type": "string", "x-go-name": "HighChangePercent", "x-order": 60 }, "range": { "description": "Range between 52-week low and high", "examples": [ "103.099998 - 157.259995" ], "type": "string", "x-go-name": "Range", "x-order": 70 } }, "type": "object", "x-go-name": "FiftyTwoWeek", "x-order": 220 }, "GetQuote_200_response": { "properties": { "symbol": { "description": "Symbol passed", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard. Available for stocks, ETFs, mutual funds, bonds", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "currency": { "description": "Currency in which the equity is denominated. Available for stocks, ETFs, mutual funds, bonds", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 50 }, "datetime": { "description": "Datetime in defined timezone referring to when the bar with specified interval was opened", "examples": [ "2021-09-16" ], "type": "string", "x-go-name": "Datetime", "x-order": 60 }, "timestamp": { "description": "Unix timestamp representing the opening candle of the specified interval", "examples": [ 1631772000 ], "format": "int64", "type": "integer", "x-go-name": "Timestamp", "x-order": 70 }, "last_quote_at": { "description": "Unix timestamp of last minute candle", "examples": [ 1631772000 ], "format": "int64", "type": "integer", "x-go-name": "LastQuoteAt", "x-order": 80 }, "open": { "description": "Price at the opening of current bar", "examples": [ "148.44000" ], "type": "string", "x-go-name": "Open", "x-order": 90 }, "high": { "description": "Highest price which occurred during the current bar", "examples": [ "148.96840" ], "type": "string", "x-go-name": "High", "x-order": 100 }, "low": { "description": "Lowest price which occurred during the current bar", "examples": [ "147.22099" ], "type": "string", "x-go-name": "Low", "x-order": 110 }, "close": { "description": "Close price at the end of the bar", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 120 }, "volume": { "description": "Trading volume during the bar. Available not for all instrument types", "examples": [ "67903927" ], "type": "string", "x-go-name": "Volume", "x-order": 130 }, "previous_close": { "description": "Close price at the end of the previous bar", "examples": [ "149.09000" ], "type": "string", "x-go-name": "PreviousClose", "x-order": 140 }, "change": { "description": "Close - previous_close", "examples": [ "-0.23999" ], "type": "string", "x-go-name": "Change", "x-order": 150 }, "percent_change": { "description": "(Close - previous_close) / previous_close * 100", "examples": [ "-0.16097" ], "type": "string", "x-go-name": "PercentChange", "x-order": 160 }, "average_volume": { "description": "Average volume of the specified period. Available not for all instrument types", "examples": [ "83571571" ], "type": "string", "x-go-name": "AverageVolume", "x-order": 170 }, "rolling_1d_change": { "description": "Percent change in price between the current and the backward one, where period is 1 day. Available for crypto", "examples": [ "123.123" ], "type": "string", "x-go-name": "RollingOneDayChange", "x-order": 180 }, "rolling_7d_change": { "description": "Percent change in price between the current and the backward one, where period is 7 days. Available for crypto", "examples": [ "123.123" ], "type": "string", "x-go-name": "RollingSevenDayChange", "x-order": 190 }, "rolling_change": { "description": "Percent change in price between the current and the backward one, where period specified in request param rolling_period. Available for crypto", "examples": [ "123.123" ], "type": "string", "x-go-name": "RollingPeriodChange", "x-order": 200 }, "is_market_open": { "description": "True if market is open; false if closed", "examples": [ false ], "type": "boolean", "x-go-name": "IsMarketOpen", "x-order": 210 }, "fifty_two_week": { "$ref": "#/components/schemas/GetQuote_200_response_fifty_two_week" }, "extended_change": { "description": "Diff between the regular close price and the latest extended price. Displayed only if prepost is true", "examples": [ "0.09" ], "type": "string", "x-go-name": "ExtendedChange", "x-order": 230 }, "extended_percent_change": { "description": "Percent change in price between the regular close price and the latest extended price. Displayed only if prepost is true", "examples": [ "0.05" ], "type": "string", "x-go-name": "ExtendedPercentChange", "x-order": 240 }, "extended_price": { "description": "Latest extended price. Displayed only if prepost is true", "examples": [ "125.22" ], "type": "string", "x-go-name": "ExtendedPrice", "x-order": 250 }, "extended_timestamp": { "description": "Unix timestamp of the last extended price. Displayed only if prepost is true", "examples": [ 1649845281 ], "format": "int64", "type": "integer", "x-go-name": "ExtendedTimestamp", "x-order": 260 } }, "required": [ "change", "close", "datetime", "fifty_two_week", "high", "is_market_open", "low", "name", "open", "percent_change", "previous_close", "symbol", "timestamp" ], "type": "object" }, "GetRecommendations_200_response_meta": { "description": "Metadata about the symbol", "properties": { "symbol": { "description": "Symbol ticker of the instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is traded", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 40 }, "exchange": { "description": "Exchange where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 50 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNGS" ], "type": "string", "x-go-name": "MicCode", "x-order": 60 }, "type": { "description": "Type of the instrument", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 70 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetRecommendations_200_response_trends_current_month": { "description": "Current month recommendations", "properties": { "strong_buy": { "description": "Number of analysts that give a strong buy recommendation", "examples": [ 13 ], "format": "int64", "type": "integer", "x-go-name": "StrongBuy", "x-order": 10 }, "buy": { "description": "Number of analysts that give a buy recommendation", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "Buy", "x-order": 20 }, "hold": { "description": "Number of analysts that give a hold recommendation", "examples": [ 8 ], "format": "int64", "type": "integer", "x-go-name": "Hold", "x-order": 30 }, "sell": { "description": "Number of analysts that give a sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "Sell", "x-order": 40 }, "strong_sell": { "description": "Number of analysts that give a strong sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "StrongSell", "x-order": 50 } }, "type": "object", "x-go-name": "CurrentMonth", "x-order": 10 }, "GetRecommendations_200_response_trends_previous_month": { "description": "Previous month recommendations", "properties": { "strong_buy": { "description": "Number of analysts that give a strong buy recommendation", "examples": [ 13 ], "format": "int64", "type": "integer", "x-go-name": "StrongBuy", "x-order": 10 }, "buy": { "description": "Number of analysts that give a buy recommendation", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "Buy", "x-order": 20 }, "hold": { "description": "Number of analysts that give a hold recommendation", "examples": [ 8 ], "format": "int64", "type": "integer", "x-go-name": "Hold", "x-order": 30 }, "sell": { "description": "Number of analysts that give a sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "Sell", "x-order": 40 }, "strong_sell": { "description": "Number of analysts that give a strong sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "StrongSell", "x-order": 50 } }, "type": "object", "x-go-name": "PreviousMonth", "x-order": 20 }, "GetRecommendations_200_response_trends_2_months_ago": { "description": "Two months ago recommendations", "properties": { "strong_buy": { "description": "Number of analysts that give a strong buy recommendation", "examples": [ 13 ], "format": "int64", "type": "integer", "x-go-name": "StrongBuy", "x-order": 10 }, "buy": { "description": "Number of analysts that give a buy recommendation", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "Buy", "x-order": 20 }, "hold": { "description": "Number of analysts that give a hold recommendation", "examples": [ 8 ], "format": "int64", "type": "integer", "x-go-name": "Hold", "x-order": 30 }, "sell": { "description": "Number of analysts that give a sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "Sell", "x-order": 40 }, "strong_sell": { "description": "Number of analysts that give a strong sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "StrongSell", "x-order": 50 } }, "type": "object", "x-go-name": "TwoMonthsAgo", "x-order": 30 }, "GetRecommendations_200_response_trends_3_months_ago": { "description": "Three months ago recommendations", "properties": { "strong_buy": { "description": "Number of analysts that give a strong buy recommendation", "examples": [ 13 ], "format": "int64", "type": "integer", "x-go-name": "StrongBuy", "x-order": 10 }, "buy": { "description": "Number of analysts that give a buy recommendation", "examples": [ 20 ], "format": "int64", "type": "integer", "x-go-name": "Buy", "x-order": 20 }, "hold": { "description": "Number of analysts that give a hold recommendation", "examples": [ 8 ], "format": "int64", "type": "integer", "x-go-name": "Hold", "x-order": 30 }, "sell": { "description": "Number of analysts that give a sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "Sell", "x-order": 40 }, "strong_sell": { "description": "Number of analysts that give a strong sell recommendation", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "StrongSell", "x-order": 50 } }, "type": "object", "x-go-name": "ThreeMonthsAgo", "x-order": 40 }, "GetRecommendations_200_response_trends": { "description": "Analyst recommendations trends", "properties": { "current_month": { "$ref": "#/components/schemas/GetRecommendations_200_response_trends_current_month" }, "previous_month": { "$ref": "#/components/schemas/GetRecommendations_200_response_trends_previous_month" }, "2_months_ago": { "$ref": "#/components/schemas/GetRecommendations_200_response_trends_2_months_ago" }, "3_months_ago": { "$ref": "#/components/schemas/GetRecommendations_200_response_trends_3_months_ago" } }, "type": "object", "x-go-name": "Trends", "x-order": 20 }, "GetRecommendations_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetRecommendations_200_response_meta" }, "trends": { "$ref": "#/components/schemas/GetRecommendations_200_response_trends" }, "rating": { "description": "Rating from 0 to 10 represents overall analysts' recommendation. 0 to 2 - strong sell, 2 to 4 - sell, 4 to 6 - hold, 6 to 8 - buy, 8 to 10 - strong buy.", "examples": [ 8.2 ], "format": "double", "type": "number", "x-go-name": "Rating", "x-order": 30 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 40 } }, "required": [ "meta", "status", "trends" ], "type": "object" }, "GetRevenueEstimate_200_response_revenue_estimate_inner": { "properties": { "date": { "description": "Date of the estimate", "examples": [ "2022-09-30" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "period": { "description": "Period of estimation, can be `current_quarter`, `next_quarter`, `current_year`, or `next_year`", "examples": [ "current_quarter" ], "type": "string", "x-go-name": "Period", "x-order": 20 }, "number_of_analysts": { "description": "Number of analysts that made the estimation", "examples": [ 24 ], "format": "int64", "type": "integer", "x-go-name": "NumberOfAnalysts", "x-order": 30 }, "avg_estimate": { "description": "Average estimation across analysts", "examples": [ 88631500000 ], "format": "double", "type": "number", "x-go-name": "AvgEstimate", "x-order": 40 }, "low_estimate": { "description": "Lowest estimation given by an analyst", "examples": [ 85144300000 ], "format": "double", "type": "number", "x-go-name": "LowEstimate", "x-order": 50 }, "high_estimate": { "description": "Highest estimation given by an analyst", "examples": [ 92794900000 ], "format": "double", "type": "number", "x-go-name": "HighEstimate", "x-order": 60 }, "year_ago_sales": { "description": "Total revenue received a year ago relative to period", "examples": [ 83360000000 ], "format": "double", "type": "number", "x-go-name": "YearAgoSales", "x-order": 70 }, "sales_growth": { "description": "Estimated sales growth of the period in relation to year-ago sales in prc (%)", "examples": [ 0.06 ], "format": "double", "type": "number", "x-go-name": "SalesGrowth", "x-order": 80 } }, "type": "object" }, "GetRevenueEstimate_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetEarningsEstimate_200_response_meta" }, "revenue_estimate": { "description": "Revenue estimate data", "items": { "$ref": "#/components/schemas/GetRevenueEstimate_200_response_revenue_estimate_inner" }, "type": "array", "x-go-name": "RevenueEstimate", "x-order": 20 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "revenue_estimate", "status" ], "type": "object" }, "GetTimeSeriesRoc_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ROC - Rate of change" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRoc_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRoc_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRoc_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "roc": { "description": "roc value", "examples": [ "-0.56383" ], "type": "string", "x-go-name": "Roc", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "roc" ], "type": "object" }, "GetTimeSeriesRoc_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRoc_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRoc_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesRocp_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ROCP - Rate of change percentage" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRocp_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRocp_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRocp_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "rocp": { "description": "ROCP value", "examples": [ "-0.00564" ], "type": "string", "x-go-name": "Rocp", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "rocp" ], "type": "object" }, "GetTimeSeriesRocp_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRocp_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRocp_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesRocr_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ROCR - Rate of change ratio" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "Number of periods to average over", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRocr_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRocr_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRocr_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "rocr": { "description": "ROCR value", "examples": [ "0.99436" ], "type": "string", "x-go-name": "Rocr", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "rocr" ], "type": "object" }, "GetTimeSeriesRocr_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRocr_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRocr_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesRocr100_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ROCR100 - Rate of change ratio 100 scale" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRocr100_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRocr100_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRocr100_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "rocr100": { "description": "rocr100 value", "examples": [ "99.43617" ], "type": "string", "x-go-name": "Rocr100", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "rocr100" ], "type": "object" }, "GetTimeSeriesRocr100_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRocr100_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRocr100_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesRsi_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "RSI - Relative Strength Index" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRsi_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRsi_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRsi_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "rsi": { "description": "RSI value", "examples": [ "16.57887" ], "type": "string", "x-go-name": "Rsi", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "rsi" ], "type": "object" }, "GetTimeSeriesRsi_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRsi_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRsi_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesRvol_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "RVOL - Relative Volume Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesRvol_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesRvol_200_response_meta_indicator" } } } ] }, "GetTimeSeriesRvol_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "rvol": { "description": "RVOL value", "examples": [ "2.9054" ], "type": "string", "x-go-name": "Rvol", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "rvol" ], "type": "object" }, "GetTimeSeriesRvol_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesRvol_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesRvol_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetSourceSanctionedEntities_200_response": { "properties": { "sanctions": { "description": "List of sanctioned entities", "items": { "$ref": "#/components/schemas/ResponseSanctionedEntitiy" }, "type": "array", "x-go-name": "Sanctions", "x-order": 10 }, "count": { "description": "Total number of sanctioned entities", "examples": [ 143 ], "format": "int64", "type": "integer", "x-go-name": "Count", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "count", "sanctions", "status" ], "type": "object" }, "GetTimeSeriesSar_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SAR - Parabolic SAR" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "acceleration": { "description": "The acceleration factor used in the indicator calculation", "examples": [ 0.02 ], "format": "double", "type": "number", "x-go-name": "Acceleration", "x-order": 20 }, "maximum": { "description": "The maximum value considered for the indicator calculation", "examples": [ 0.2 ], "format": "double", "type": "number", "x-go-name": "Maximum", "x-order": 30 } }, "required": [ "acceleration", "maximum", "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSar_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSar_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSar_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sar": { "description": "SAR value", "examples": [ "201.54365" ], "type": "string", "x-go-name": "Sar", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sar" ], "type": "object" }, "GetTimeSeriesSar_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSar_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSar_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesSarExt_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SAREXT - Parabolic SAR Extended" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "start_value": { "description": "The initial value for the indicator calculation", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "StartValue", "x-order": 20 }, "offset_on_reverse": { "description": "The adjustment applied when the indicator's direction changes", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "OffsetOnReverse", "x-order": 30 }, "acceleration_limit_long": { "description": "The maximum acceleration value for long positions", "examples": [ 0.02 ], "format": "double", "type": "number", "x-go-name": "AccelerationLimitLong", "x-order": 40 }, "acceleration_long": { "description": "The acceleration value for long positions", "examples": [ 0.02 ], "format": "double", "type": "number", "x-go-name": "AccelerationLong", "x-order": 50 }, "acceleration_max_long": { "description": "The highest allowed acceleration for long positions", "examples": [ 0.2 ], "format": "double", "type": "number", "x-go-name": "AccelerationMaxLong", "x-order": 60 }, "acceleration_limit_short": { "description": "The maximum acceleration value for short positions", "examples": [ 0.02 ], "format": "double", "type": "number", "x-go-name": "AccelerationLimitShort", "x-order": 70 }, "acceleration_short": { "description": "The acceleration value for short positions", "examples": [ 0.02 ], "format": "double", "type": "number", "x-go-name": "AccelerationShort", "x-order": 80 }, "acceleration_max_short": { "description": "The highest allowed acceleration for short positions", "examples": [ 0.2 ], "format": "double", "type": "number", "x-go-name": "AccelerationMaxShort", "x-order": 90 } }, "required": [ "acceleration_limit_long", "acceleration_limit_short", "acceleration_long", "acceleration_max_long", "acceleration_max_short", "acceleration_short", "name", "offset_on_reverse", "start_value" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSarExt_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSarExt_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSarExt_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-04-02" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sarext": { "description": "SAREXT value", "examples": [ "214.059460" ], "type": "string", "x-go-name": "SarExt", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sarext" ], "type": "object" }, "GetTimeSeriesSarExt_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSarExt_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSarExt_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesSma_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SMA - Simple Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSma_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSma_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSma_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sma": { "description": "SMA value", "examples": [ "201.41205" ], "type": "string", "x-go-name": "Sma", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sma" ], "type": "object" }, "GetTimeSeriesSma_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSma_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSma_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetSplits_200_response_meta": { "description": "Metadata about the instrument", "properties": { "symbol": { "description": "Ticker symbol of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the instrument", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency in which the instrument is denominated", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta" }, "GetSplits_200_response_splits_inner": { "properties": { "date": { "description": "Stands for the split date", "examples": [ "2020-08-31" ], "type": "string", "x-go-name": "Date", "x-order": 10 }, "description": { "description": "Specification of the split event", "examples": [ "4-for-1 split" ], "type": "string", "x-go-name": "Description", "x-order": 20 }, "ratio": { "description": "The ratio by which the number of a company's outstanding shares of stock are increased following a stock split. For example, a `4-for-1 split` results in four times as many outstanding shares, with each share selling at one forth of its pre-split price", "examples": [ 0.25 ], "format": "double", "type": "number", "x-go-name": "Ratio", "x-order": 30 }, "from_factor": { "description": "From factor of the split", "examples": [ 4 ], "format": "double", "type": "number", "x-go-name": "FromFactor", "x-order": 40 }, "to_factor": { "description": "To factor of the split", "examples": [ 1 ], "format": "double", "type": "number", "x-go-name": "ToFactor", "x-order": 50 } }, "required": [ "date", "description", "from_factor", "ratio", "to_factor" ], "type": "object" }, "GetSplits_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetSplits_200_response_meta" }, "splits": { "description": "List of stock splits", "items": { "$ref": "#/components/schemas/GetSplits_200_response_splits_inner" }, "type": "array", "x-go-name": "Splits" } }, "required": [ "meta", "splits" ], "type": "object" }, "GetTimeSeriesSqrt_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SQRT - Square Root" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSqrt_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSqrt_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSqrt_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sqrt": { "description": "SQRT value", "examples": [ "14.17921" ], "type": "string", "x-go-name": "Sqrt", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sqrt" ], "type": "object" }, "GetTimeSeriesSqrt_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSqrt_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSqrt_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetStatistics_200_response_meta": { "description": "Json object with request general information", "properties": { "symbol": { "description": "Symbol ticker of instrument", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "Name of the company", "examples": [ "Apple Inc" ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "currency": { "description": "Currency of the instrument", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange": { "description": "Exchange where instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 40 }, "mic_code": { "description": "Market identifier code (MIC) under ISO 10383 standard", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 50 }, "exchange_timezone": { "description": "Timezone of the exchange", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 } }, "required": [ "currency", "exchange", "exchange_timezone", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetStatistics_200_response_statistics_valuations_metrics": { "description": "Valuation metrics of the company", "properties": { "market_capitalization": { "description": "Refers to the market value of the company's outstanding shares", "examples": [ 2546807865344 ], "format": "double", "type": "number", "x-go-name": "MarketCapitalization", "x-order": 10 }, "enterprise_value": { "description": "Refers to enterprise value (EV) of the company, often used as a more comprehensive alternative to market capitalization", "examples": [ 2620597731328 ], "format": "double", "type": "number", "x-go-name": "EnterpriseValue", "x-order": 20 }, "trailing_pe": { "description": "Refers to the trailing price-to-earnings (P/E). It is calculated by taking the current stock price and dividing it by the trailing earnings per share (EPS) for the past 12 months", "examples": [ 30.162493 ], "format": "double", "type": "number", "x-go-name": "TrailingPe", "x-order": 30 }, "forward_pe": { "description": "Refers to the forward price-to-earnings ratio. It is calculated by dividing the current share price by the estimated future earnings per share", "examples": [ 26.982489 ], "format": "double", "type": "number", "x-go-name": "ForwardPe", "x-order": 40 }, "peg_ratio": { "description": "The price/earnings to growth (PEG) ratio is a price-to-earnings ratio divided by the growth rate of the earnings", "examples": [ 1.4 ], "format": "double", "type": "number", "x-go-name": "PegRatio", "x-order": 50 }, "price_to_sales_ttm": { "description": "The price-to-sales (P/S) ratio is a valuation ratio that compares the market capitalization to its revenues over the last 12 months", "examples": [ 7.336227 ], "format": "double", "type": "number", "x-go-name": "PriceToSalesTtm", "x-order": 60 }, "price_to_book_mrq": { "description": "The price-to-book (P/B) ratio is equal to the current share price divided by the book value of all shares (BVPS) over the last quarter", "examples": [ 39.68831 ], "format": "double", "type": "number", "x-go-name": "PriceToBookMrq", "x-order": 70 }, "enterprise_to_revenue": { "description": "The enterprise value-to-revenue multiple (EV/R) is a measure that compares enterprise value to revenue", "examples": [ 7.549 ], "format": "double", "type": "number", "x-go-name": "EnterpriseToRevenue", "x-order": 80 }, "enterprise_to_ebitda": { "description": "The enterprise value-to-ebitda multiple (EV/EBITDA) is a measure that compares enterprise value to EBITDA", "examples": [ 23.623 ], "format": "double", "type": "number", "x-go-name": "EnterpriseToEbitda", "x-order": 90 } }, "type": "object", "x-go-name": "ValuationsMetrics", "x-order": 10 }, "GetStatistics_200_response_statistics_financials_income_statement": { "description": "Income statement information", "properties": { "revenue_ttm": { "description": "Refers to total revenue over the last 12 months", "examples": [ 347155005440 ], "format": "double", "type": "number", "x-go-name": "RevenueTtm", "x-order": 10 }, "revenue_per_share_ttm": { "description": "Refers to revenue per share over the last 12 months", "examples": [ 20.61 ], "format": "double", "type": "number", "x-go-name": "RevenuePerShareTtm", "x-order": 20 }, "quarterly_revenue_growth": { "description": "Refers to quarterly revenue growth year over year", "examples": [ 0.364 ], "format": "double", "type": "number", "x-go-name": "QuarterlyRevenueGrowth", "x-order": 30 }, "gross_profit_ttm": { "description": "Refers to gross profit over the last 12 months", "examples": [ 104956000000 ], "format": "double", "type": "number", "x-go-name": "GrossProfitTtm", "x-order": 40 }, "ebitda": { "description": "Refers to EBITDA (earnings before interest, taxes, depreciation, and amortization) measure; EBITDA is not calculated for banks", "examples": [ 110934999040 ], "format": "double", "type": "number", "x-go-name": "Ebitda", "x-order": 50 }, "net_income_to_common_ttm": { "description": "Refers to net income applicable to common shares over the last 12 months", "examples": [ 86801997824 ], "format": "double", "type": "number", "x-go-name": "NetIncomeToCommonTtm", "x-order": 60 }, "diluted_eps_ttm": { "description": "Refers to diluted EPS measure over the last 12 months", "examples": [ 5.108 ], "format": "double", "type": "number", "x-go-name": "DilutedEpsTtm", "x-order": 70 }, "quarterly_earnings_growth_yoy": { "description": "Refers to quarterly earnings growth year over year", "examples": [ 0.932 ], "format": "double", "type": "number", "x-go-name": "QuarterlyEarningsGrowthYoy", "x-order": 80 } }, "type": "object", "x-go-name": "IncomeStatement", "x-order": 70 }, "GetStatistics_200_response_statistics_financials_balance_sheet": { "description": "Balance sheet information", "properties": { "total_cash_mrq": { "description": "Refers to total cash measure for the most recent quarter", "examples": [ 61696000000 ], "format": "double", "type": "number", "x-go-name": "TotalCashMrq", "x-order": 20 }, "total_cash_per_share_mrq": { "description": "Refers to total cash per share measure for the most recent quarter", "examples": [ 3.732 ], "format": "double", "type": "number", "x-go-name": "TotalCashPerShareMrq", "x-order": 30 }, "total_debt_mrq": { "description": "Refers to total debt measure for the most recent quarter", "examples": [ 135491002368 ], "format": "double", "type": "number", "x-go-name": "TotalDebtMrq", "x-order": 40 }, "total_debt_to_equity_mrq": { "description": "Refers to total debt to equity measure for the most recent quarter", "examples": [ 210.782 ], "format": "double", "type": "number", "x-go-name": "TotalDebtToEquityMrq", "x-order": 50 }, "current_ratio_mrq": { "description": "Refers to current ratio (total assets / total liabilities) ratio for the most recent quarter", "examples": [ 1.062 ], "format": "double", "type": "number", "x-go-name": "CurrentRatioMrq", "x-order": 60 }, "book_value_per_share_mrq": { "description": "Refers to book value per share (BVPS) ratio for the most recent quarter", "examples": [ 3.882 ], "format": "double", "type": "number", "x-go-name": "BookValuePerShareMrq", "x-order": 70 } }, "type": "object", "x-go-name": "BalanceSheet", "x-order": 80 }, "GetStatistics_200_response_statistics_financials_cash_flow": { "description": "Cash flow information", "properties": { "operating_cash_flow_ttm": { "description": "Refers to operating cash flow measure over the last 12 months", "examples": [ 104414003200 ], "format": "double", "type": "number", "x-go-name": "OperatingCashFlowTtm", "x-order": 10 }, "levered_free_cash_flow_ttm": { "description": "Refers to levered free cash flow measure over the last 12 months", "examples": [ 80625876992 ], "format": "double", "type": "number", "x-go-name": "LeveredFreeCashFlowTtm", "x-order": 20 } }, "type": "object", "x-go-name": "CashFlow", "x-order": 90 }, "GetStatistics_200_response_statistics_financials": { "description": "Financial information of the company", "properties": { "fiscal_year_ends": { "description": "Refers to the completion of the last 12-month accounting period", "examples": [ "2020-09-26" ], "type": "string", "x-go-name": "FiscalYearEnds", "x-order": 10 }, "most_recent_quarter": { "description": "The most recent quarter (MRQ) refers to the fiscal quarter that most recently ended", "examples": [ "2021-06-26" ], "type": "string", "x-go-name": "MostRecentQuarter", "x-order": 20 }, "gross_margin": { "description": "The portion of a company's revenue left over after direct costs are subtracted", "examples": [ 46.57807 ], "format": "double", "type": "number", "x-go-name": "GrossMargin", "x-order": 25 }, "profit_margin": { "description": "Refers to gross profit margin. Calculated by dividing net income by sales revenue", "examples": [ 0.25004 ], "format": "double", "type": "number", "x-go-name": "ProfitMargin", "x-order": 30 }, "operating_margin": { "description": "Operating margin is calculated by dividing operating income by net sales", "examples": [ 0.28788 ], "format": "double", "type": "number", "x-go-name": "OperatingMargin", "x-order": 40 }, "return_on_assets_ttm": { "description": "Return on assets (ROA) is calculated by dividing net income by total assets", "examples": [ 0.19302 ], "format": "double", "type": "number", "x-go-name": "ReturnOnAssetsTtm", "x-order": 50 }, "return_on_equity_ttm": { "description": "Return on equity (ROE) is calculated by dividing net income by average shareholders' equity", "examples": [ 1.27125 ], "format": "double", "type": "number", "x-go-name": "ReturnOnEquityTtm", "x-order": 60 }, "income_statement": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_financials_income_statement" }, "balance_sheet": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_financials_balance_sheet" }, "cash_flow": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_financials_cash_flow" } }, "type": "object", "x-go-name": "Financials", "x-order": 20 }, "GetStatistics_200_response_statistics_stock_statistics": { "description": "Stock statistics of the company", "properties": { "shares_outstanding": { "description": "Refers for the shares outstanding currently held by all its shareholders", "examples": [ 16530199552 ], "format": "double", "type": "number", "x-go-name": "SharesOutstanding", "x-order": 10 }, "float_shares": { "description": "Refers to floating stock is the number of public shares a company has available for trading on the open market", "examples": [ 16513305231 ], "format": "double", "type": "number", "x-go-name": "FloatShares", "x-order": 20 }, "avg_10_volume": { "description": "Refers to the average 10 days volume", "examples": [ 72804757 ], "format": "int64", "type": "integer", "x-go-name": "Avg10Volume", "x-order": 30 }, "avg_90_volume": { "description": "Refers to the average 90 days volume", "examples": [ 77013078 ], "format": "int64", "type": "integer", "x-go-name": "Avg90Volume", "x-order": 40 }, "shares_short": { "description": "Refers to the number of shares that have been shorted", "examples": [ 93105968 ], "format": "int64", "type": "integer", "x-go-name": "SharesShort", "x-order": 50 }, "short_ratio": { "description": "Refers to short ratio measure", "examples": [ 1.19 ], "format": "double", "type": "number", "x-go-name": "ShortRatio", "x-order": 60 }, "short_percent_of_shares_outstanding": { "description": "Refers to the number of shorted shares divided by the number of shares outstanding", "examples": [ 0.0056 ], "format": "double", "type": "number", "x-go-name": "ShortPercentOfSharesOutstanding", "x-order": 70 }, "percent_held_by_insiders": { "description": "Refers to the percentage of shares held by the company insiders", "examples": [ 0.00071000005 ], "format": "double", "type": "number", "x-go-name": "PercentHeldByInsiders", "x-order": 80 }, "percent_held_by_institutions": { "description": "Refers to the percentage of shares held by the institutions", "examples": [ 0.58474 ], "format": "double", "type": "number", "x-go-name": "PercentHeldByInstitutions", "x-order": 90 } }, "type": "object", "x-go-name": "StockStatistics", "x-order": 30 }, "GetStatistics_200_response_statistics_stock_price_summary": { "description": "Stock price summary of the company", "properties": { "fifty_two_week_low": { "description": "Refers to the lowest price at which stock traded during a year", "examples": [ 103.1 ], "format": "double", "type": "number", "x-go-name": "FiftyTwoWeekLow", "x-order": 10 }, "fifty_two_week_high": { "description": "Refers to the highest price at which stock traded during a year", "examples": [ 157.26 ], "format": "double", "type": "number", "x-go-name": "FiftyTwoWeekHigh", "x-order": 20 }, "fifty_two_week_change": { "description": "Refers to the change between lowest and highest prices during a year", "examples": [ 0.375625 ], "format": "double", "type": "number", "x-go-name": "FiftyTwoWeekChange", "x-order": 30 }, "beta": { "description": "Refers to beta measure relative to the primary benchmark (index) of the country", "examples": [ 1.201965 ], "format": "double", "type": "number", "x-go-name": "Beta", "x-order": 40 }, "day_50_ma": { "description": "Refers to the 50-day simple moving average", "examples": [ 148.96686 ], "format": "double", "type": "number", "x-go-name": "Day50Ma", "x-order": 50 }, "day_200_ma": { "description": "Refers to the 200-day simple moving average", "examples": [ 134.42506 ], "format": "double", "type": "number", "x-go-name": "Day200Ma", "x-order": 60 } }, "type": "object", "x-go-name": "StockPriceSummary", "x-order": 40 }, "GetStatistics_200_response_statistics_dividends_and_splits": { "description": "Dividends and splits information of the company", "properties": { "forward_annual_dividend_rate": { "description": "Refers to the forward dividend yield estimation in the currency of instrument", "examples": [ 0.88 ], "format": "double", "type": "number", "x-go-name": "ForwardAnnualDividendRate", "x-order": 10 }, "forward_annual_dividend_yield": { "description": "Refers to the forward dividend yield percentage relative to stock price", "examples": [ 0.0057 ], "format": "double", "type": "number", "x-go-name": "ForwardAnnualDividendYield", "x-order": 20 }, "trailing_annual_dividend_rate": { "description": "Refers to the trailing dividend yield rate in the currency of instrument over the last 12 months", "examples": [ 0.835 ], "format": "double", "type": "number", "x-go-name": "TrailingAnnualDividendRate", "x-order": 30 }, "trailing_annual_dividend_yield": { "description": "Refers to the trailing dividend yield percentage relative to stock price", "examples": [ 0.0053832764 ], "format": "double", "type": "number", "x-go-name": "TrailingAnnualDividendYield", "x-order": 40 }, "5_year_average_dividend_yield": { "description": "Refers to the average 5 years dividend yield", "examples": [ 1.27 ], "format": "double", "type": "number", "x-go-name": "FiveYearAverageDividendYield", "x-order": 50 }, "payout_ratio": { "description": "Refers to payout ratio, showing the proportion of earnings a company pays its shareholders in the form of dividends", "examples": [ 0.16309999 ], "format": "double", "type": "number", "x-go-name": "PayoutRatio", "x-order": 60 }, "dividend_frequency": { "description": "Refers to how often a stock or fund pays dividends", "examples": [ "Quarterly" ], "type": "string", "x-go-name": "DividendFrequency", "x-order": 65 }, "dividend_date": { "description": "Refers to the last dividend payout date", "examples": [ "2021-08-12" ], "type": "string", "x-go-name": "DividendDate", "x-order": 70 }, "ex_dividend_date": { "description": "Refers to the last ex-dividend payout date", "examples": [ "2021-08-06" ], "type": "string", "x-go-name": "ExDividendDate", "x-order": 80 }, "last_split_factor": { "description": "Specification of the last split event", "examples": [ "4-for-1 split" ], "type": "string", "x-go-name": "LastSplitFactor", "x-order": 90 }, "last_split_date": { "description": "Refers for the last split date", "examples": [ "2020-08-31" ], "type": "string", "x-go-name": "LastSplitDate", "x-order": 100 } }, "type": "object", "x-go-name": "DividendsAndSplits", "x-order": 50 }, "GetStatistics_200_response_statistics": { "description": "Statistics of the company", "properties": { "valuations_metrics": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_valuations_metrics" }, "financials": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_financials" }, "stock_statistics": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_stock_statistics" }, "stock_price_summary": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_stock_price_summary" }, "dividends_and_splits": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics_dividends_and_splits" } }, "type": "object", "x-go-name": "Statistics", "x-order": 20 }, "GetStatistics_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetStatistics_200_response_meta" }, "statistics": { "$ref": "#/components/schemas/GetStatistics_200_response_statistics" } }, "required": [ "meta", "statistics" ], "type": "object" }, "GetTimeSeriesStdDev_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "STDDEV - Standard Deviation" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "sd": { "description": "The standard deviation applied in the calculation", "examples": [ 2 ], "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": 40 } }, "required": [ "name", "sd", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesStdDev_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesStdDev_200_response_meta_indicator" } } } ] }, "GetTimeSeriesStdDev_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "stddev": { "description": "Standard Deviation value", "examples": [ "0.86613" ], "type": "string", "x-go-name": "StdDev", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "stddev" ], "type": "object" }, "GetTimeSeriesStdDev_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesStdDev_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesStdDev_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesStoch_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "STOCH - Stochastic Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 5 }, "fast_k_period": { "description": "The time period for the fast %K line in the Stochastic Oscillator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": 10 }, "slow_k_period": { "description": "The time period for the slow %K line in the Stochastic Oscillator", "examples": [ 1 ], "format": "int64", "type": "integer", "x-go-name": "SlowKPeriod", "x-order": 20 }, "slow_d_period": { "description": "The time period for the slow %D line in the Stochastic Oscillator", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "SlowDPeriod", "x-order": 30 }, "slow_kma_type": { "description": "The type of slow %K Moving Average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "SlowKMAType", "x-order": 40 }, "slow_dma_type": { "description": "The type of slow Displaced Moving Average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "SlowDMAType", "x-order": 50 } }, "required": [ "fast_k_period", "name", "slow_d_period", "slow_dma_type", "slow_k_period", "slow_kma_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesStoch_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesStoch_200_response_meta_indicator" } } } ] }, "GetTimeSeriesStoch_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "slow_k": { "description": "slow_k value", "examples": [ "11.35168" ], "type": "string", "x-go-name": "SlowK", "x-order": 20 }, "slow_d": { "description": "slow_d value", "examples": [ "7.5293" ], "type": "string", "x-go-name": "SlowD", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "slow_d", "slow_k" ], "type": "object" }, "GetTimeSeriesStoch_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesStoch_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesStoch_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesStochF_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "STOCHF - Stochastic Fast" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "fast_k_period": { "description": "The fast_k period used for calculation in the indicator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": 20 }, "fast_d_period": { "description": "The fast_d period used for calculation in the indicator", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "FastDPeriod", "x-order": 30 }, "fast_dma_type": { "description": "The type of fast Displaced Moving Average used", "examples": [ "SMA" ], "type": "string", "x-go-name": "FastDMAType", "x-order": 40 } }, "required": [ "fast_d_period", "fast_dma_type", "fast_k_period", "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesStochF_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesStochF_200_response_meta_indicator" } } } ] }, "GetTimeSeriesStochF_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "fast_k": { "description": "fast_k value", "examples": [ "11.35168" ], "type": "string", "x-go-name": "FastK", "x-order": 20 }, "fast_d": { "description": "fast_d value", "examples": [ "7.5293" ], "type": "string", "x-go-name": "FastD", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "fast_d", "fast_k" ], "type": "object" }, "GetTimeSeriesStochF_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesStochF_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesStochF_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesStochRsi_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "STOCHRSI - Stochastic RSI" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "rsi_length": { "description": "Length of period for calculating the RSI component", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "stoch_length": { "description": "Period length for computing the stochastic oscillator of the RSI", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "FastKPeriod", "x-order": 40 }, "k_period": { "description": "Period for smoothing the %K line", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "SlowKPeriod", "x-order": 50 }, "d_period": { "description": "Period for smoothing the %D line, which is a moving average of %K", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "SlowDPeriod", "x-order": 60 } }, "required": [ "d_period", "k_period", "name", "rsi_length", "series_type", "stoch_length" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesStochRsi_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesStochRsi_200_response_meta_indicator" } } } ] }, "GetTimeSeriesStochRsi_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "k": { "description": "K value", "examples": [ "100.0" ], "type": "string", "x-go-name": "K", "x-order": 20 }, "d": { "description": "D value", "examples": [ "33.33333" ], "type": "string", "x-go-name": "D", "x-order": 30 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "d", "datetime", "k" ], "type": "object" }, "GetTimeSeriesStochRsi_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesStochRsi_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesStochRsi_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetStocks_200_response": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of stock instruments", "items": { "$ref": "#/components/schemas/StocksResponseItem" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "GetTimeSeriesSub_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SUB - Arithmetic Subtraction" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type_1": { "description": "First price data type on which technical indicator is calculated", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType1", "x-order": 20 }, "series_type_2": { "description": "Second price data type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType2", "x-order": 30 } }, "required": [ "name", "series_type_1", "series_type_2" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSub_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSub_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSub_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sub": { "description": "SUB value", "examples": [ "0.404" ], "type": "string", "x-go-name": "Sub", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sub" ], "type": "object" }, "GetTimeSeriesSub_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSub_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSub_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesSum_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SUM - Summation" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSum_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSum_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSum_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sum": { "description": "Sum value", "examples": [ "1812.70842" ], "type": "string", "x-go-name": "Sum", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sum" ], "type": "object" }, "GetTimeSeriesSum_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSum_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSum_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesSuperTrend_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SUPERTREND - SuperTrend Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "period": { "description": "The period used for calculation in the indicator", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "Period", "x-order": 20 }, "multiplier": { "description": "The factor used to adjust the indicator's sensitivity", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": 30 } }, "required": [ "multiplier", "name", "period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSuperTrend_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrend_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSuperTrend_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "supertrend": { "description": "SuperTrend value", "examples": [ "201.56432" ], "type": "string", "x-go-name": "SuperTrend", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "supertrend" ], "type": "object" }, "GetTimeSeriesSuperTrend_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrend_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrend_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SUPERTREND_HEIKINASHICANDLES - SuperTrendHeikinAshiCandles Indicator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "period": { "description": "The period used for calculation in the indicator", "examples": [ 10 ], "format": "int64", "type": "integer", "x-go-name": "Period", "x-order": 20 }, "multiplier": { "description": "The multiplier used for calculation in the indicator", "examples": [ 3 ], "format": "int64", "type": "integer", "x-go-name": "Multiplier", "x-order": 30 } }, "required": [ "multiplier", "name", "period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_meta_indicator" } } } ] }, "GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 5 }, "supertrend": { "description": "SuperTrend value", "examples": [ "201.66713" ], "type": "string", "x-go-name": "SuperTrend", "x-order": 10 }, "heikinhighs": { "description": "Heikin-Ashi high values", "examples": [ "201.25599" ], "type": "string", "x-go-name": "HeikinHigh", "x-order": 20 }, "heikinopens": { "description": "Heikin-Ashi open values", "examples": [ "200.9825" ], "type": "string", "x-go-name": "HeikinOpen", "x-order": 30 }, "heikincloses": { "description": "Heikin-Ashi close values", "examples": [ "201.02449" ], "type": "string", "x-go-name": "HeikinClose", "x-order": 40 }, "heikinlows": { "description": "Heikin-Ashi low values", "examples": [ "200.85199" ], "type": "string", "x-go-name": "HeikinLow", "x-order": 50 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "heikincloses", "heikinhighs", "heikinlows", "heikinopens", "supertrend" ], "type": "object" }, "GetTimeSeriesSuperTrendHeikinAshiCandles_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetSymbolSearch_200_response": { "properties": { "data": { "description": "List of symbols matching the search criteria", "items": { "$ref": "#/components/schemas/SymbolSearchResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 }, "status": { "description": "Status of the response", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 20 } }, "required": [ "data", "status" ], "type": "object" }, "GetTimeSeriesT3ma_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "T3MA - Triple Exponential Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 }, "v_factor": { "description": "The factor used to adjust the indicator's volatility", "examples": [ 0.7 ], "format": "double", "type": "number", "x-go-name": "VFactor", "x-order": 40 } }, "required": [ "name", "series_type", "time_period", "v_factor" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesT3ma_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesT3ma_200_response_meta_indicator" } } } ] }, "GetTimeSeriesT3ma_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "t3ma": { "description": "T3MA value", "examples": [ "201.56277" ], "type": "string", "x-go-name": "T3ma", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "t3ma" ], "type": "object" }, "GetTimeSeriesT3ma_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesT3ma_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesT3ma_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTaxInfo_200_response_meta": { "description": "Metadata about the requested instrument", "properties": { "symbol": { "description": "The ticker symbol of an instrument for which data was requested", "examples": [ "SKYQ" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "name": { "description": "The instrument name", "examples": [ "Sky Quarry Inc." ], "type": "string", "x-go-name": "Name", "x-order": 20 }, "exchange": { "description": "The exchange name where the instrument is traded", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 30 }, "mic_code": { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded", "examples": [ "XNCM" ], "type": "string", "x-go-name": "MicCode", "x-order": 40 }, "country": { "description": "The instrument country name", "examples": [ "United States" ], "type": "string", "x-go-name": "Country", "x-order": 50 } }, "required": [ "country", "exchange", "mic_code", "name", "symbol" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetTaxInfo_200_response_data": { "description": "Tax information data containing the tax indicator for the requested instrument", "properties": { "tax_indicator": { "description": "The instrument tax indicator, can be `null`, `us_1446f`, `spanish_ftt`, `uk_stamp_duty`, `hk_stamp_duty`, `french_ftt` or `italian_ftt`", "examples": [ "us_1446f" ], "type": "string", "x-go-name": "TaxIndicator", "x-order": 10 } }, "required": [ "tax_indicator" ], "type": "object", "x-go-name": "Data", "x-order": 20 }, "GetTaxInfo_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTaxInfo_200_response_meta" }, "data": { "$ref": "#/components/schemas/GetTaxInfo_200_response_data" }, "status": { "description": "The status of the request, e.g., `ok`, `error`", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "data", "meta", "status" ], "type": "object" }, "GetTechnicalIndicators_200_response_data_value": { "properties": { "enable": { "description": "If the indicator is tested, approved and is recommended for use returns true, otherwise returns false", "examples": [ true ], "type": "boolean", "x-go-name": "Enable", "x-order": 10 }, "full_name": { "description": "Full indicator name", "examples": [ "Moving Average Convergence Divergence" ], "type": "string", "x-go-name": "FullName", "x-order": 20 }, "description": { "description": "Brief description of the indicator", "examples": [ "Moving Average Convergence Divergence(MACD) is ..." ], "type": "string", "x-go-name": "Description", "x-order": 30 }, "type": { "description": "Group to which indicator belongs to", "examples": [ "Momentum Indicators" ], "type": "string", "x-go-name": "Type", "x-order": 40 }, "overlay": { "description": "If indicator should be plotted over price bars returns true, otherwise returns false", "examples": [ false ], "type": "boolean", "x-go-name": "Overlay", "x-order": 50 }, "output_values": { "$ref": "#/components/schemas/TechnicalIndicatorsResponseMacdOutputValues" }, "parameters": { "$ref": "#/components/schemas/TechnicalIndicatorsResponseMacdParameters" }, "tinting": { "$ref": "#/components/schemas/TechnicalIndicatorsResponseMacdTinting" } }, "required": [ "description", "enable", "full_name", "overlay", "type" ], "type": "object" }, "GetTechnicalIndicators_200_response": { "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/GetTechnicalIndicators_200_response_data_value" }, "description": "Map of technical indicators available at Twelve Data API", "type": "object", "x-example-key": "macd", "x-go-name": "Data", "x-order": 10 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "data", "status" ], "type": "object" }, "GetTimeSeriesTema_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TEMA - Triple Exponential Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesTema_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesTema_200_response_meta_indicator" } } } ] }, "GetTimeSeriesTema_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "tema": { "description": "TEMA value", "examples": [ "200.83136" ], "type": "string", "x-go-name": "Tema", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "tema" ], "type": "object" }, "GetTimeSeriesTema_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesTema_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesTema_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeries_200_response_meta": { "description": "Json object with request general information", "properties": { "symbol": { "description": "The ticker symbol of an instrument for which data was requested.", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "interval": { "description": "The time gap between consecutive data points.", "examples": [ "1min" ], "type": "string", "x-go-name": "Interval", "x-order": 20 }, "currency": { "description": "The currency of a traded instrument.", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "The timezone of the exchange where the instrument is traded.", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 }, "exchange": { "description": "The exchange name where the instrument is traded.", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 70 }, "mic_code": { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded.", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 80 }, "type": { "description": "The asset class to which the instrument belongs.", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 90 } }, "required": [ "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10 }, "GetTimeSeries_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeries_200_response_meta" }, "values": { "description": "List of time series data points", "items": { "$ref": "#/components/schemas/TimeSeriesItem" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesCross_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/CrossMeta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/TimeSeriesCrossItem" }, "type": "array", "x-go-name": "Values" } }, "required": [ "meta", "values" ], "type": "object" }, "GetTimeSeriesTRange_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TRANGE - True Range" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesTRange_200_response_meta": { "description": "json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesTRange_200_response_meta_indicator" } } } ] }, "GetTimeSeriesTRange_200_response_values_inner": { "properties": { "datetime": { "description": "datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "trange": { "description": "trange value", "examples": [ "0.404" ], "type": "string", "x-go-name": "TRange", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "trange" ], "type": "object" }, "GetTimeSeriesTRange_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesTRange_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesTRange_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesTrima_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TRIMA - Triangular Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesTrima_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesTrima_200_response_meta_indicator" } } } ] }, "GetTimeSeriesTrima_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "trima": { "description": "TRIMA value", "examples": [ "201.36415" ], "type": "string", "x-go-name": "Trima", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "trima" ], "type": "object" }, "GetTimeSeriesTrima_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesTrima_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesTrima_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesTsf_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TSF - Time Series Forecast" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesTsf_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesTsf_200_response_meta_indicator" } } } ] }, "GetTimeSeriesTsf_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "tsf": { "description": "TSF value", "examples": [ "200.63858" ], "type": "string", "x-go-name": "Tsf", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "tsf" ], "type": "object" }, "GetTimeSeriesTsf_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesTsf_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesTsf_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesTypPrice_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TYPPRICE - Typical Price" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesTypPrice_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesTypPrice_200_response_meta_indicator" } } } ] }, "GetTimeSeriesTypPrice_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "typprice": { "description": "typprice value", "examples": [ "201.05266" ], "type": "string", "x-go-name": "TypPrice", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "typprice" ], "type": "object" }, "GetTimeSeriesTypPrice_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesTypPrice_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesTypPrice_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesUltOsc_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ULTOSC - Ultimate Oscillator" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period_1": { "description": "The first time period used for calculation in the indicator", "examples": [ 7 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod1", "x-order": 20 }, "time_period_2": { "description": "The second time period used for calculation in the indicator", "examples": [ 14 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod2", "x-order": 30 }, "time_period_3": { "description": "The third time period used for calculation in the indicator", "examples": [ 28 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod3", "x-order": 40 } }, "required": [ "name", "time_period_1", "time_period_2", "time_period_3" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesUltOsc_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesUltOsc_200_response_meta_indicator" } } } ] }, "GetTimeSeriesUltOsc_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "ultosc": { "description": "Ultimate Oscillator value", "examples": [ "25.17927" ], "type": "string", "x-go-name": "UltOsc", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "ultosc" ], "type": "object" }, "GetTimeSeriesUltOsc_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesUltOsc_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesUltOsc_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesVar_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "VAR - Variance" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesVar_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesVar_200_response_meta_indicator" } } } ] }, "GetTimeSeriesVar_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "var": { "description": "VAR value", "examples": [ "0.18755" ], "type": "string", "x-go-name": "Var", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "var" ], "type": "object" }, "GetTimeSeriesVar_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesVar_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesVar_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesVwap_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "VWAP - Volume Weighted Average Price" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "sd_time_period": { "description": "Standard deviation time period", "format": "int64", "type": "integer", "x-go-name": "SDTimePeriod", "x-order": 20 }, "sd": { "description": "Standard deviation value", "format": "double", "type": "number", "x-go-name": "StandardDeviation", "x-order": 30 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesVwap_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesVwap_200_response_meta_indicator" } } } ] }, "GetTimeSeriesVwap_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "vwap_lower": { "description": "VWAP lower value", "examples": [ "201.05266" ], "type": "string", "x-go-name": "VWAPLower", "x-order": 20 }, "vwap": { "description": "VWAP value", "examples": [ "201.05266" ], "type": "string", "x-go-name": "VWAP", "x-order": 30 }, "vwap_upper": { "description": "VWAP upper value", "examples": [ "201.05266" ], "type": "string", "x-go-name": "VWAPUpper", "x-order": 40 } }, "required": [ "datetime", "vwap" ], "type": "object" }, "GetTimeSeriesVwap_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesVwap_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesVwap_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesWclPrice_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "WCLPRICE - Weighted Close Price" ], "type": "string", "x-go-name": "Name", "x-order": 10 } }, "required": [ "name" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesWclPrice_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesWclPrice_200_response_meta_indicator" } } } ] }, "GetTimeSeriesWclPrice_200_response_values_inner": { "properties": { "datetime": { "description": "datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "wclprice": { "description": "wclprice value", "examples": [ "201.052" ], "type": "string", "x-go-name": "WclPrice", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "wclprice" ], "type": "object" }, "GetTimeSeriesWclPrice_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesWclPrice_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesWclPrice_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesWillR_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "WILLR - Williams %R" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 20 } }, "required": [ "name", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesWillR_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesWillR_200_response_meta_indicator" } } } ] }, "GetTimeSeriesWillR_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "willr": { "description": "Williams %R value", "examples": [ "-84.8916" ], "type": "string", "x-go-name": "WillR", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "willr" ], "type": "object" }, "GetTimeSeriesWillR_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesWillR_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesWillR_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "GetTimeSeriesWma_200_response_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "WMA - Weighted Moving Average" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 }, "time_period": { "description": "The time period used for calculation in the indicator", "examples": [ 9 ], "format": "int64", "type": "integer", "x-go-name": "TimePeriod", "x-order": 30 } }, "required": [ "name", "series_type", "time_period" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "GetTimeSeriesWma_200_response_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/GetTimeSeriesWma_200_response_meta_indicator" } } } ] }, "GetTimeSeriesWma_200_response_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2019-08-09 15:59:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "wma": { "description": "WMA value", "examples": [ "201.20579" ], "type": "string", "x-go-name": "Wma", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "wma" ], "type": "object" }, "GetTimeSeriesWma_200_response": { "properties": { "meta": { "$ref": "#/components/schemas/GetTimeSeriesWma_200_response_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/GetTimeSeriesWma_200_response_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "AssetsInfo_current_assets_receivables": { "description": "Receivables information", "properties": { "total_receivables": { "description": "Total receivables", "examples": [ 60985000000 ], "format": "double", "type": "number", "x-go-name": "TotalReceivables", "x-order": 10 }, "accounts_receivable": { "description": "Accounts receivable", "examples": [ 29508000000 ], "format": "double", "type": "number", "x-go-name": "AccountsReceivable", "x-order": 20 }, "gross_accounts_receivable": { "description": "Gross accounts receivable", "examples": [ 29508000000 ], "format": "double", "type": "number", "x-go-name": "GrossAccountsReceivable", "x-order": 30 }, "allowance_for_doubtful_accounts_receivable": { "description": "Allowance for doubtful accounts receivable", "examples": [ 29508000000 ], "format": "double", "type": "number", "x-go-name": "AllowanceForDoubtfulAccountsReceivable", "x-order": 40 }, "receivables_adjustments_allowances": { "description": "Receivables adjustments allowances", "examples": [ 29508000000 ], "format": "double", "type": "number", "x-go-name": "ReceivablesAdjustmentsAllowances", "x-order": 50 }, "other_receivables": { "description": "Other receivables", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "OtherReceivables", "x-order": 60 }, "due_from_related_parties_current": { "description": "Due from related parties current", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "DueFromRelatedPartiesCurrent", "x-order": 70 }, "taxes_receivable": { "description": "Taxes receivable", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "TaxesReceivable", "x-order": 80 }, "accrued_interest_receivable": { "description": "Accrued interest receivable", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "AccruedInterestReceivable", "x-order": 90 }, "notes_receivable": { "description": "Notes receivable", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "NotesReceivable", "x-order": 100 }, "loans_receivable": { "description": "Loans receivable", "examples": [ 31477000000 ], "format": "double", "type": "number", "x-go-name": "LoansReceivable", "x-order": 110 } }, "type": "object", "x-go-name": "Receivables", "x-order": 80 }, "AssetsInfo_current_assets_inventory": { "description": "Inventory information", "properties": { "total_inventory": { "description": "Total inventory", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "TotalInventory", "x-order": 10 }, "inventories_adjustments_allowances": { "description": "Inventories adjustments allowances", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "InventoriesAdjustmentsAllowances", "x-order": 20 }, "other_inventories": { "description": "Other inventories", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "OtherInventories", "x-order": 30 }, "finished_goods": { "description": "Finished goods", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "FinishedGoods", "x-order": 40 }, "work_in_process": { "description": "Work in process", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "WorkInProcess", "x-order": 50 }, "raw_materials": { "description": "Raw materials", "examples": [ 6331000000 ], "format": "double", "type": "number", "x-go-name": "RawMaterials", "x-order": 60 } }, "type": "object", "x-go-name": "Inventory", "x-order": 90 }, "AssetsInfo_current_assets": { "description": "Current assets information", "properties": { "total_current_assets": { "description": "Total current assets", "examples": [ 143566000000 ], "format": "double", "type": "number", "x-go-name": "TotalCurrentAssets", "x-order": 10 }, "cash_cash_equivalents_and_short_term_investments": { "description": "Cash cash equivalents and short term investments", "examples": [ 61555000000 ], "format": "double", "type": "number", "x-go-name": "CashCashEquivalentsAndShortTermInvestments", "x-order": 20 }, "cash_and_cash_equivalents": { "description": "Cash and cash equivalents", "examples": [ 29965000000 ], "format": "double", "type": "number", "x-go-name": "CashAndCashEquivalents", "x-order": 30 }, "cash_equivalents": { "description": "Cash equivalents", "examples": [ 1606000000 ], "format": "double", "type": "number", "x-go-name": "CashEquivalents", "x-order": 40 }, "cash_financial": { "description": "Cash financial", "examples": [ 28359000000 ], "format": "double", "type": "number", "x-go-name": "CashFinancial", "x-order": 50 }, "other_short_term_investments": { "description": "Other short term investments", "examples": [ 31590000000 ], "format": "double", "type": "number", "x-go-name": "OtherShortTermInvestments", "x-order": 60 }, "restricted_cash": { "description": "Restricted cash", "examples": [ 31590000000 ], "format": "double", "type": "number", "x-go-name": "RestrictedCash", "x-order": 70 }, "receivables": { "$ref": "#/components/schemas/AssetsInfo_current_assets_receivables" }, "inventory": { "$ref": "#/components/schemas/AssetsInfo_current_assets_inventory" }, "prepaid_assets": { "description": "Prepaid assets", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "PrepaidAssets", "x-order": 100 }, "current_deferred_assets": { "description": "Current deferred assets", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDeferredAssets", "x-order": 110 }, "current_deferred_taxes_assets": { "description": "Current deferred taxes assets", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDeferredTaxesAssets", "x-order": 120 }, "assets_held_for_sale_current": { "description": "Assets held for sale current", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "AssetsHeldForSaleCurrent", "x-order": 130 }, "hedging_assets_current": { "description": "Hedging assets current", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "HedgingAssetsCurrent", "x-order": 140 }, "other_current_assets": { "description": "Other current assets", "examples": [ 14695000000 ], "format": "double", "type": "number", "x-go-name": "OtherCurrentAssets", "x-order": 150 } }, "type": "object", "x-go-name": "CurrentAssets", "x-order": 20 }, "AssetsInfo_non_current_assets_goodwill_and_other_intangible_assets": { "description": "Goodwill and other intangible assets information", "properties": { "goodwill": { "description": "Goodwill", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "Goodwill", "x-order": 10 }, "other_intangible_assets": { "description": "Other intangible assets", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "OtherIntangibleAssets", "x-order": 20 }, "total_goodwill_and_intangible_assets": { "description": "Total goodwill and intangible assets", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "TotalGoodwillAndIntangibleAssets", "x-order": 30 } }, "type": "object", "x-go-name": "GoodwillAndOtherIntangibleAssets", "x-order": 160 }, "AssetsInfo_non_current_assets": { "description": "Non-current assets information", "properties": { "total_non_current_assets": { "description": "Total non current assets", "examples": [ 209017000000 ], "format": "double", "type": "number", "x-go-name": "TotalNonCurrentAssets", "x-order": 10 }, "financial_assets": { "description": "Financial assets", "examples": [ 209017000000 ], "format": "double", "type": "number", "x-go-name": "FinancialAssets", "x-order": 20 }, "investments_and_advances": { "description": "Investments and advances", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsAndAdvances", "x-order": 30 }, "other_investments": { "description": "Other investments", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "OtherInvestments", "x-order": 40 }, "investment_in_financial_assets": { "description": "Investment in financial assets", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentInFinancialAssets", "x-order": 50 }, "held_to_maturity_securities": { "description": "Held to maturity securities", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "HeldToMaturitySecurities", "x-order": 60 }, "available_for_sale_securities": { "description": "Available for sale securities", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "AvailableForSaleSecurities", "x-order": 70 }, "financial_assets_designated_as_fair_value_through_profit_or_loss_total": { "description": "Financial assets designated as fair value through profit or loss total", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "FinancialAssetsDesignatedAsFairValueThroughProfitOrLossTotal", "x-order": 80 }, "trading_securities": { "description": "Trading securities", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "TradingSecurities", "x-order": 90 }, "long_term_equity_investment": { "description": "Long term equity investment", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "LongTermEquityInvestment", "x-order": 100 }, "investments_in_joint_ventures_at_cost": { "description": "Investments in joint ventures at cost", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsInJointVenturesAtCost", "x-order": 110 }, "investments_in_other_ventures_under_equity_method": { "description": "Investments in other ventures under equity method", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsInOtherVenturesUnderEquityMethod", "x-order": 120 }, "investments_in_associates_at_cost": { "description": "Investments in associates at cost", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsInAssociatesAtCost", "x-order": 130 }, "investments_in_subsidiaries_at_cost": { "description": "Investments in subsidiaries at cost", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentsInSubsidiariesAtCost", "x-order": 140 }, "investment_properties": { "description": "Investment properties", "examples": [ 100544000000 ], "format": "double", "type": "number", "x-go-name": "InvestmentProperties", "x-order": 150 }, "goodwill_and_other_intangible_assets": { "$ref": "#/components/schemas/AssetsInfo_non_current_assets_goodwill_and_other_intangible_assets" }, "net_ppe": { "description": "Net ppe", "examples": [ 54376000000 ], "format": "double", "type": "number", "x-go-name": "NetPpe", "x-order": 170 }, "gross_ppe": { "description": "Gross ppe", "examples": [ 125260000000 ], "format": "double", "type": "number", "x-go-name": "GrossPpe", "x-order": 180 }, "accumulated_depreciation": { "description": "Accumulated depreciation", "examples": [ -70884000000 ], "format": "double", "type": "number", "x-go-name": "AccumulatedDepreciation", "x-order": 190 }, "leases": { "description": "Leases", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "Leases", "x-order": 200 }, "construction_in_progress": { "description": "Construction in progress", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "ConstructionInProgress", "x-order": 210 }, "other_properties": { "description": "Other properties", "examples": [ 10661000000 ], "format": "double", "type": "number", "x-go-name": "OtherProperties", "x-order": 220 }, "machinery_furniture_equipment": { "description": "Machinery furniture equipment", "examples": [ 78314000000 ], "format": "double", "type": "number", "x-go-name": "MachineryFurnitureEquipment", "x-order": 230 }, "buildings_and_improvements": { "description": "Buildings and improvements", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "BuildingsAndImprovements", "x-order": 240 }, "land_and_improvements": { "description": "Land and improvements", "examples": [ 23446000000 ], "format": "double", "type": "number", "x-go-name": "LandAndImprovements", "x-order": 250 }, "properties": { "description": "Properties", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "Properties", "x-order": 260 }, "non_current_accounts_receivable": { "description": "Non current accounts receivable", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentAccountsReceivable", "x-order": 270 }, "non_current_note_receivables": { "description": "Non current note receivables", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentNoteReceivables", "x-order": 280 }, "due_from_related_parties_non_current": { "description": "Due from related parties non current", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "DueFromRelatedPartiesNonCurrent", "x-order": 290 }, "non_current_prepaid_assets": { "description": "Non current prepaid assets", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentPrepaidAssets", "x-order": 300 }, "non_current_deferred_assets": { "description": "Non current deferred assets", "examples": [ 17852000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentDeferredAssets", "x-order": 310 }, "non_current_deferred_taxes_assets": { "description": "Non current deferred taxes assets", "examples": [ 17852000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentDeferredTaxesAssets", "x-order": 320 }, "defined_pension_benefit": { "description": "Defined pension benefit", "examples": [ 12839000000 ], "format": "double", "type": "number", "x-go-name": "DefinedPensionBenefit", "x-order": 330 }, "other_non_current_assets": { "description": "Other non current assets", "examples": [ 36245000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCurrentAssets", "x-order": 340 } }, "type": "object", "x-go-name": "NonCurrentAssets", "x-order": 30 }, "AssetsInfo_liabilities_current_liabilities_payables_and_accrued_expenses": { "description": "Payables and accrued expenses information", "properties": { "total_payables_and_accrued_expenses": { "description": "Total payables and accrued expenses", "examples": [ 71430000000 ], "format": "double", "type": "number", "x-go-name": "TotalPayablesAndAccruedExpenses", "x-order": 10 }, "accounts_payable": { "description": "Accounts payable", "examples": [ 62611000000 ], "format": "double", "type": "number", "x-go-name": "AccountsPayable", "x-order": 20 }, "current_accrued_expenses": { "description": "Current accrued expenses", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "CurrentAccruedExpenses", "x-order": 30 }, "interest_payable": { "description": "Interest payable", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "InterestPayable", "x-order": 40 }, "payables": { "description": "Payables", "examples": [ 71430000000 ], "format": "double", "type": "number", "x-go-name": "Payables", "x-order": 50 }, "other_payable": { "description": "Other payable", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "OtherPayable", "x-order": 60 }, "due_to_related_parties_current": { "description": "Due to related parties current", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "DueToRelatedPartiesCurrent", "x-order": 70 }, "dividends_payable": { "description": "Dividends payable", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "DividendsPayable", "x-order": 80 }, "total_tax_payable": { "description": "Total tax payable", "examples": [ 8819000000 ], "format": "double", "type": "number", "x-go-name": "TotalTaxPayable", "x-order": 90 }, "income_tax_payable": { "description": "Income tax payable", "examples": [ 8819000000 ], "format": "double", "type": "number", "x-go-name": "IncomeTaxPayable", "x-order": 100 } }, "type": "object", "x-go-name": "PayablesAndAccruedExpenses", "x-order": 100 }, "AssetsInfo_liabilities_current_liabilities": { "description": "Current liabilities information", "properties": { "total_current_liabilities": { "description": "Total current liabilities", "examples": [ 145308000000 ], "format": "double", "type": "number", "x-go-name": "TotalCurrentLiabilities", "x-order": 10 }, "current_debt_and_capital_lease_obligation": { "description": "Current debt and capital lease obligation", "examples": [ 17382000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDebtAndCapitalLeaseObligation", "x-order": 20 }, "current_debt": { "description": "Current debt", "examples": [ 15807000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDebt", "x-order": 30 }, "current_capital_lease_obligation": { "description": "Current capital lease obligation", "examples": [ 1575000000 ], "format": "double", "type": "number", "x-go-name": "CurrentCapitalLeaseObligation", "x-order": 40 }, "other_current_borrowings": { "description": "Other current borrowings", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "OtherCurrentBorrowings", "x-order": 50 }, "line_of_credit": { "description": "Line of credit", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "LineOfCredit", "x-order": 60 }, "commercial_paper": { "description": "Commercial paper", "examples": [ 5985000000 ], "format": "double", "type": "number", "x-go-name": "CommercialPaper", "x-order": 70 }, "current_notes_payable": { "description": "Current notes payable", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "CurrentNotesPayable", "x-order": 80 }, "current_provisions": { "description": "Current provisions", "examples": [ 9822000000 ], "format": "double", "type": "number", "x-go-name": "CurrentProvisions", "x-order": 90 }, "payables_and_accrued_expenses": { "$ref": "#/components/schemas/AssetsInfo_liabilities_current_liabilities_payables_and_accrued_expenses" }, "pension_and_other_post_retirement_benefit_plans_current": { "description": "Pension and other post retirement benefit plans current", "examples": [ 8061000000 ], "format": "double", "type": "number", "x-go-name": "PensionAndOtherPostRetirementBenefitPlansCurrent", "x-order": 110 }, "employee_benefits": { "description": "Employee benefits", "examples": [ 8061000000 ], "format": "double", "type": "number", "x-go-name": "EmployeeBenefits", "x-order": 120 }, "current_deferred_liabilities": { "description": "Current deferred liabilities", "examples": [ 8061000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDeferredLiabilities", "x-order": 130 }, "current_deferred_revenue": { "description": "Current deferred revenue", "examples": [ 8061000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDeferredRevenue", "x-order": 140 }, "current_deferred_taxes_liabilities": { "description": "Current deferred taxes liabilities", "examples": [ 8061000000 ], "format": "double", "type": "number", "x-go-name": "CurrentDeferredTaxesLiabilities", "x-order": 150 }, "other_current_liabilities": { "description": "Other current liabilities", "examples": [ 48435000000 ], "format": "double", "type": "number", "x-go-name": "OtherCurrentLiabilities", "x-order": 160 }, "liabilities_held_for_sale_non_current": { "description": "Liabilities held for sale non current", "examples": [ 48435000000 ], "format": "double", "type": "number", "x-go-name": "LiabilitiesHeldForSaleNonCurrent", "x-order": 170 } }, "type": "object", "x-go-name": "CurrentLiabilities", "x-order": 20 }, "AssetsInfo_liabilities_non_current_liabilities_long_term_debt_and_capital_lease_obligation": { "description": "Long term debt and capital lease obligation information", "properties": { "total_long_term_debt_and_capital_lease_obligation": { "description": "Total long term debt and capital lease obligation", "examples": [ 106548000000 ], "format": "double", "type": "number", "x-go-name": "TotalLongTermDebtAndCapitalLeaseObligation", "x-order": 10 }, "long_term_debt": { "description": "Long term debt", "examples": [ 95281000000 ], "format": "double", "type": "number", "x-go-name": "LongTermDebt", "x-order": 20 }, "long_term_capital_lease_obligation": { "description": "Long term capital lease obligation", "examples": [ 11267000000 ], "format": "double", "type": "number", "x-go-name": "LongTermCapitalLeaseObligation", "x-order": 30 } }, "type": "object", "x-go-name": "LongTermDebtAndCapitalLeaseObligation", "x-order": 20 }, "AssetsInfo_liabilities_non_current_liabilities": { "description": "Non-current liabilities information", "properties": { "total_non_current_liabilities_net_minority_interest": { "description": "Total non current liabilities net minority interest", "examples": [ 145129000000 ], "format": "double", "type": "number", "x-go-name": "TotalNonCurrentLiabilitiesNetMinorityInterest", "x-order": 10 }, "long_term_debt_and_capital_lease_obligation": { "$ref": "#/components/schemas/AssetsInfo_liabilities_non_current_liabilities_long_term_debt_and_capital_lease_obligation" }, "long_term_provisions": { "description": "Long term provisions", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "LongTermProvisions", "x-order": 30 }, "non_current_pension_and_other_postretirement_benefit_plans": { "description": "Non current pension and other postretirement benefit plans", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentPensionAndOtherPostretirementBenefitPlans", "x-order": 40 }, "non_current_accrued_expenses": { "description": "Non current accrued expenses", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentAccruedExpenses", "x-order": 50 }, "due_to_related_parties_non_current": { "description": "Due to related parties non current", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "DueToRelatedPartiesNonCurrent", "x-order": 60 }, "trade_and_other_payables_non_current": { "description": "Trade and other payables non current", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "TradeAndOtherPayablesNonCurrent", "x-order": 70 }, "non_current_deferred_liabilities": { "description": "Non current deferred liabilities", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentDeferredLiabilities", "x-order": 80 }, "non_current_deferred_revenue": { "description": "Non current deferred revenue", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentDeferredRevenue", "x-order": 90 }, "non_current_deferred_taxes_liabilities": { "description": "Non current deferred taxes liabilities", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "NonCurrentDeferredTaxesLiabilities", "x-order": 100 }, "other_non_current_liabilities": { "description": "Other non current liabilities", "examples": [ 23124000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCurrentLiabilities", "x-order": 110 }, "preferred_securities_outside_stock_equity": { "description": "Preferred securities outside stock equity", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "PreferredSecuritiesOutsideStockEquity", "x-order": 120 }, "derivative_product_liabilities": { "description": "Derivative product liabilities", "examples": [ 15457000000 ], "format": "double", "type": "number", "x-go-name": "DerivativeProductLiabilities", "x-order": 130 }, "capital_lease_obligations": { "description": "Capital lease obligations", "examples": [ 12842000000 ], "format": "double", "type": "number", "x-go-name": "CapitalLeaseObligations", "x-order": 140 }, "restricted_common_stock": { "description": "Restricted common stock", "examples": [ 12842000000 ], "format": "double", "type": "number", "x-go-name": "RestrictedCommonStock", "x-order": 150 } }, "type": "object", "x-go-name": "NonCurrentLiabilities", "x-order": 30 }, "AssetsInfo_liabilities": { "description": "Liabilities information", "properties": { "total_liabilities_net_minority_interest": { "description": "Total liabilities net minority interest", "examples": [ 290437000000 ], "format": "double", "type": "number", "x-go-name": "TotalLiabilitiesNetMinorityInterest", "x-order": 10 }, "current_liabilities": { "$ref": "#/components/schemas/AssetsInfo_liabilities_current_liabilities" }, "non_current_liabilities": { "$ref": "#/components/schemas/AssetsInfo_liabilities_non_current_liabilities" }, "equity": { "$ref": "#/components/schemas/EquityInfo" } }, "type": "object", "x-go-name": "Liabilities", "x-order": 40 }, "CashFlowData_cash_flow_from_operating_activities": { "description": "Cash flow from operating activities", "properties": { "net_income_from_continuing_operations": { "description": "Net income from continuing operations", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeFromContinuingOperations", "x-order": 10 }, "operating_cash_flow": { "description": "Operating cash flow", "examples": [ 110543000000 ], "format": "double", "type": "number", "x-go-name": "OperatingCashFlow", "x-order": 20 }, "cash_flow_from_continuing_operating_activities": { "description": "Cash flow from continuing operating activities", "examples": [ 110543000000 ], "format": "double", "type": "number", "x-go-name": "CashFlowFromContinuingOperatingActivities", "x-order": 30 }, "cash_from_discontinued_operating_activities": { "description": "Cash from discontinued operating activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFromDiscontinuedOperatingActivities", "x-order": 40 }, "cash_flow_from_discontinued_operation": { "description": "Cash flow from discontinued operation", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFlowFromDiscontinuedOperation", "x-order": 50 }, "free_cash_flow": { "description": "Free cash flow", "examples": [ 99584000000 ], "format": "double", "type": "number", "x-go-name": "FreeCashFlow", "x-order": 60 }, "cash_flows_from_used_in_operating_activities_direct": { "description": "Cash flows from used in operating activities direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFlowsFromUsedInOperatingActivitiesDirect", "x-order": 70 }, "taxes_refund_paid": { "description": "Taxes refund paid", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "TaxesRefundPaid", "x-order": 80 }, "taxes_refund_paid_direct": { "description": "Taxes refund paid direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "TaxesRefundPaidDirect", "x-order": 90 }, "interest_received": { "description": "Interest received", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestReceived", "x-order": 100 }, "interest_received_direct": { "description": "Interest received direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestReceivedDirect", "x-order": 110 }, "interest_paid": { "description": "Interest paid", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestPaid", "x-order": 120 }, "interest_paid_direct": { "description": "Interest paid direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestPaidDirect", "x-order": 130 }, "dividend_received": { "description": "Dividend received", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DividendReceived", "x-order": 140 }, "dividend_received_direct": { "description": "Dividend received direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DividendReceivedDirect", "x-order": 150 }, "dividend_paid": { "description": "Dividend paid", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DividendPaid", "x-order": 160 }, "dividend_paid_direct": { "description": "Dividend paid direct", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DividendPaidDirect", "x-order": 170 }, "change_in_working_capital": { "description": "Change in working capital", "examples": [ -6577000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInWorkingCapital", "x-order": 180 }, "change_in_other_working_capital": { "description": "Change in other working capital", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInOtherWorkingCapital", "x-order": 190 }, "change_in_receivables": { "description": "Change in receivables", "examples": [ -417000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInReceivables", "x-order": 200 }, "changes_in_account_receivables": { "description": "Changes in account receivables", "examples": [ -1688000000 ], "format": "double", "type": "number", "x-go-name": "ChangesInAccountReceivables", "x-order": 210 }, "change_in_payables_and_accrued_expense": { "description": "Change in payables and accrued expense", "examples": [ -1889000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInPayablesAndAccruedExpense", "x-order": 220 }, "change_in_accrued_expense": { "description": "Change in accrued expense", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInAccruedExpense", "x-order": 230 }, "change_in_payable": { "description": "Change in payable", "examples": [ -1889000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInPayable", "x-order": 240 }, "change_in_dividend_payable": { "description": "Change in dividend payable", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInDividendPayable", "x-order": 250 }, "change_in_account_payable": { "description": "Change in account payable", "examples": [ -1889000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInAccountPayable", "x-order": 260 }, "change_in_tax_payable": { "description": "Change in tax payable", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInTaxPayable", "x-order": 270 }, "change_in_income_tax_payable": { "description": "Change in income tax payable", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInIncomeTaxPayable", "x-order": 280 }, "change_in_interest_payable": { "description": "Change in interest payable", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInInterestPayable", "x-order": 290 }, "change_in_other_current_liabilities": { "description": "Change in other current liabilities", "examples": [ 3031000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInOtherCurrentLiabilities", "x-order": 300 }, "change_in_other_current_assets": { "description": "Change in other current assets", "examples": [ -5684000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInOtherCurrentAssets", "x-order": 310 }, "change_in_inventory": { "description": "Change in inventory", "examples": [ -1618000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInInventory", "x-order": 320 }, "change_in_prepaid_assets": { "description": "Change in prepaid assets", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ChangeInPrepaidAssets", "x-order": 330 }, "other_non_cash_items": { "description": "Other non cash items", "examples": [ -2227000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCashItems", "x-order": 340 }, "excess_tax_benefit_from_stock_based_compensation": { "description": "Excess tax benefit from stock based compensation", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ExcessTaxBenefitFromStockBasedCompensation", "x-order": 350 }, "stock_based_compensation": { "description": "Stock based compensation", "examples": [ 10833000000 ], "format": "double", "type": "number", "x-go-name": "StockBasedCompensation", "x-order": 360 }, "unrealized_gain_loss_on_investment_securities": { "description": "Unrealized gain loss on investment securities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "UnrealizedGainLossOnInvestmentSecurities", "x-order": 370 }, "provision_and_write_off_of_assets": { "description": "Provision and write off of assets", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ProvisionAndWriteOffOfAssets", "x-order": 380 }, "asset_impairment_charge": { "description": "Asset impairment charge", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "AssetImpairmentCharge", "x-order": 390 }, "amortization_of_securities": { "description": "Amortization of securities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "AmortizationOfSecurities", "x-order": 400 }, "deferred_tax": { "description": "Deferred tax", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DeferredTax", "x-order": 410 }, "deferred_income_tax": { "description": "Deferred income tax", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DeferredIncomeTax", "x-order": 420 }, "depreciation_amortization_depletion": { "description": "Depreciation amortization depletion", "examples": [ 11519000000 ], "format": "double", "type": "number", "x-go-name": "DepreciationAmortizationDepletion", "x-order": 430 }, "depletion": { "description": "Depletion", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "Depletion", "x-order": 440 }, "depreciation_and_amortization": { "description": "Depreciation and amortization", "examples": [ 11519000000 ], "format": "double", "type": "number", "x-go-name": "DepreciationAndAmortization", "x-order": 450 }, "amortization_cash_flow": { "description": "Amortization cash flow", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "AmortizationCashFlow", "x-order": 460 }, "amortization_of_intangibles": { "description": "Amortization of intangibles", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "AmortizationOfIntangibles", "x-order": 470 }, "depreciation": { "description": "Depreciation", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "Depreciation", "x-order": 480 }, "operating_gains_losses": { "description": "Operating gains losses", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "OperatingGainsLosses", "x-order": 490 }, "pension_and_employee_benefit_expense": { "description": "Pension and employee benefit expense", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PensionAndEmployeeBenefitExpense", "x-order": 500 }, "earnings_losses_from_equity_investments": { "description": "Earnings losses from equity investments", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "EarningsLossesFromEquityInvestments", "x-order": 510 }, "gain_loss_on_investment_securities": { "description": "Gain loss on investment securities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "GainLossOnInvestmentSecurities", "x-order": 520 }, "net_foreign_currency_exchange_gain_loss": { "description": "Net foreign currency exchange gain loss", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "NetForeignCurrencyExchangeGainLoss", "x-order": 530 }, "gain_loss_on_sale_of_ppe": { "description": "Gain loss on sale of ppe", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "GainLossOnSaleOfPpe", "x-order": 540 }, "gain_loss_on_sale_of_business": { "description": "Gain loss on sale of business", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "GainLossOnSaleOfBusiness", "x-order": 550 } }, "type": "object", "x-go-name": "CashFlowFromOperatingActivities", "x-order": 20 }, "CashFlowData_cash_flow_from_investing_activities": { "description": "Cash flow from investing activities", "properties": { "investing_cash_flow": { "description": "Investing cash flow", "examples": [ 3705000000 ], "format": "double", "type": "number", "x-go-name": "InvestingCashFlow", "x-order": 10 }, "cash_flow_from_continuing_investing_activities": { "description": "Cash flow from continuing investing activities", "examples": [ 3705000000 ], "format": "double", "type": "number", "x-go-name": "CashFlowFromContinuingInvestingActivities", "x-order": 20 }, "cash_from_discontinued_investing_activities": { "description": "Cash from discontinued investing activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFromDiscontinuedInvestingActivities", "x-order": 30 }, "net_other_investing_changes": { "description": "Net other investing changes", "examples": [ -1337000000 ], "format": "double", "type": "number", "x-go-name": "NetOtherInvestingChanges", "x-order": 40 }, "interest_received_cfi": { "description": "Interest received cfi", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestReceivedCfi", "x-order": 50 }, "dividends_received_cfi": { "description": "Dividends received cfi", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DividendsReceivedCfi", "x-order": 60 }, "net_investment_purchase_and_sale": { "description": "Net investment purchase and sale", "examples": [ 16001000000 ], "format": "double", "type": "number", "x-go-name": "NetInvestmentPurchaseAndSale", "x-order": 70 }, "sale_of_investment": { "description": "Sale of investment", "examples": [ 45514000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfInvestment", "x-order": 80 }, "purchase_of_investment": { "description": "Purchase of investment", "examples": [ -29513000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfInvestment", "x-order": 90 }, "net_investment_properties_purchase_and_sale": { "description": "Net investment properties purchase and sale", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "NetInvestmentPropertiesPurchaseAndSale", "x-order": 100 }, "sale_of_investment_properties": { "description": "Sale of investment properties", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfInvestmentProperties", "x-order": 110 }, "purchase_of_investment_properties": { "description": "Purchase of investment properties", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfInvestmentProperties", "x-order": 120 }, "net_business_purchase_and_sale": { "description": "Net business purchase and sale", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "NetBusinessPurchaseAndSale", "x-order": 130 }, "sale_of_business": { "description": "Sale of business", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfBusiness", "x-order": 140 }, "purchase_of_business": { "description": "Purchase of business", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfBusiness", "x-order": 150 }, "net_intangibles_purchase_and_sale": { "description": "Net intangibles purchase and sale", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "NetIntangiblesPurchaseAndSale", "x-order": 160 }, "sale_of_intangibles": { "description": "Sale of intangibles", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfIntangibles", "x-order": 170 }, "purchase_of_intangibles": { "description": "Purchase of intangibles", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfIntangibles", "x-order": 180 }, "net_ppe_purchase_and_sale": { "description": "Net ppe purchase and sale", "examples": [ -10959000000 ], "format": "double", "type": "number", "x-go-name": "NetPpePurchaseAndSale", "x-order": 190 }, "sale_of_ppe": { "description": "Sale of ppe", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfPpe", "x-order": 200 }, "purchase_of_ppe": { "description": "Purchase of ppe", "examples": [ -10959000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfPpe", "x-order": 210 }, "capital_expenditure_reported": { "description": "Capital expenditure reported", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CapitalExpenditureReported", "x-order": 220 }, "capital_expenditure": { "description": "Capital expenditure", "examples": [ -10959000000 ], "format": "double", "type": "number", "x-go-name": "CapitalExpenditure", "x-order": 230 } }, "type": "object", "x-go-name": "CashFlowFromInvestingActivities", "x-order": 30 }, "CashFlowData_cash_flow_from_financing_activities": { "description": "Cash flow from financing activities", "properties": { "financing_cash_flow": { "description": "Financing cash flow", "examples": [ -108488000000 ], "format": "double", "type": "number", "x-go-name": "FinancingCashFlow", "x-order": 10 }, "cash_flow_from_continuing_financing_activities": { "description": "Cash flow from continuing financing activities", "examples": [ -108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFlowFromContinuingFinancingActivities", "x-order": 20 }, "cash_from_discontinued_financing_activities": { "description": "Cash from discontinued financing activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CashFromDiscontinuedFinancingActivities", "x-order": 30 }, "net_other_financing_charges": { "description": "Net other financing charges", "examples": [ -6012000000 ], "format": "double", "type": "number", "x-go-name": "NetOtherFinancingCharges", "x-order": 40 }, "interest_paid_cff": { "description": "Interest paid cff", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "InterestPaidCff", "x-order": 50 }, "proceeds_from_stock_option_exercised": { "description": "Proceeds from stock option exercised", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ProceedsFromStockOptionExercised", "x-order": 60 }, "cash_dividends_paid": { "description": "Cash dividends paid", "examples": [ -15025000000 ], "format": "double", "type": "number", "x-go-name": "CashDividendsPaid", "x-order": 70 }, "preferred_stock_dividend_paid": { "description": "Preferred stock dividend paid", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PreferredStockDividendPaid", "x-order": 80 }, "common_stock_dividend_paid": { "description": "Common stock dividend paid", "examples": [ -15025000000 ], "format": "double", "type": "number", "x-go-name": "CommonStockDividendPaid", "x-order": 90 }, "net_preferred_stock_issuance": { "description": "Net preferred stock issuance", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "NetPreferredStockIssuance", "x-order": 100 }, "preferred_stock_payments": { "description": "Preferred stock payments", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PreferredStockPayments", "x-order": 110 }, "preferred_stock_issuance": { "description": "Preferred stock issuance", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PreferredStockIssuance", "x-order": 120 }, "net_common_stock_issuance": { "description": "Net common stock issuance", "examples": [ -77550000000 ], "format": "double", "type": "number", "x-go-name": "NetCommonStockIssuance", "x-order": 130 }, "common_stock_payments": { "description": "Common stock payments", "examples": [ -77550000000 ], "format": "double", "type": "number", "x-go-name": "CommonStockPayments", "x-order": 140 }, "common_stock_issuance": { "description": "Common stock issuance", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "CommonStockIssuance", "x-order": 150 }, "repurchase_of_capital_stock": { "description": "Repurchase of capital stock", "examples": [ -77550000000 ], "format": "double", "type": "number", "x-go-name": "RepurchaseOfCapitalStock", "x-order": 160 }, "net_issuance_payments_of_debt": { "description": "Net issuance payments of debt", "examples": [ -9901000000 ], "format": "double", "type": "number", "x-go-name": "NetIssuancePaymentsOfDebt", "x-order": 170 }, "net_short_term_debt_issuance": { "description": "Net short term debt issuance", "examples": [ -3978000000 ], "format": "double", "type": "number", "x-go-name": "NetShortTermDebtIssuance", "x-order": 180 }, "short_term_debt_payments": { "description": "Short term debt payments", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ShortTermDebtPayments", "x-order": 190 }, "short_term_debt_issuance": { "description": "Short term debt issuance", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ShortTermDebtIssuance", "x-order": 200 }, "net_long_term_debt_issuance": { "description": "Net long term debt issuance", "examples": [ -5923000000 ], "format": "double", "type": "number", "x-go-name": "NetLongTermDebtIssuance", "x-order": 210 }, "long_term_debt_payments": { "description": "Long term debt payments", "examples": [ -11151000000 ], "format": "double", "type": "number", "x-go-name": "LongTermDebtPayments", "x-order": 220 }, "long_term_debt_issuance": { "description": "Long term debt issuance", "examples": [ 5228000000 ], "format": "double", "type": "number", "x-go-name": "LongTermDebtIssuance", "x-order": 230 }, "issuance_of_debt": { "description": "Issuance of debt", "examples": [ 5228000000 ], "format": "double", "type": "number", "x-go-name": "IssuanceOfDebt", "x-order": 240 }, "repayment_of_debt": { "description": "Repayment of debt", "examples": [ -11151000000 ], "format": "double", "type": "number", "x-go-name": "RepaymentOfDebt", "x-order": 250 }, "issuance_of_capital_stock": { "description": "Issuance of capital stock", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "IssuanceOfCapitalStock", "x-order": 260 } }, "type": "object", "x-go-name": "CashFlowFromFinancingActivities", "x-order": 40 }, "CashFlowData_supplemental_data": { "description": "Supplemental data", "properties": { "interest_paid_supplemental_data": { "description": "Interest paid supplemental data", "examples": [ 3803000000 ], "format": "double", "type": "number", "x-go-name": "InterestPaidSupplementalData", "x-order": 10 }, "income_tax_paid_supplemental_data": { "description": "Income tax paid supplemental data", "examples": [ 18679000000 ], "format": "double", "type": "number", "x-go-name": "IncomeTaxPaidSupplementalData", "x-order": 20 } }, "type": "object", "x-go-name": "SupplementalData", "x-order": 50 }, "CashFlowData_foreign_and_domestic_sales": { "description": "Foreign and domestic sales", "properties": { "foreign_sales": { "description": "Foreign sales", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ForeignSales", "x-order": 10 }, "domestic_sales": { "description": "Domestic sales", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "DomesticSales", "x-order": 20 }, "adjusted_geography_segment_data": { "description": "Adjusted geography segment data", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "AdjustedGeographySegmentData", "x-order": 30 } }, "type": "object", "x-go-name": "ForeignAndDomesticSales", "x-order": 60 }, "CashFlowData_cash_position": { "description": "Cash position", "properties": { "beginning_cash_position": { "description": "Beginning cash position", "examples": [ 24977000000 ], "format": "double", "type": "number", "x-go-name": "BeginningCashPosition", "x-order": 10 }, "end_cash_position": { "description": "End cash position", "examples": [ 30737000000 ], "format": "double", "type": "number", "x-go-name": "EndCashPosition", "x-order": 20 }, "changes_in_cash": { "description": "Changes in cash", "examples": [ 5760000000 ], "format": "double", "type": "number", "x-go-name": "ChangesInCash", "x-order": 30 }, "other_cash_adjustment_outside_change_in_cash": { "description": "Other cash adjustment outside change in cash", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "OtherCashAdjustmentOutsideChangeInCash", "x-order": 40 }, "other_cash_adjustment_inside_change_in_cash": { "description": "Other cash adjustment inside change in cash", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "OtherCashAdjustmentInsideChangeInCash", "x-order": 50 }, "effect_of_exchange_rate_changes": { "description": "Effect of exchange rate changes", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "EffectOfExchangeRateChanges", "x-order": 60 } }, "type": "object", "x-go-name": "CashPosition", "x-order": 70 }, "CashFlowData_direct_method_cash_flow": { "description": "Direct method cash flow", "properties": { "classes_of_cash_receipts_from_operating_activities": { "description": "Classes of cash receipts from operating activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ClassesOfCashReceiptsFromOperatingActivities", "x-order": 10 }, "other_cash_receipts_from_operating_activities": { "description": "Other cash receipts from operating activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "OtherCashReceiptsFromOperatingActivities", "x-order": 20 }, "receipts_from_government_grants": { "description": "Receipts from government grants", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ReceiptsFromGovernmentGrants", "x-order": 30 }, "receipts_from_customers": { "description": "Receipts from customers", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ReceiptsFromCustomers", "x-order": 40 }, "classes_of_cash_payments": { "description": "Classes of cash payments", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "ClassesOfCashPayments", "x-order": 50 }, "other_cash_payments_from_operating_activities": { "description": "Other cash payments from operating activities", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "OtherCashPaymentsFromOperatingActivities", "x-order": 60 }, "payments_on_behalf_of_employees": { "description": "Payments on behalf of employees", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PaymentsOnBehalfOfEmployees", "x-order": 70 }, "payments_to_suppliers_for_goods_and_services": { "description": "Payments to suppliers for goods and services", "examples": [ 108488000000 ], "format": "double", "type": "number", "x-go-name": "PaymentsToSuppliersForGoodsAndServices", "x-order": 80 } }, "type": "object", "x-go-name": "DirectMethodCashFlow", "x-order": 80 }, "CashFlowStruct_operating_activities": { "description": "Operating activities section", "properties": { "net_income": { "description": "Returns net income (NI). Calculated as sales minus cost of goods sold", "examples": [ 34630000000 ], "format": "double", "type": "number", "x-go-name": "NetIncome", "x-order": 10 }, "depreciation": { "description": "Represents depreciation and amortization measure", "examples": [ 2697000000 ], "format": "double", "type": "number", "x-go-name": "Depreciation", "x-order": 20 }, "deferred_taxes": { "description": "Stands for taxes that are owed but are not due to be paid until a future date", "examples": [ 682000000 ], "format": "double", "type": "number", "x-go-name": "DeferredTaxes", "x-order": 30 }, "stock_based_compensation": { "description": "Refers to share-based compensation as the way of paying employees, executives, and directors of a company with equity in the business", "examples": [ 2265000000 ], "format": "double", "type": "number", "x-go-name": "StockBasedCompensation", "x-order": 40 }, "other_non_cash_items": { "description": "Represents other non-cash items", "examples": [ 167000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonCashItems", "x-order": 50 }, "accounts_receivable": { "description": "Represents the balance of money due to a firm for goods or services delivered or used but not yet paid for by customers", "examples": [ -13746000000 ], "format": "double", "type": "number", "x-go-name": "AccountsReceivable", "x-order": 60 }, "accounts_payable": { "description": "Refers to an account within the general ledger that represents an obligation to pay off a short-term debt to creditors or suppliers", "examples": [ 19813000000 ], "format": "double", "type": "number", "x-go-name": "AccountsPayable", "x-order": 70 }, "other_assets_liabilities": { "description": "Represents cumulative changes in inventory, other current assets, other current liabilities, and other working capital", "examples": [ 458000000 ], "format": "double", "type": "number", "x-go-name": "OtherAssetsLiabilities", "x-order": 80 }, "operating_cash_flow": { "description": "Returns operating cash flow (OCF) measure representing a total amount of cash generated by company's normal business operations", "examples": [ 46966000000 ], "format": "double", "type": "number", "x-go-name": "OperatingCashFlow", "x-order": 90 } }, "type": "object", "x-go-name": "OperatingActivities", "x-order": 30 }, "CashFlowStruct_investing_activities": { "description": "Investing activities section", "properties": { "capital_expenditures": { "description": "Capital expenditures (CapEx) are funds used by a company to acquire, upgrade, and maintain physical assets (PPE)", "examples": [ -2803000000 ], "format": "double", "type": "number", "x-go-name": "CapitalExpenditures", "x-order": 10 }, "net_intangibles": { "description": "Represents purchase of a not physical asset", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "NetIntangibles", "x-order": 20 }, "net_acquisitions": { "description": "Refers to net amount of business purchase and sale", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "NetAcquisitions", "x-order": 30 }, "purchase_of_investments": { "description": "Represents how much money has been used in making investments, including purchases of physical assets, investments in securities", "examples": [ -34913000000 ], "format": "double", "type": "number", "x-go-name": "PurchaseOfInvestments", "x-order": 40 }, "sale_of_investments": { "description": "Represents how much money has been generated from the sale of securities or assets", "examples": [ 21984000000 ], "format": "double", "type": "number", "x-go-name": "SaleOfInvestments", "x-order": 50 }, "other_investing_activity": { "description": "Represents other investing activity", "examples": [ -374000000 ], "format": "double", "type": "number", "x-go-name": "OtherInvestingActivity", "x-order": 60 }, "investing_cash_flow": { "description": "Returns total amount of cash flow used in investments", "examples": [ -16106000000 ], "format": "double", "type": "number", "x-go-name": "InvestingCashFlow", "x-order": 70 } }, "type": "object", "x-go-name": "InvestingActivities", "x-order": 40 }, "CashFlowStruct_financing_activities": { "description": "Financing activities section", "properties": { "long_term_debt_issuance": { "description": "Refers to the issuance of any financial obligations that extend beyond a 12 months period", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "LongTermDebtIssuance", "x-order": 10 }, "long_term_debt_payments": { "description": "Refers to the payments of any financial obligations that extend beyond a 12 months period", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "LongTermDebtPayments", "x-order": 20 }, "short_term_debt_issuance": { "description": "Refers to the issuance of any financial obligations that are expected to be paid off within a year", "examples": [ -1000000000 ], "format": "double", "type": "number", "x-go-name": "ShortTermDebtIssuance", "x-order": 30 }, "common_stock_issuance": { "description": "Represents a transaction whereby a company issues its own shares to the marketplace", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "CommonStockIssuance", "x-order": 40 }, "common_stock_repurchase": { "description": "Represents a transaction whereby a company buys back its own shares from the marketplace", "examples": [ -20478000000 ], "format": "double", "type": "number", "x-go-name": "CommonStockRepurchase", "x-order": 50 }, "common_dividends": { "description": "Returns value of payment doled out by a company to its stockholders in the form of periodic distributions of cash", "examples": [ -3732000000 ], "format": "double", "type": "number", "x-go-name": "CommonDividends", "x-order": 60 }, "other_financing_charges": { "description": "Represents other financing charges", "examples": [ -2949000000 ], "format": "double", "type": "number", "x-go-name": "OtherFinancingCharges", "x-order": 70 }, "financing_cash_flow": { "description": "Returns cash flow from financing activities (CFF), which shows the net flows of cash that are used to fund the company", "examples": [ -28159000000 ], "format": "double", "type": "number", "x-go-name": "FinancingCashFlow", "x-order": 80 } }, "type": "object", "x-go-name": "FinancingActivities", "x-order": 50 }, "EquityInfo_capital_stock": { "description": "Capital stock information", "properties": { "common_stock": { "description": "Common stock", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "CommonStock", "x-order": 10 }, "preferred_stock": { "description": "Preferred stock", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "PreferredStock", "x-order": 20 }, "total_partnership_capital": { "description": "Total partnership capital", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "TotalPartnershipCapital", "x-order": 30 }, "general_partnership_capital": { "description": "General partnership capital", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "GeneralPartnershipCapital", "x-order": 40 }, "limited_partnership_capital": { "description": "Limited partnership capital", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "LimitedPartnershipCapital", "x-order": 50 }, "capital_stock": { "description": "Capital stock", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "CapitalStock", "x-order": 60 }, "other_capital_stock": { "description": "Other capital stock", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "OtherCapitalStock", "x-order": 70 }, "additional_paid_in_capital": { "description": "Additional paid in capital", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "AdditionalPaidInCapital", "x-order": 80 }, "retained_earnings": { "description": "Retained earnings", "examples": [ -214000000 ], "format": "double", "type": "number", "x-go-name": "RetainedEarnings", "x-order": 90 }, "treasury_stock": { "description": "Treasury stock", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "TreasuryStock", "x-order": 100 }, "treasury_shares_number": { "description": "Treasury shares number", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "TreasurySharesNumber", "x-order": 110 }, "ordinary_shares_number": { "description": "Ordinary shares number", "examples": [ 15550061000 ], "format": "double", "type": "number", "x-go-name": "OrdinarySharesNumber", "x-order": 120 }, "preferred_shares_number": { "description": "Preferred shares number", "examples": [ 73812000000 ], "format": "double", "type": "number", "x-go-name": "PreferredSharesNumber", "x-order": 130 }, "share_issued": { "description": "Share issued", "examples": [ 15550061000 ], "format": "double", "type": "number", "x-go-name": "ShareIssued", "x-order": 140 } }, "type": "object", "x-go-name": "CapitalStock", "x-order": 120 }, "EquityInfo_equity_adjustments": { "description": "Equity adjustments information", "properties": { "gains_losses_not_affecting_retained_earnings": { "description": "Gains losses not affecting retained earnings", "examples": [ -11452000000 ], "format": "double", "type": "number", "x-go-name": "GainsLossesNotAffectingRetainedEarnings", "x-order": 10 }, "other_equity_adjustments": { "description": "Other equity adjustments", "examples": [ -11452000000 ], "format": "double", "type": "number", "x-go-name": "OtherEquityAdjustments", "x-order": 20 }, "fixed_assets_revaluation_reserve": { "description": "Fixed assets revaluation reserve", "examples": [ 11452000000 ], "format": "double", "type": "number", "x-go-name": "FixedAssetsRevaluationReserve", "x-order": 30 }, "foreign_currency_translation_adjustments": { "description": "Foreign currency translation adjustments", "examples": [ 11452000000 ], "format": "double", "type": "number", "x-go-name": "ForeignCurrencyTranslationAdjustments", "x-order": 40 }, "minimum_pension_liabilities": { "description": "Minimum pension liabilities", "examples": [ 11452000000 ], "format": "double", "type": "number", "x-go-name": "MinimumPensionLiabilities", "x-order": 50 }, "unrealized_gain_loss": { "description": "Unrealized gain loss", "examples": [ 11452000000 ], "format": "double", "type": "number", "x-go-name": "UnrealizedGainLoss", "x-order": 60 } }, "type": "object", "x-go-name": "EquityAdjustments", "x-order": 130 }, "EtfResponseItem_access": { "description": "Info on which plan symbol is available (displayed then `show_plan` is `true`)", "properties": { "global": { "description": "Level of access to the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Global" }, "plan": { "description": "The individual plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "Plan" }, "plan_business": { "description": "The business plan name for the symbol", "examples": [ "Basic" ], "type": "string", "x-go-name": "PlanBusiness" } }, "required": [ "global", "plan", "plan_business" ], "type": "object", "x-go-name": "Access", "x-order": 120 }, "IncomeStatementBlock_operating_expense": { "description": "Operating expense details", "properties": { "research_and_development": { "description": "Refers to research & development (R&D) expenses", "examples": [ 6306000000 ], "format": "int64", "type": "integer", "x-go-name": "ResearchAndDevelopment", "x-order": 10 }, "selling_general_and_administrative": { "description": "Refers to selling, general and administrative (SG&A) expenses", "examples": [ 6449000000 ], "format": "int64", "type": "integer", "x-go-name": "SellingGeneralAndAdministrative", "x-order": 20 }, "other_operating_expenses": { "description": "Refers to other operating expenses", "examples": [ 0 ], "format": "int64", "type": "integer", "x-go-name": "OtherOperatingExpenses", "x-order": 30 } }, "type": "object", "x-go-name": "OperatingExpense", "x-order": 70 }, "IncomeStatementBlock_non_operating_interest": { "description": "Non-operating interest details", "properties": { "income": { "description": "Refers to non-operating interest income", "examples": [ 650000000 ], "format": "int64", "type": "integer", "x-go-name": "Income", "x-order": 10 }, "expense": { "description": "Refers to non-operating interest expense", "examples": [ 694000000 ], "format": "int64", "type": "integer", "x-go-name": "Expense", "x-order": 20 } }, "type": "object", "x-go-name": "NonOperatingInterest", "x-order": 90 }, "IncomeStatementItem_revenue": { "description": "Revenue information", "properties": { "total_revenue": { "description": "Total revenue", "examples": [ 383285000000 ], "format": "double", "type": "number", "x-go-name": "TotalRevenue", "x-order": 10 }, "operating_revenue": { "description": "Operating revenue", "examples": [ 383285000000 ], "format": "double", "type": "number", "x-go-name": "OperatingRevenue", "x-order": 20 } }, "type": "object", "x-go-name": "Revenue", "x-order": 20 }, "IncomeStatementItem_gross_profit_cost_of_revenue": { "description": "Cost of revenue information", "properties": { "cost_of_revenue_value": { "description": "Cost of revenue value", "examples": [ 214137000000 ], "format": "double", "type": "number", "x-go-name": "CostOfRevenueValue", "x-order": 10 }, "excise_taxes": { "description": "Excise taxes", "examples": [ 214137000000 ], "format": "double", "type": "number", "x-go-name": "ExciseTaxes", "x-order": 20 }, "reconciled_cost_of_revenue": { "description": "Reconciled cost of revenue", "examples": [ 214137000000 ], "format": "double", "type": "number", "x-go-name": "ReconciledCostOfRevenue", "x-order": 30 } }, "type": "object", "x-go-name": "CostOfRevenue", "x-order": 20 }, "IncomeStatementItem_gross_profit": { "description": "Gross profit information", "properties": { "gross_profit_value": { "description": "Gross profit value", "examples": [ 169148000000 ], "format": "double", "type": "number", "x-go-name": "GrossProfitValue", "x-order": 10 }, "cost_of_revenue": { "$ref": "#/components/schemas/IncomeStatementItem_gross_profit_cost_of_revenue" } }, "type": "object", "x-go-name": "GrossProfit", "x-order": 30 }, "IncomeStatementItem_operating_income": { "description": "Operating income information", "properties": { "operating_income_value": { "description": "Operating income value", "examples": [ 114301000000 ], "format": "double", "type": "number", "x-go-name": "OperatingIncomeValue", "x-order": 10 }, "total_operating_income_as_reported": { "description": "Total operating income as reported", "examples": [ 114301000000 ], "format": "double", "type": "number", "x-go-name": "TotalOperatingIncomeAsReported", "x-order": 20 }, "operating_expense": { "description": "Operating expense", "examples": [ 54847000000 ], "format": "double", "type": "number", "x-go-name": "OperatingExpense", "x-order": 30 }, "other_operating_expenses": { "description": "Other operating expenses", "examples": [ 114301000000 ], "format": "double", "type": "number", "x-go-name": "OtherOperatingExpenses", "x-order": 40 }, "total_expenses": { "description": "Total expenses", "examples": [ 268984000000 ], "format": "double", "type": "number", "x-go-name": "TotalExpenses", "x-order": 50 } }, "type": "object", "x-go-name": "OperatingIncome", "x-order": 40 }, "IncomeStatementItem_net_income": { "description": "Net income information", "properties": { "net_income_value": { "description": "Net income value", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeValue", "x-order": 10 }, "net_income_common_stockholders": { "description": "Net income common stockholders", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeCommonStockholders", "x-order": 20 }, "net_income_including_noncontrolling_interests": { "description": "Net income including noncontrolling interests", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeIncludingNoncontrollingInterests", "x-order": 30 }, "net_income_from_tax_loss_carryforward": { "description": "Net income from tax loss carryforward", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeFromTaxLossCarryforward", "x-order": 40 }, "net_income_extraordinary": { "description": "Net income extraordinary", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeExtraordinary", "x-order": 50 }, "net_income_discontinuous_operations": { "description": "Net income discontinuous operations", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeDiscontinuousOperations", "x-order": 60 }, "net_income_continuous_operations": { "description": "Net income continuous operations", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeContinuousOperations", "x-order": 70 }, "net_income_from_continuing_operation_net_minority_interest": { "description": "Net income from continuing operation net minority interest", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeFromContinuingOperationNetMinorityInterest", "x-order": 80 }, "net_income_from_continuing_and_discontinued_operation": { "description": "Net income from continuing and discontinued operation", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NetIncomeFromContinuingAndDiscontinuedOperation", "x-order": 90 }, "normalized_income": { "description": "Normalized income", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "NormalizedIncome", "x-order": 100 }, "minority_interests": { "description": "Minority interests", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "MinorityInterests", "x-order": 110 } }, "type": "object", "x-go-name": "NetIncome", "x-order": 50 }, "IncomeStatementItem_earnings_per_share": { "description": "Earnings per share information", "properties": { "diluted_eps": { "description": "Diluted EPS", "examples": [ 6.13 ], "format": "double", "type": "number", "x-go-name": "DilutedEPS", "x-order": 10 }, "basic_eps": { "description": "Basic EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicEPS", "x-order": 20 }, "continuing_and_discontinued_diluted_eps": { "description": "Continuing and discontinued diluted EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "ContinuingAndDiscontinuedDilutedEPS", "x-order": 30 }, "continuing_and_discontinued_basic_eps": { "description": "Continuing and discontinued basic EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "ContinuingAndDiscontinuedBasicEPS", "x-order": 40 }, "normalized_diluted_eps": { "description": "Normalized diluted EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "NormalizedDilutedEPS", "x-order": 50 }, "normalized_basic_eps": { "description": "Normalized basic EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "NormalizedBasicEPS", "x-order": 60 }, "reported_normalized_diluted_eps": { "description": "Reported normalized diluted EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "ReportedNormalizedDilutedEPS", "x-order": 70 }, "reported_normalized_basic_eps": { "description": "Reported normalized basic EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "ReportedNormalizedBasicEPS", "x-order": 80 }, "diluted_eps_other_gains_losses": { "description": "Diluted EPS other gains losses", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "DilutedEPSOtherGainsLosses", "x-order": 90 }, "tax_loss_carryforward_diluted_eps": { "description": "Tax loss carryforward diluted EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "TaxLossCarryforwardDilutedEPS", "x-order": 100 }, "diluted_accounting_change": { "description": "Diluted accounting change", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "DilutedAccountingChange", "x-order": 110 }, "diluted_extraordinary": { "description": "Diluted extraordinary", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "DilutedExtraordinary", "x-order": 120 }, "diluted_discontinuous_operations": { "description": "Diluted discontinuous operations", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "DilutedDiscontinuousOperations", "x-order": 130 }, "diluted_continuous_operations": { "description": "Diluted continuous operations", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "DilutedContinuousOperations", "x-order": 140 }, "basic_eps_other_gains_losses": { "description": "Basic EPS other gains losses", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicEPSOtherGainsLosses", "x-order": 150 }, "tax_loss_carryforward_basic_eps": { "description": "Tax loss carryforward basic EPS", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "TaxLossCarryforwardBasicEPS", "x-order": 160 }, "basic_accounting_change": { "description": "Basic accounting change", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicAccountingChange", "x-order": 170 }, "basic_extraordinary": { "description": "Basic extraordinary", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicExtraordinary", "x-order": 180 }, "basic_discontinuous_operations": { "description": "Basic discontinuous operations", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicDiscontinuousOperations", "x-order": 190 }, "basic_continuous_operations": { "description": "Basic continuous operations", "examples": [ 6.16 ], "format": "double", "type": "number", "x-go-name": "BasicContinuousOperations", "x-order": 200 }, "diluted_ni_avail_to_common_stockholders": { "description": "Diluted NI available to common stockholders", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "DilutedNIAvailToCommonStockholders", "x-order": 210 }, "average_dilution_earnings": { "description": "Average dilution earnings", "examples": [ 96995000000 ], "format": "double", "type": "number", "x-go-name": "AverageDilutionEarnings", "x-order": 220 } }, "type": "object", "x-go-name": "EarningsPerShare", "x-order": 60 }, "IncomeStatementItem_expenses": { "description": "Expenses information", "properties": { "total_expenses": { "description": "Total expenses", "examples": [ 268984000000 ], "format": "double", "type": "number", "x-go-name": "TotalExpenses", "x-order": 10 }, "selling_general_and_administration_expense": { "description": "Selling general and administration expense", "examples": [ 24932000000 ], "format": "double", "type": "number", "x-go-name": "SellingGeneralAndAdministrationExpense", "x-order": 20 }, "selling_and_marketing_expense": { "description": "Selling and marketing expense", "examples": [ 24932000000 ], "format": "double", "type": "number", "x-go-name": "SellingAndMarketingExpense", "x-order": 30 }, "general_and_administrative_expense": { "description": "General and administrative expense", "examples": [ 24932000000 ], "format": "double", "type": "number", "x-go-name": "GeneralAndAdministrativeExpense", "x-order": 40 }, "other_general_and_administrative_expense": { "description": "Other general and administrative expense", "examples": [ 24932000000 ], "format": "double", "type": "number", "x-go-name": "OtherGeneralAndAdministrativeExpense", "x-order": 50 }, "depreciation_amortization_depletion_income_statement": { "description": "Depreciation amortization depletion income statement", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "DepreciationAmortizationDepletionIncomeStatement", "x-order": 60 }, "research_and_development_expense": { "description": "Research and development expense", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "ResearchAndDevelopmentExpense", "x-order": 70 }, "insurance_and_claims_expense": { "description": "Insurance and claims expense", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "InsuranceAndClaimsExpense", "x-order": 80 }, "rent_and_landing_fees": { "description": "Rent and landing fees", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "RentAndLandingFees", "x-order": 90 }, "salaries_and_wages_expense": { "description": "Salaries and wages expense", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "SalariesAndWagesExpense", "x-order": 100 }, "rent_expense_supplemental": { "description": "Rent expense supplemental", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "RentExpenseSupplemental", "x-order": 110 }, "provision_for_doubtful_accounts": { "description": "Provision for doubtful accounts", "examples": [ 29915000000 ], "format": "double", "type": "number", "x-go-name": "ProvisionForDoubtfulAccounts", "x-order": 120 } }, "type": "object", "x-go-name": "Expenses", "x-order": 70 }, "IncomeStatementItem_interest_income_and_expense": { "description": "Interest income and expense information", "properties": { "interest_income": { "description": "Interest income", "examples": [ 3750000000 ], "format": "double", "type": "number", "x-go-name": "InterestIncome", "x-order": 10 }, "interest_expense": { "description": "Interest expense", "examples": [ 3933000000 ], "format": "double", "type": "number", "x-go-name": "InterestExpense", "x-order": 20 }, "net_interest_income": { "description": "Net interest income", "examples": [ -183000000 ], "format": "double", "type": "number", "x-go-name": "NetInterestIncome", "x-order": 30 }, "net_non_operating_interest_income_expense": { "description": "Net non operating interest income expense", "examples": [ -183000000 ], "format": "double", "type": "number", "x-go-name": "NetNonOperatingInterestIncomeExpense", "x-order": 40 }, "interest_expense_non_operating": { "description": "Interest expense non operating", "examples": [ 3933000000 ], "format": "double", "type": "number", "x-go-name": "InterestExpenseNonOperating", "x-order": 50 }, "interest_income_non_operating": { "description": "Interest income non operating", "examples": [ 3750000000 ], "format": "double", "type": "number", "x-go-name": "InterestIncomeNonOperating", "x-order": 60 } }, "type": "object", "x-go-name": "InterestIncomeAndExpense", "x-order": 80 }, "IncomeStatementItem_other_income_and_expenses": { "description": "Other income and expenses information", "properties": { "other_income_expense": { "description": "Other income expense", "examples": [ -382000000 ], "format": "double", "type": "number", "x-go-name": "OtherIncomeExpense", "x-order": 10 }, "other_non_operating_income_expenses": { "description": "Other non operating income expenses", "examples": [ -382000000 ], "format": "double", "type": "number", "x-go-name": "OtherNonOperatingIncomeExpenses", "x-order": 20 }, "special_income_charges": { "description": "Special income charges", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "SpecialIncomeCharges", "x-order": 30 }, "gain_on_sale_of_ppe": { "description": "Gain on sale of PPE", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "GainOnSaleOfPPE", "x-order": 40 }, "gain_on_sale_of_business": { "description": "Gain on sale of business", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "GainOnSaleOfBusiness", "x-order": 50 }, "gain_on_sale_of_security": { "description": "Gain on sale of security", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "GainOnSaleOfSecurity", "x-order": 60 }, "other_special_charges": { "description": "Other special charges", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "OtherSpecialCharges", "x-order": 70 }, "write_off": { "description": "Write off", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "WriteOff", "x-order": 80 }, "impairment_of_capital_assets": { "description": "Impairment of capital assets", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "ImpairmentOfCapitalAssets", "x-order": 90 }, "restructuring_and_merger_acquisition": { "description": "Restructuring and merger acquisition", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "RestructuringAndMergerAcquisition", "x-order": 100 }, "securities_amortization": { "description": "Securities amortization", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "SecuritiesAmortization", "x-order": 110 }, "earnings_from_equity_interest": { "description": "Earnings from equity interest", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "EarningsFromEquityInterest", "x-order": 120 }, "earnings_from_equity_interest_net_of_tax": { "description": "Earnings from equity interest net of tax", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "EarningsFromEquityInterestNetOfTax", "x-order": 130 }, "total_other_finance_cost": { "description": "Total other finance cost", "examples": [ 382000000 ], "format": "double", "type": "number", "x-go-name": "TotalOtherFinanceCost", "x-order": 140 } }, "type": "object", "x-go-name": "OtherIncomeAndExpenses", "x-order": 90 }, "IncomeStatementItem_taxes": { "description": "Taxes information", "properties": { "tax_provision": { "description": "Tax provision", "examples": [ 16741000000 ], "format": "double", "type": "number", "x-go-name": "TaxProvision", "x-order": 10 }, "tax_effect_of_unusual_items": { "description": "Tax effect of unusual items", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "TaxEffectOfUnusualItems", "x-order": 20 }, "tax_rate_for_calculations": { "description": "Tax rate for calculations", "examples": [ 0.147 ], "format": "double", "type": "number", "x-go-name": "TaxRateForCalculations", "x-order": 30 }, "other_taxes": { "description": "Other taxes", "examples": [ 0 ], "format": "double", "type": "number", "x-go-name": "OtherTaxes", "x-order": 40 } }, "type": "object", "x-go-name": "Taxes", "x-order": 100 }, "IncomeStatementItem_depreciation_and_amortization": { "description": "Depreciation and amortization information", "properties": { "depreciation_amortization_depletion": { "description": "Depreciation amortization depletion", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "DepreciationAmortizationDepletion", "x-order": 10 }, "amortization_of_intangibles": { "description": "Amortization of intangibles", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "AmortizationOfIntangibles", "x-order": 20 }, "depreciation": { "description": "Depreciation", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "Depreciation", "x-order": 30 }, "amortization": { "description": "Amortization", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "Amortization", "x-order": 40 }, "depletion": { "description": "Depletion", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "Depletion", "x-order": 50 }, "depreciation_and_amortization_in_income_statement": { "description": "Depreciation and amortization in income statement", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "DepreciationAndAmortizationInIncomeStatement", "x-order": 60 } }, "type": "object", "x-go-name": "DepreciationAndAmortization", "x-order": 110 }, "IncomeStatementItem_ebitda": { "description": "EBITDA information", "properties": { "ebitda_value": { "description": "EBITDA value", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "EBITDAValue", "x-order": 10 }, "normalized_ebitda_value": { "description": "Normalized EBITDA value", "examples": [ 129188000000 ], "format": "double", "type": "number", "x-go-name": "NormalizedEBITDAValue", "x-order": 20 }, "ebit_value": { "description": "EBIT value", "examples": [ 117669000000 ], "format": "double", "type": "number", "x-go-name": "EBITValue", "x-order": 30 } }, "type": "object", "x-go-name": "EBITDA", "x-order": 120 }, "IncomeStatementItem_dividends_and_shares": { "description": "Dividends and shares information", "properties": { "dividend_per_share": { "description": "Dividend per share", "examples": [ 15812547000 ], "format": "double", "type": "number", "x-go-name": "DividendPerShare", "x-order": 10 }, "diluted_average_shares": { "description": "Diluted average shares", "examples": [ 15812547000 ], "format": "double", "type": "number", "x-go-name": "DilutedAverageShares", "x-order": 20 }, "basic_average_shares": { "description": "Basic average shares", "examples": [ 15744231000 ], "format": "double", "type": "number", "x-go-name": "BasicAverageShares", "x-order": 30 }, "preferred_stock_dividends": { "description": "Preferred stock dividends", "examples": [ 15744231000 ], "format": "double", "type": "number", "x-go-name": "PreferredStockDividends", "x-order": 40 }, "other_under_preferred_stock_dividend": { "description": "Other under preferred stock dividend", "examples": [ 15744231000 ], "format": "double", "type": "number", "x-go-name": "OtherUnderPreferredStockDividend", "x-order": 50 } }, "type": "object", "x-go-name": "DividendsAndShares", "x-order": 130 }, "IncomeStatementItem_unusual_items": { "description": "Unusual items information", "properties": { "total_unusual_items": { "description": "Total unusual items", "examples": [ 11519000000 ], "format": "double", "type": "number", "x-go-name": "TotalUnusualItems", "x-order": 10 }, "total_unusual_items_excluding_goodwill": { "description": "Total unusual items excluding goodwill", "examples": [ 11519000000 ], "format": "double", "type": "number", "x-go-name": "TotalUnusualItemsExcludingGoodwill", "x-order": 20 } }, "type": "object", "x-go-name": "UnusualItems", "x-order": 140 }, "IncomeStatementItem_depreciation": { "description": "Depreciation information", "properties": { "reconciled_depreciation": { "description": "Reconciled depreciation", "examples": [ 11519000000 ], "format": "double", "type": "number", "x-go-name": "ReconciledDepreciation", "x-order": 10 } }, "type": "object", "x-go-name": "Depreciation", "x-order": 150 }, "IncomeStatementItem_pretax_income": { "description": "Pretax income information", "properties": { "pretax_income_value": { "description": "Pretax income value", "examples": [ 113736000000 ], "format": "double", "type": "number", "x-go-name": "PretaxIncomeValue", "x-order": 10 } }, "type": "object", "x-go-name": "PretaxIncome", "x-order": 160 }, "IncomeStatementItem_special_income_charges": { "description": "Special income charges information", "properties": { "special_income_charges_value": { "description": "Special income charges value", "examples": [ 113736000000 ], "format": "double", "type": "number", "x-go-name": "SpecialIncomeChargesValue", "x-order": 10 } }, "type": "object", "x-go-name": "SpecialIncomeCharges", "x-order": 170 }, "inline_object": { "properties": { "data": { "description": "List of assets with their details", "items": { "$ref": "#/components/schemas/GetAssetsResponseItem" }, "type": "array", "x-go-name": "Data", "x-order": 10 } }, "required": [ "data" ], "type": "object" }, "inline_object_1": { "properties": { "count": { "description": "Count", "examples": [ 100 ], "format": "int64", "type": "integer", "x-go-name": "Count" }, "data": { "description": "List of indices", "items": { "$ref": "#/components/schemas/Index" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "count", "data", "status" ], "type": "object" }, "inline_object_2_expenses": { "properties": { "expense_ratio_gross": { "format": "double", "type": "number", "x-go-name": "ExpenseRatioGross" }, "expense_ratio_net": { "format": "double", "type": "number", "x-go-name": "ExpenseRatioNet" } }, "type": "object", "x-go-name": "Expenses" }, "inline_object_2_minimums": { "properties": { "additional_investment": { "format": "int64", "type": "integer", "x-go-name": "AdditionalInvestment" }, "additional_ira_investment": { "type": "object", "x-go-name": "AdditionalIraInvestment" }, "initial_investment": { "format": "int64", "type": "integer", "x-go-name": "InitialInvestment" }, "initial_ira_investment": { "type": "object", "x-go-name": "InitialIraInvestment" } }, "type": "object", "x-go-name": "Minimums" }, "inline_object_2_pricing": { "properties": { "12_month_high": { "format": "double", "type": "number", "x-go-name": "TwelveMonthHigh" }, "12_month_low": { "format": "double", "type": "number", "x-go-name": "TwelveMonthLow" }, "last_month": { "format": "double", "type": "number", "x-go-name": "LastMonth" }, "nav": { "format": "double", "type": "number", "x-go-name": "Nav" } }, "type": "object", "x-go-name": "Pricing" }, "inline_object_2": { "properties": { "brokerages": { "items": { "type": "string" }, "type": "array", "x-go-name": "Brokerages" }, "expenses": { "$ref": "#/components/schemas/inline_object_2_expenses" }, "minimums": { "$ref": "#/components/schemas/inline_object_2_minimums" }, "pricing": { "$ref": "#/components/schemas/inline_object_2_pricing" } }, "type": "object" }, "inline_object_3": { "properties": { "performance_rating": { "format": "int64", "type": "integer", "x-go-name": "PerformanceRating" }, "return_rating": { "format": "int64", "type": "integer", "x-go-name": "ReturnRating" }, "risk_rating": { "format": "int64", "type": "integer", "x-go-name": "RiskRating" } }, "type": "object" }, "inline_object_4": { "properties": { "corporate_aum": { "format": "double", "type": "number", "x-go-name": "CorporateAum" }, "corporate_esg_pillars": { "additionalProperties": { "format": "double", "type": "number" }, "type": "object", "x-go-name": "CorporateEsgPillars" }, "score": { "format": "int64", "type": "integer", "x-go-name": "Score" }, "sustainable_investment": { "type": "boolean", "x-go-name": "SustainableInvestment" } }, "type": "object" }, "inline_object_5": { "properties": { "calls": { "items": { "$ref": "#/components/schemas/OptionSide" }, "type": "array", "x-go-name": "Calls" }, "puts": { "items": { "$ref": "#/components/schemas/OptionSide" }, "type": "array", "x-go-name": "Puts" } }, "type": "object" }, "inline_object_6": { "properties": { "dates": { "items": { "type": "string" }, "type": "array", "x-go-name": "Dates" } }, "type": "object" }, "inline_object_7": { "properties": { "data": { "items": { "$ref": "#/components/schemas/StockExchange" }, "type": "array", "x-go-name": "Data" }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status" } }, "required": [ "data", "status" ], "type": "object" }, "inline_object_8_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ACOS - Arccosine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "open" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_8_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_8_meta_indicator" } } } ] }, "inline_object_8_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-30 02:08:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "acos": { "description": "ACOS value", "examples": [ "12.345" ], "type": "string", "x-go-name": "Acos", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "acos", "datetime" ], "type": "object" }, "inline_object_8": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_8_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_8_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_9_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ASIN - Arcsine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_9_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_9_meta_indicator" } } } ] }, "inline_object_9_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 16:05:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "asin": { "description": "ASIN value", "examples": [ "12.345" ], "type": "string", "x-go-name": "Asin", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "asin", "datetime" ], "type": "object" }, "inline_object_9": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_9_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_9_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_10_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "ATAN - Arctan" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_10_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_10_meta_indicator" } } } ] }, "inline_object_10_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 16:52:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "atan": { "description": "ATAN value", "examples": [ "1.57079" ], "type": "string", "x-go-name": "Atan", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "atan", "datetime" ], "type": "object" }, "inline_object_10": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_10_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_10_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_11_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "COS - Cosine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_11_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_11_meta_indicator" } } } ] }, "inline_object_11_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 16:55:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "cos": { "description": "COS value", "examples": [ "-0.25043722" ], "type": "string", "x-go-name": "Cos", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "cos", "datetime" ], "type": "object" }, "inline_object_11": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_11_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_11_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_12_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "COSH - Hyperbolic Cosine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_12_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_12_meta_indicator" } } } ] }, "inline_object_12_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 17:01:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "cosh": { "description": "COSH value", "examples": [ "+Inf" ], "type": "string", "x-go-name": "Cosh", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "cosh", "datetime" ], "type": "object" }, "inline_object_12": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_12_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_12_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_13_meta_indicator": { "properties": { "ma_type": { "type": "string", "x-go-name": "MAType" }, "max_period": { "format": "int64", "type": "integer", "x-go-name": "MaxPeriod" }, "min_period": { "format": "int64", "type": "integer", "x-go-name": "MinPeriod" }, "name": { "type": "string", "x-go-name": "Name" }, "periods": { "items": { "format": "int64", "type": "integer" }, "type": "array", "x-go-name": "Periods" }, "series_type": { "type": "string", "x-go-name": "SeriesType" } }, "type": "object", "x-go-name": "Indicator" }, "inline_object_13_meta": { "required": [ "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_13_meta_indicator" } } } ] }, "inline_object_13_values_inner": { "properties": { "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 }, "datetime": { "type": "string", "x-go-name": "Time" }, "mavp": { "type": "string", "x-go-name": "MaVp" } }, "type": "object" }, "inline_object_13": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_13_meta" }, "values": { "items": { "$ref": "#/components/schemas/inline_object_13_values_inner" }, "type": "array", "x-go-name": "Data" } }, "type": "object" }, "inline_object_14_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SIN - Sine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_14_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_14_meta_indicator" } } } ] }, "inline_object_14_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 17:05:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sin": { "description": "SIN value", "examples": [ "-0.87641625" ], "type": "string", "x-go-name": "Sin", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sin" ], "type": "object" }, "inline_object_14": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_14_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_14_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_15_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "SINH - Hyperbolic Sine" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_15_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_15_meta_indicator" } } } ] }, "inline_object_15_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 17:08:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "sinh": { "description": "SINH value", "examples": [ "+Inf" ], "type": "string", "x-go-name": "Sinh", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "sinh" ], "type": "object" }, "inline_object_15": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_15_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_15_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_16_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TAN - Tangent" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_16_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_16_meta_indicator" } } } ] }, "inline_object_16_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 13:12:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "tan": { "description": "TAN value", "examples": [ "-1.29151" ], "type": "string", "x-go-name": "Tan", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "tan" ], "type": "object" }, "inline_object_16": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_16_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_16_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "inline_object_17_meta_indicator": { "description": "Technical indicator information", "properties": { "name": { "description": "Name of the technical indicator", "examples": [ "TANH - Hyperbolic Tangent" ], "type": "string", "x-go-name": "Name", "x-order": 10 }, "series_type": { "description": "Price type on which technical indicator is calculated", "examples": [ "close" ], "type": "string", "x-go-name": "SeriesType", "x-order": 20 } }, "required": [ "name", "series_type" ], "type": "object", "x-go-name": "Indicator", "x-order": 100 }, "inline_object_17_meta": { "description": "Json object with request general information", "required": [ "indicator", "interval", "symbol", "type" ], "type": "object", "x-go-name": "Meta", "x-order": 10, "allOf": [ { "$ref": "#/components/schemas/TimeSeriesIndicatorMeta" }, { "type": "object", "properties": { "indicator": { "$ref": "#/components/schemas/inline_object_17_meta_indicator" } } } ] }, "inline_object_17_values_inner": { "properties": { "datetime": { "description": "Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened", "examples": [ "2025-05-29 13:16:00" ], "type": "string", "x-go-name": "Time", "x-order": 10 }, "tanh": { "description": "TANH value", "examples": [ "1" ], "type": "string", "x-go-name": "Tanh", "x-order": 20 }, "open": { "description": "Price at the opening of current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73500" ], "type": "string", "x-go-name": "Open", "x-order": 100 }, "high": { "description": "Highest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.86000" ], "type": "string", "x-go-name": "High", "x-order": 110 }, "low": { "description": "Lowest price which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.73000" ], "type": "string", "x-go-name": "Low", "x-order": 120 }, "close": { "description": "Close price at the end of the bar. Returned when `include_ohlc` is `true`.", "examples": [ "148.85001" ], "type": "string", "x-go-name": "Close", "x-order": 130 }, "volume": { "description": "Trading volume which occurred during the current bar. Returned when `include_ohlc` is `true`.", "examples": [ "624277" ], "type": "string", "x-go-name": "Volume", "x-order": 140 } }, "required": [ "datetime", "tanh" ], "type": "object" }, "inline_object_17": { "properties": { "meta": { "$ref": "#/components/schemas/inline_object_17_meta" }, "values": { "description": "Array of time series data points", "items": { "$ref": "#/components/schemas/inline_object_17_values_inner" }, "type": "array", "x-go-name": "Data", "x-order": 20 }, "status": { "description": "Response status", "examples": [ "ok" ], "type": "string", "x-go-name": "Status", "x-order": 30 } }, "required": [ "meta", "status", "values" ], "type": "object" }, "IntervalEnum": { "enum": [ "1min", "5min", "15min", "30min", "45min", "1h", "2h", "4h", "8h", "1day", "1week", "1month" ], "type": "string", "x-go-name": "Interval", "x-order": "30" }, "TypeEnum": { "enum": [ "American Depositary Receipt", "Bond", "Bond Fund", "Closed-end Fund", "Common Stock", "Depositary Receipt", "Digital Currency", "ETF", "Exchange-Traded Note", "Global Depositary Receipt", "Limited Partnership", "Mutual Fund", "Physical Currency", "Preferred Stock", "REIT", "Right", "Structured Product", "Trust", "Unit", "Warrant" ], "type": "string", "x-go-name": "Type", "x-order": "70" }, "OrderEnum": { "default": "desc", "enum": [ "asc", "desc" ], "type": "string", "x-go-name": "Order", "x-order": "130" }, "FormatEnum": { "default": "JSON", "enum": [ "JSON", "CSV" ], "type": "string", "x-go-name": "Format", "x-order": "90" }, "AdjustEnum": { "default": "splits", "enum": [ "all", "splits", "dividends", "none" ], "type": "string", "x-go-name": "Adjust", "x-order": "180" }, "SeriesTypeEnum": { "default": "open", "enum": [ "close", "open", "high", "low", "volume" ], "type": "string", "x-go-name": "SeriesType", "x-order": "62" }, "RatingChangeEnum": { "enum": [ "Maintains", "Upgrade", "Downgrade", "Initiates", "Reiterates" ], "type": "string", "x-go-name": "RatingChange", "x-order": "60" }, "MaTypeEnum": { "default": "SMA", "enum": [ "SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "MAMA", "T3MA" ], "type": "string", "x-go-name": "MaType", "x-order": "63" }, "PeriodEnum": { "default": "annual", "enum": [ "annual", "quarterly" ], "type": "string", "x-go-name": "Period", "x-order": "70" }, "RangeEnum": { "default": "last", "enum": [ "last", "next", "1m", "3m", "6m", "ytd", "1y", "2y", "5y", "full" ], "type": "string", "x-go-name": "Range", "x-order": "60" }, "PeriodEarningsEnum": { "enum": [ "latest", "next" ], "type": "string", "x-go-name": "PeriodEarnings", "x-order": "80" }, "EndpointEnum": { "enum": [ "price_target", "recommendations", "statistics", "insider_transactions", "profile", "mutual_funds_world_summary", "mutual_funds_world", "institutional_holders", "analyst_rating", "income_statement", "income_statement_quarterly", "cash_flow", "cash_flow_quarterly", "balance_sheet", "balance_sheet_quarterly", "mutual_funds_list", "mutual_funds_world_sustainability", "mutual_funds_world_summary", "mutual_funds_world_risk", "mutual_funds_world_purchase_info", "mutual_funds_world_composition", "mutual_funds_world_performance", "mutual_funds_world", "etfs_list", "etfs_world", "etfs_world_summary", "etfs_world_performance", "etfs_world_risk", "etfs_world_composition", "dividends", "splits", "money_market_funds_world" ], "type": "string", "x-go-name": "Endpoint", "x-order": "10" }, "MarketEnum": { "enum": [ "stocks", "etf", "mutual_funds", "forex", "crypto" ], "type": "string", "x-go-name": "Market", "x-order": "5" }, "DirectionEnum": { "default": "gainers", "enum": [ "gainers", "losers" ], "type": "string", "x-go-name": "Direction", "x-order": "10" }, "FormatMoneyMarketFundsListEnum": { "default": "json", "enum": [ "json", "csv" ], "type": "string", "x-go-name": "FormatMoneyMarketFundsList", "x-order": "30" }, "SourceEnum": { "enum": [ "ofac", "uk", "eu", "au" ], "type": "string", "x-go-name": "Source" }, "RangeSplitsEnum": { "default": "last", "enum": [ "last", "1m", "3m", "6m", "ytd", "1y", "2y", "5y", "full" ], "type": "string", "x-go-name": "RangeSplits", "x-order": "70" }, "SeriesTypeStochrsiEnum": { "default": "close", "enum": [ "open", "high", "low", "close" ], "type": "string", "x-go-name": "SeriesTypeStochrsi", "x-order": "63" }, "TimeSeriesIndicatorMeta": { "description": "Common metadata fields for time series indicator responses", "type": "object", "x-go-name": "TimeSeriesIndicatorMeta", "properties": { "symbol": { "description": "The ticker symbol of an instrument for which data was requested.", "examples": [ "AAPL" ], "type": "string", "x-go-name": "Symbol", "x-order": 10 }, "interval": { "description": "The time gap between consecutive data points.", "examples": [ "1min" ], "type": "string", "x-go-name": "Interval", "x-order": 20 }, "currency": { "description": "The currency of a traded instrument.", "examples": [ "USD" ], "type": "string", "x-go-name": "Currency", "x-order": 30 }, "exchange_timezone": { "description": "The timezone of the exchange where the instrument is traded.", "examples": [ "America/New_York" ], "type": "string", "x-go-name": "ExchangeTimezone", "x-order": 60 }, "exchange": { "description": "The exchange name where the instrument is traded.", "examples": [ "NASDAQ" ], "type": "string", "x-go-name": "Exchange", "x-order": 70 }, "mic_code": { "description": "The Market Identifier Code (MIC) of the exchange where the instrument is traded.", "examples": [ "XNAS" ], "type": "string", "x-go-name": "MicCode", "x-order": 80 }, "type": { "description": "The asset class to which the instrument belongs.", "examples": [ "Common Stock" ], "type": "string", "x-go-name": "Type", "x-order": 90 } } } }, "securitySchemes": { "authorizationHeader": { "description": "Enter the token with the `apikey ` prefix, e.g. \"apikey abcde12345\".", "in": "header", "name": "Authorization", "type": "apiKey" }, "queryParameter": { "in": "query", "name": "apikey", "type": "apiKey" } } }, "x-group-list": [ { "description": "Access real-time and historical market prices—time series and exchange rates—for equities, forex, cryptocurrencies, ETFs, and more. These endpoints form the foundation for any trading or data-driven application.", "name": "Market data", "order": 10 }, { "children": [ { "description": "Asset Catalog endpoints are your starting point. They return the complete inventory of tradeable instruments available through Twelve Data — over 1,000,000 symbols across 50+ countries. You query a catalog first to discover which symbols exist, then pass those symbols to price, fundamental, or indicator endpoints.", "name": "Asset catalogs", "order": 10 }, { "description": "Discovery endpoints help you find instruments when you don't already know the exact identifier. The Asset Catalog is the phone book; Discovery is the search engine on top of it.", "name": "Discovery", "order": 20 }, { "description": "Market endpoints answer operational questions about exchanges themselves: which ones are open right now, what are their trading hours, and how far back does data go for a given instrument?", "name": "Markets", "order": 30 }, { "description": "Metadata endpoints return the lookup tables and enumerations that define valid parameter values across the entire API. They answer: what instrument types exist? What intervals are supported? Which countries are covered? What technical indicators can I use?", "name": "Supporting metadata", "order": 40 } ], "description": "Lookup static metadata—symbol lists, exchange details, currency information-to filter, validate, and contextualize your core data calls. Ideal for building dropdowns, mappings, and ensuring data consistency.", "name": "Reference data", "order": 20 }, { "description": "In-depth company and fund financials—income statements, balance sheets, cash flows, profiles, corporate events, and key ratios. Unlock comprehensive datasets for valuation, screening, and fundamental research.", "name": "Fundamentals", "order": 30 }, { "name": "Currencies", "order": 35 }, { "description": "ETF-focused metadata and analytics: universe lists, family and type groupings, NAV snapshots, performance metrics, risk measures, and current fund composition. Tailored to the unique characteristics and reporting cadence of exchange-traded funds.", "name": "ETFs", "order": 40 }, { "description": "Mutual-fund-specific listings and snapshots: fund directories, issuer families, fund types, NAV history, dividend records, key ratios, and portfolio holdings. Ideal for long-term performance analysis and portfolio attribution.", "name": "Mutual funds", "order": 50 }, { "description": "Money-market-fund directories and full-data snapshots: fund listings ranked by fund size, plus screener metrics (fund size, liquidity, weighted average maturity), yields, key facts, and risk indicators. Focused on short-term, low-risk cash-management instruments for liquidity and capital-preservation analysis.", "name": "Money market funds", "order": 55 }, { "children": [ { "description": "Plotted directly on the price chart to smooth or envelope price data, highlighting trend direction, support/resistance, and mean-reversion levels (e.g. moving averages, Bollinger Bands, Parabolic SAR, Ichimoku Cloud, Keltner Channels, McGinley Dynamic).", "name": "Overlap studies", "order": 10 }, { "description": "Oscillators that measure the speed or strength of price movement, helping detect overbought/oversold conditions, divergences, and shifts in trend momentum (e.g. RSI, MACD, ROC, Stochastics, ADX, CCI, Coppock Curve, TRIX).", "name": "Momentum indicators", "order": 20 }, { "description": "Use trading volume to confirm price moves or warn of exhaustion—volume and price in tandem suggest trend strength, while divergences can signal reversals (e.g. OBV, Chaikin AD, Accumulation/Distribution Oscillator).", "name": "Volume indicators", "order": 30 }, { "description": "Quantify the range or dispersion of price over time to gauge risk, size stops, or identify breakouts (e.g. ATR, NATR, True Range) and adaptive overlays like SuperTrend.", "name": "Volatility indicators", "order": 40 }, { "description": "Convert raw OHLC data into derived series or aggregated values to feed other indicators or reveal different perspectives on price (e.g. typical price, HLC3, weighted close, arithmetic transforms like SUM, AVG, LOG, SQRT).", "name": "Price transform", "order": 50 }, { "description": "Detect and follow recurring periodic patterns in price action using Hilbert Transform–based measures of cycle period and phase (e.g. HT_SINE, HT_DCPERIOD, HT_DCPHASE, HT_PHASOR, HT_TRENDMODE).", "name": "Cycle indicators", "order": 60 }, { "description": "Scan bars or bar‐groups for predefined candlestick patterns that historically signal continuation or reversal setups (e.g. Doji, Hammer, Engulfing, Three Black Crows, Morning Star, Dark Cloud Cover, etc.).", "name": "Pattern recognition", "order": 70 }, { "description": "Compute fundamental statistical metrics on price series—dispersion, regression, correlation, and forecasting components—for standalone analysis or as inputs to other models (e.g. STDDEV, VAR, LINEARREG, CORREL, TSF, BETA).", "name": "Statistic functions", "order": 80 }, { "name": "Math transform", "order": 90 } ], "description": "On-demand calculation of popular indicators (SMA, EMA, RSI, MACD, Bollinger Bands, etc.) over any supported time series. Streamline chart overlays, signal generation, and backtesting without external libraries.", "name": "Technical indicators", "order": 60 }, { "description": "Forward-looking and consensus analytics—earnings and revenue estimates, EPS trends and revisions, growth projections, analyst recommendations and ratings, price targets, and other consensus metrics. Perfect for incorporating expert forecasts and sentiment into your models and dashboards.", "name": "Analysis", "order": 70 }, { "description": "Compliance and filings data: insider transactions, SEC reports, governance documents, and more. Critical for audit trails, due-diligence workflows, and risk-management integrations.", "name": "Regulatory", "order": 80 }, { "description": "High-throughput and management endpoints for power users—submit and monitor batch jobs to pull large datasets asynchronously, track your API usage and quotas programmatically, and access other developer-focused tools for automating and scaling your data workflows.", "name": "Advanced", "order": 90 } ], "x-original-swagger-version": "2.0" }