{ "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
apikey=demo) available for demo requests& to separate multiple parameterssymbol=AAPL = symbol=aapl)null value handling in your application429 Too Many Requests).Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...UTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.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:\nExchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.\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:\n2021-10-27)today or yesterday2025-04-11T20:00:00) to retrieve the schedule corresponding to the day in the specified time.2025-04-11T20:00:00 UTC corresponds to:\n2025-04-11 in the America/New_York timezone2025-04-12 in the Australia/Sydney timezoneExchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.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:\nExchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...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:\nExchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval 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:\nUTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location\n\nExamples:\n&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...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"
}