openapi: 3.2.0
info:
description: "## Overview\n\nWelcome to Twelve Data developer docs — your gateway to comprehensive financial market data through a powerful and easy-to-use API.\nTwelve Data provides access to financial markets across over 50 global countries, covering more than 1 million public instruments, including stocks, forex, ETFs, mutual funds, commodities, and cryptocurrencies.\n\n## Quickstart\n\nTo get started, you'll need to sign up for an API key. Once you have your API key, you can start making requests to the API.\n\n### Step 1: Create Twelve Data account\n\nSign up on the Twelve Data website to create your account [here](https://twelvedata.com/register). This gives you access to the API dashboard and your API key.\n\n### Step 2: Get your API key\n\nAfter signing in, navigate to your [dashboard](https://twelvedata.com/account/api-keys) to find your unique API key. This key is required to authenticate all API and WebSocket requests.\n\n### Step 3: Make your first request\n\nTry a simple API call with cURL to fetch the latest price for Apple (AAPL):\n\n```\ncurl \"https://api.twelvedata.com/price?symbol=AAPL&apikey=your_api_key\"\n```\n\n### Step 4: Make a request from Python or Javascript\n\nUse our client libraries or standard HTTP clients to make API calls programmatically. Here’s an example in [Python](https://github.com/twelvedata/twelvedata-python) and [Node.js](https://github.com/twelvedata/twelvedata-node):\n\n#### Python (using official Twelve Data SDK):\n\n```python\nfrom twelvedata import TDClient\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Get latest price for Apple\nprice = td.price(symbol=\"AAPL\").as_json()\n\nprint(price)\n```\n\n#### JavaScript (Node.js):\n\n```javascript\nimport { MarketDataApi, CreateConfig } from \"@twelvedata/twelvedata-node\";\n\nconst config = CreateConfig('your_api_key');\nconst api = new MarketDataApi(config);\n\nasync function main() {\n const response = await api.getPrice({\n symbol: \"AAPL\",\n });\n console.log(response.data);\n}\n\nmain().catch(console.error);\n```\n\n### Step 5: Perform correlation analysis between Tesla and Microsoft prices\n\nFetch historical price data for Tesla (TSLA) and Microsoft (MSFT) and calculate the correlation of their closing prices:\n\n```python\nfrom twelvedata import TDClient\nimport pandas as pd\n\n# Initialize client with your API key\ntd = TDClient(apikey=\"your_api_key\")\n\n# Fetch historical price data for Tesla\ntsla_ts = td.time_series(\n symbol=\"TSLA\",\n interval=\"1day\",\n outputsize=100\n).as_pandas()\n\n# Fetch historical price data for Microsoft\nmsft_ts = td.time_series(\n symbol=\"MSFT\",\n interval=\"1day\",\n outputsize=100\n).as_pandas()\n\n# Align data on datetime index\ncombined = pd.concat(\n [tsla_ts['close'].astype(float), msft_ts['close'].astype(float)],\n axis=1,\n keys=[\"TSLA\", \"MSFT\"]\n).dropna()\n\n# Calculate correlation\ncorrelation = combined[\"TSLA\"].corr(combined[\"MSFT\"])\nprint(f\"Correlation of closing prices between TSLA and MSFT: {correlation:.2f}\")\n```\n\n### Authentication\n\nAuthenticate your requests using one of these methods:\n\n#### Query parameter method\n```\nGET https://api.twelvedata.com/endpoint?symbol=AAPL&apikey=your_api_key\n```\n\n#### HTTP header method (recommended)\n```\nAuthorization: apikey your_api_key\n```\n\n##### API key useful information\n
\n- Demo API key (
apikey=demo) available for demo requests \n- Personal API key required for full access
\n- Premium endpoints and data require higher-tier plans (testable with trial symbols)
\n
\n\n### API endpoints\n\n Service | Base URL |\n---------|----------|\n REST API | `https://api.twelvedata.com` |\n WebSocket | `wss://ws.twelvedata.com` |\n\n### Parameter guidelines\n\n- Separator: Use
& to separate multiple parameters \n- Case sensitivity: Parameter names are case-insensitive (
symbol=AAPL = symbol=aapl) \n- Multiple values: Separate with commas where supported
\n
\n\n### Response handling\n\n#### Default format\nAll responses return JSON format by default unless otherwise specified.\n\n#### Null values\nImportant: Some response fields may contain `null` values when data is unavailable for specific metrics. This is expected behavior, not an error.\n\n##### Best Practices:\n\n- Always implement
null value handling in your application \n- Use defensive programming techniques for data processing
\n- Consider fallback values or error handling for critical metrics
\n
\n\n#### Error handling\nStructure your code to gracefully handle:\n\n- Network timeouts
\n- Rate limiting responses
\n- Invalid parameter errors
\n- Data unavailability periods
\n
\n\n##### Best practices\n\n- Rate limits: Adhere to your plan’s rate limits to avoid throttling. Check your dashboard for details.
\n- Error handling: Implement retry logic for transient errors (e.g.,
429 Too Many Requests). \n- Caching: Cache responses for frequently accessed data to reduce API calls and improve performance.
\n- Secure storage: Store your API key securely and never expose it in client-side code or public repositories.
\n
\n\n## Errors\n\nTwelve Data API employs a standardized error response format, delivering a JSON object with `code`, `message`, and `status` keys for clear and consistent error communication.\n\n### Codes\n\nBelow is a table of possible error codes, their HTTP status, meanings, and resolution steps:\n\n Code | status | Meaning | Resolution |\n --- | --- | --- | --- |\n **400** | Bad Request | Invalid or incorrect parameter(s) provided. | Check the `message` in the response for details. Refer to the API Documentation to correct the input. |\n **401** | Unauthorized | Invalid or incorrect API key. | Verify your API key is correct. Sign up for a key here. |\n **403** | Forbidden | API key lacks permissions for the requested resource (upgrade required). | Upgrade your plan here. |\n **404** | Not Found | Requested data could not be found. | Adjust parameters to be less strict as they may be too restrictive. |\n **414** | Parameter Too Long | Input parameter array exceeds the allowed length. | Follow the `message` guidance to adjust the parameter length. |\n **429** | Too Many Requests | API request limit reached for your key. | Wait briefly or upgrade your plan here. |\n **500** | Internal Server Error | Server-side issue occurred; retry later. | Contact support here for assistance. |\n\n### Example error response\n\nConsider the following invalid request:\n\n```\nhttps://api.twelvedata.com/time_series?symbol=AAPL&interval=0.99min&apikey=your_api_key\n```\n\nDue to the incorrect `interval` value, the API returns:\n\n```json\n{\n \"code\": 400,\n \"message\": \"Invalid **interval** provided: 0.99min. Supported intervals: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month\",\n \"status\": \"error\"\n}\n```\n\nRefer to the API Documentation for valid parameter values to resolve such errors.\n\n## Libraries\n\nTwelve Data provides a growing ecosystem of libraries and integrations to help you build faster and smarter in your preferred environment. Official libraries are actively maintained by the Twelve Data team, while selected community-built libraries offer additional flexibility.\n\nA full list is available on our [GitHub profile](https://github.com/search?q=twelvedata).\n\n### Official SDKs\n\n\n### AI integrations\n\n- Twelve Data MCP Server: Repository — Model Context Protocol (MCP) server that provides seamless integration with AI assistants and language models, enabling direct access to Twelve Data's financial market data within conversational interfaces and AI workflows.
\n- Twelve Data integration for OpenClaw: Clawhub skill — Integration for the OpenClaw platform, allowing users to leverage Twelve Data's API within their OpenClaw applications.
\n- Twelve Data NEAR Agent: NEAR Agent — Access Twelve Data's API directly from NEAR's AI agent platform, enabling users to retrieve financial data and insights within their NEAR AI agent workflows.
\n
\n\n### Spreadsheet add-ons\n\n\n### Community libraries\n\nThe community has developed libraries in several popular languages. You can explore more community libraries on [GitHub](https://github.com/search?q=twelvedata).\n\n\n### Other Twelve Data repositories\n\n- searchindex (Go): Repository — In-memory search index by strings
\n- ws-tools (Python): Repository — Utility tools for WebSocket stream handling
\n
\n\n### API specification\n\n- OpenAPI / Swagger: Access the complete API specification in OpenAPI format. You can use this file to automatically generate client libraries in your preferred programming language, explore the API interactively via Swagger tools, or integrate Twelve Data seamlessly into your AI and LLM workflows.
\n
"
title: Twelve Data Technical Indicator API
version: 0.0.1
servers:
- url: https://api.twelvedata.com/
security:
- authorizationHeader:
- '[]'
- queryParameter:
- '[]'
tags:
- name: technical_indicator
paths:
/ad:
get:
description: The Accumulation/Distribution (AD) endpoint provides data on the cumulative money flow into and out of a financial instrument, using its closing price, price range, and trading volume. This endpoint returns the AD line, which helps users identify potential buying or selling pressure and assess the strength of price movements.
operationId: GetTimeSeriesAd
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAd_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Accumulation/distribution
tags:
- technical_indicator
x-additional-notes: Take note that this endpoint is applicable to all instruments except currencies.
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volume indicators
x-order: '10'
x-url-hash: ad-indicator
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/add:
get:
description: The Addition (ADD) endpoint calculates the sum of two input data series, such as technical indicators or price data, and returns the combined result. This endpoint is useful for users who need to aggregate data points to create custom indicators or analyze the combined effect of multiple data series in financial analysis.
operationId: GetTimeSeriesAdd
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '62'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAdd_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Addition
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '20'
x-url-hash: add
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/adosc:
get:
description: The Accumulation/Distribution Oscillator endpoint (ADOSC) calculates a momentum indicator that highlights shifts in buying or selling pressure by analyzing price and volume data over different time frames. It returns numerical values that help users identify potential trend reversals in financial markets.
operationId: GetTimeSeriesAdOsc
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '64'
x-go-name: SlowPeriod
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAdOsc_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Accumulation/distribution oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volume indicators
x-order: '30'
x-url-hash: adosc
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/adx:
get:
description: The Average Directional Index (ADX) endpoint provides data on the strength of a market trend, regardless of its direction. It returns a numerical value that helps users identify whether a market is trending or moving sideways.
operationId: GetTimeSeriesAdx
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAdx_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Average directional index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Momentum indicators
x-order: '40'
x-url-hash: adx
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/adxr:
get:
description: The Average Directional Movement Index Rating (ADXR) endpoint provides a smoothed measure of trend strength for a specified financial instrument. It returns the ADXR values, which help users assess the consistency of a trend over a given period by reducing short-term fluctuations. This endpoint is useful for traders and analysts who need to evaluate the stability of market trends for better timing of entry and exit points in their trading strategies.
operationId: GetTimeSeriesAdxr
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAdxr_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Average directional movement index rating
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '50'
x-url-hash: adxr
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/apo:
get:
description: The Absolute Price Oscillator (APO) endpoint calculates the difference between two specified moving averages of a financial instrument's price, providing data that helps users identify potential price trends and reversals. The response includes the calculated APO values over a specified time period, which can be used to track momentum changes and assess the strength of price movements.
operationId: GetTimeSeriesApo
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '64'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '64'
x-go-name: SlowPeriod
x-order: '64'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesApo_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Absolute price oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '60'
x-url-hash: apo
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/aroon:
get:
description: 'The Aroon Indicator endpoint provides data on the time elapsed since the highest high and lowest low within a specified period, helping users identify the presence and strength of market trends. It returns two values: Aroon Up and Aroon Down, which indicate the trend direction and momentum. This endpoint is useful for traders and analysts looking to assess trend patterns and potential reversals in financial markets.'
operationId: GetTimeSeriesAroon
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAroon_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Aroon indicator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '70'
x-url-hash: aroon
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/aroonosc:
get:
description: The Aroon Oscillator endpoint provides the calculated difference between the Aroon Up and Aroon Down indicators for a given financial instrument. It returns a time series of values that help users identify the strength and direction of a trend, as well as potential trend reversals. This data is useful for traders and analysts seeking to evaluate market trends over a specified period.
operationId: GetTimeSeriesAroonOsc
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAroonOsc_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Aroon oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '80'
x-url-hash: aroonosc
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/atr:
get:
description: The Average True Range (ATR) endpoint provides data on market volatility by calculating the average range of price movement over a user-defined period. It returns numerical values representing the ATR for each time interval, allowing users to gauge the degree of price fluctuation in a financial instrument. This data is useful for setting stop-loss levels and determining optimal entry and exit points in trading strategies.
operationId: GetTimeSeriesAtr
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAtr_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Average true range
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volatility indicators
x-order: '90'
x-url-hash: atr
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/avg:
get:
description: The Average (AVG) endpoint calculates the arithmetic mean of a specified data series over a chosen time period. It returns a smoothed dataset that helps users identify trends by reducing short-term fluctuations. This endpoint is useful for obtaining a clearer view of data trends, particularly in time series analysis.
operationId: GetTimeSeriesAvg
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAvg_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '100'
x-url-hash: avg
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/avgprice:
get:
description: The Average Price (AVGPRICE) endpoint calculates and returns the mean value of a security's open, high, low, and close prices. This endpoint provides a straightforward metric to assess the overall price level of a security over a specified period.
operationId: GetTimeSeriesAvgPrice
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesAvgPrice_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Average price
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '110'
x-url-hash: avgprice
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/bbands:
get:
description: 'The Bollinger Bands (BBANDS) endpoint calculates and returns three key data points: an upper band, a lower band, and a simple moving average (SMA) for a specified financial instrument. These bands are used to assess market volatility by showing how far prices deviate from the SMA. This information helps users identify potential price reversals and determine whether an asset is overbought or oversold.'
operationId: GetTimeSeriesBBands
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '63'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 20
format: int64
type: integer
x-go-name: TimePeriod
x-order: '64'
x-go-name: TimePeriod
x-order: '64'
- description: Number of standard deviations. Must be at least `1`
in: query
name: sd
schema:
default: 2
format: double
type: number
x-go-name: StandardDeviation
x-order: '62'
x-go-name: StandardDeviation
x-order: '62'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '61'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesBBands_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Bollinger bands
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Overlap studies
x-order: '120'
x-url-hash: bbands
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/beta:
get:
description: The Beta Indicator endpoint provides data on a security's sensitivity to market movements by comparing its price changes to a benchmark index. It returns the beta value, which quantifies the systematic risk of the security relative to the market. This information is useful for evaluating how much a security's price is expected to move in relation to market changes.
operationId: GetTimeSeriesBeta
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '61'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '63'
x-go-name: TimePeriod
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesBeta_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Beta indicator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '130'
x-url-hash: beta
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/bop:
get:
description: The Balance of Power (BOP) endpoint provides data on the buying and selling pressure of a security by analyzing its open, high, low, and close prices. It returns numerical values that help users detect shifts in market sentiment and potential price movements.
operationId: GetTimeSeriesBop
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesBop_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Balance of power
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '140'
x-url-hash: bop
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/cci:
get:
description: The Commodity Channel Index (CCI) endpoint provides data on the CCI values for a specified security, helping users detect potential price reversals by identifying overbought or oversold conditions. It returns a series of CCI values calculated over a specified time period, allowing users to assess the momentum of a security relative to its average price range.
operationId: GetTimeSeriesCci
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 20
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCci_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Commodity channel index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '150'
x-url-hash: cci
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ceil:
get:
description: The Ceiling (CEIL) endpoint rounds each value in the input data series up to the nearest whole number. It returns a series where each original data point is adjusted to its ceiling value, which can be useful for precise calculations or when integrating with other technical indicators that require integer inputs.
operationId: GetTimeSeriesCeil
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCeil_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Ceiling
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '160'
x-url-hash: ceil
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/cmo:
get:
description: The Chande Momentum Oscillator (CMO) endpoint provides data on the momentum of a security by calculating the relative strength of recent price movements. It returns a numerical value indicating whether a security is potentially overbought or oversold, assisting users in identifying possible trend reversals.
operationId: GetTimeSeriesCmo
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCmo_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Chande momentum oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '170'
x-url-hash: cmo
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/coppock:
get:
description: The Coppock Curve is a momentum oscillator used to detect potential long-term trend reversals in financial markets. It returns the calculated values of this indicator over a specified period, allowing users to identify when a security's price may be shifting from a downtrend to an uptrend. This endpoint is particularly useful for analyzing securities in bottoming markets.
operationId: GetTimeSeriesCoppock
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods for weighted moving average. Takes values in the range from `1` to `800`
in: query
name: wma_period
schema:
default: 10
format: int64
type: integer
x-go-name: WMAPeriod
x-order: '64'
x-go-name: WMAPeriod
x-order: '64'
- description: Number of periods for long term rate of change. Takes values in the range from `1` to `800`
in: query
name: long_roc_period
schema:
default: 14
format: int64
type: integer
x-go-name: LongRocPeriod
x-order: '61'
x-go-name: LongRocPeriod
x-order: '61'
- description: Number of periods for short term rate of change. Takes values in the range from `1` to `800`
in: query
name: short_roc_period
schema:
default: 11
format: int64
type: integer
x-go-name: ShortRocPeriod
x-order: '63'
x-go-name: ShortRocPeriod
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCoppock_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Coppock curve
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '180'
x-url-hash: coppock
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/correl:
get:
description: The Correlation (CORREL) endpoint calculates the statistical relationship between two securities over a specified time period, returning a correlation coefficient. This coefficient ranges from -1 to 1, indicating the strength and direction of their linear relationship. A value close to 1 suggests a strong positive correlation, while a value near -1 indicates a strong negative correlation. This data is useful for identifying securities that move together or in opposite directions, aiding in strategies like diversification or pairs trading.
operationId: GetTimeSeriesCorrel
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '62'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '63'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '64'
x-go-name: TimePeriod
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCorrel_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Correlation
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '190'
x-url-hash: correl
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/crsi:
get:
description: 'The Connors Relative Strength Index (CRSI) endpoint provides a detailed analysis of stock momentum by combining three components: the Relative Strength Index, the Rate of Change, and the Up/Down Length. This endpoint returns a numerical value that helps identify potential trend reversals and momentum shifts in a security''s price. Ideal for traders seeking to refine entry and exit points, the CRSI offers a nuanced view of market conditions beyond traditional RSI indicators.'
operationId: GetTimeSeriesCrsi
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '63'
- description: Number of periods for RSI used to calculate price momentum. Takes values in the range from `1` to `800`
in: query
name: rsi_period
schema:
default: 3
format: int64
type: integer
x-go-name: RsiPeriod
x-order: '62'
x-go-name: RsiPeriod
x-order: '62'
- description: Number of periods for RSI used to calculate up/down trend. Takes values in the range from `1` to `800`
in: query
name: up_down_length
schema:
default: 2
format: int64
type: integer
x-go-name: UpDownLength
x-order: '64'
x-go-name: UpDownLength
x-order: '64'
- description: Number of periods used to calculate PercentRank. Takes values in the range from `1` to `800`
in: query
name: percent_rank_period
schema:
default: 100
format: int64
type: integer
x-go-name: PercentRankPeriod
x-order: '61'
x-go-name: PercentRankPeriod
x-order: '61'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesCrsi_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Connors relative strength index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '200'
x-url-hash: crsi
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/dema:
get:
description: The Double Exponential Moving Average (DEMA) endpoint provides a data series that calculates a moving average with reduced lag by emphasizing recent price data. This endpoint returns time-series data that includes the DEMA values for a specified financial instrument, allowing users to track price trends and identify potential trading opportunities.
operationId: GetTimeSeriesDema
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesDema_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Double exponential moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '210'
x-url-hash: dema
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/div:
get:
description: The Division (DIV) endpoint calculates the result of dividing one data series by another, providing a normalized output. It is commonly used to combine or adjust multiple technical indicators or price data for comparative analysis. This endpoint returns the division results as a time series, allowing users to easily interpret and utilize the normalized data in their financial models or charts.
operationId: GetTimeSeriesDiv
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '62'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesDiv_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Division
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '220'
x-url-hash: div
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/dpo:
get:
description: The Detrended Price Oscillator (DPO) endpoint calculates and returns the DPO values for a specified financial instrument over a given time period. This endpoint helps traders by highlighting short-term price cycles and identifying potential overbought or oversold conditions without the influence of long-term trends. The response includes a series of DPO values, which can be used to assess price momentum and cyclical patterns in the market.
operationId: GetTimeSeriesDpo
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specifies if there should be a shift to match the current price
in: query
name: centered
schema:
default: false
type: boolean
x-go-name: Centered
x-order: '62'
x-go-name: Centered
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesDpo_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Detrended price oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '230'
x-url-hash: dpo
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/dx:
get:
description: Retrieve the Directional Movement Index (DX) values for a given security to assess the strength of its positive and negative price movements. This endpoint provides a time series of DX values, which are useful for evaluating the momentum and trend direction of the security over a specified period.
operationId: GetTimeSeriesDx
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesDx_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Directional movement index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '240'
x-url-hash: dx
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/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:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesEma_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Exponential moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Overlap studies
x-order: '250'
x-url-hash: ema
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/exp:
get:
description: The Exponential (EXP) Indicator endpoint computes the exponential value of a specified input, providing a numerical result that is commonly applied in complex mathematical and financial computations.
operationId: GetTimeSeriesExp
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesExp_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Exponential
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '260'
x-url-hash: exp
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/floor:
get:
description: The Floor (FLOOR) endpoint processes numerical input data by rounding each value down to the nearest integer. It returns a series of adjusted data points that can be used for further calculations or combined with other datasets. This endpoint is useful for users needing to simplify data by removing decimal precision, aiding in scenarios where integer values are required.
operationId: GetTimeSeriesFloor
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesFloor_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Floor
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '270'
x-url-hash: floor
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/heikinashicandles:
get:
description: The heikinashi candles endpoint provides smoothed candlestick data by averaging price information to reduce market noise. It returns a series of Heikin Ashi candles, which include open, high, low, and close values, making it easier to identify trends and potential reversals in asset prices. This endpoint is useful for traders and analysts seeking a clearer view of market trends without the volatility present in traditional candlestick charts.
operationId: GetTimeSeriesHeikinashiCandles
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHeikinashiCandles_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Heikinashi candles
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '280'
x-url-hash: heikinashicandles
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/hlc3:
get:
description: The High, Low, Close Average (HLC3) endpoint calculates and returns the average of a security's high, low, and close prices for a specified period. This endpoint provides a straightforward metric to assess price trends, helping users quickly identify the average price level of a security over time.
operationId: GetTimeSeriesHlc3
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHlc3_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: High, low, close average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '290'
x-url-hash: hlc3
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_dcperiod:
get:
description: The Hilbert Transform Dominant Cycle Period (HT_DCPERIOD) endpoint calculates the dominant cycle length of a financial instrument's price data. It returns a numerical value representing the cycle period, which traders can use to identify prevailing market cycles and adjust their trading strategies accordingly.
operationId: GetTimeSeriesHtDcPeriod
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtDcPeriod_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform dominant cycle period
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Cycle indicators
x-order: '300'
x-url-hash: ht-dcperiod
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_dcphase:
get:
description: The Hilbert Transform Dominant Cycle Phase (HT_DCPHASE) endpoint provides the current phase of the dominant market cycle for a given financial instrument. It returns numerical data indicating the phase angle, which can be used by traders to identify potential market entry and exit points based on cyclical patterns.
operationId: GetTimeSeriesHtDcPhase
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtDcPhase_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform dominant cycle phase
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Cycle indicators
x-order: '305'
x-url-hash: ht-dcphase
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_phasor:
get:
description: 'The Hilbert Transform Phasor Components (HT_PHASOR) endpoint analyzes a price series to return two key components: in-phase and quadrature. These components help identify cyclical patterns and the direction of trends in the data. Use this endpoint to gain precise insights into the timing and strength of market cycles, enhancing your ability to track and predict price movements.'
operationId: GetTimeSeriesHtPhasor
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtPhasor_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform phasor components
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Cycle indicators
x-order: '310'
x-url-hash: ht-phasor
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_sine:
get:
description: The Hilbert Transform Sine Wave (HT_SINE) endpoint provides sine and cosine wave components derived from the dominant market cycle. This data helps traders pinpoint potential market turning points and assess trend directions by analyzing cyclical patterns.
operationId: GetTimeSeriesHtSine
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtSine_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform sine wave
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Cycle indicators
x-order: '320'
x-url-hash: ht-sine
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_trendline:
get:
description: The Hilbert Transform Instantaneous Trendline (HT_TRENDLINE) endpoint provides a smoothed moving average that aligns with the dominant market cycle. It returns data points that help traders identify current market trends and determine potential entry or exit points in trading.
operationId: GetTimeSeriesHtTrendline
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtTrendline_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform instantaneous trendline
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '330'
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ht_trendmode:
get:
description: The Hilbert Transform Trend vs Cycle Mode (HT_TRENDMODE) endpoint identifies whether a market is in a trending or cyclical phase. It returns data indicating the current market phase, allowing users to adjust their trading strategies based on the prevailing conditions.
operationId: GetTimeSeriesHtTrendMode
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesHtTrendMode_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Hilbert transform trend vs cycle mode
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Cycle indicators
x-order: '340'
x-url-hash: ht-trendmode
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ichimoku:
get:
description: The Ichimoku Cloud endpoint provides data on the Ichimoku Kinko Hyo indicator, offering insights into trend direction, support and resistance levels, and potential entry and exit points. It returns key components such as the Tenkan-sen, Kijun-sen, Senkou Span A, Senkou Span B, and Chikou Span. This data helps users evaluate market trends and identify strategic trading opportunities.
operationId: GetTimeSeriesIchimoku
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The time period used for generating the conversation line. Takes values in the range from `1` to `800`
in: query
name: conversion_line_period
schema:
default: 9
format: int64
type: integer
x-go-name: ConversionLinePeriod
x-order: '61'
x-go-name: ConversionLinePeriod
x-order: '61'
- description: The time period used for generating the base line. Takes values in the range from `1` to `800`
in: query
name: base_line_period
schema:
default: 26
format: int64
type: integer
x-go-name: BaseLinePeriod
x-order: '62'
x-go-name: BaseLinePeriod
x-order: '62'
- description: The time period used for generating the leading span B line. Takes values in the range from `1` to `800`
in: query
name: leading_span_b_period
schema:
default: 52
format: int64
type: integer
x-go-name: LeadingSpanBPeriod
x-order: '63'
x-go-name: LeadingSpanBPeriod
x-order: '63'
- description: The time period used for generating the lagging span line. Takes values in the range from `1` to `800`
in: query
name: lagging_span_period
schema:
default: 26
format: int64
type: integer
x-go-name: LaggingSpanPeriod
x-order: '64'
x-go-name: LaggingSpanPeriod
x-order: '64'
- description: Indicates whether to include ahead span period
in: query
name: include_ahead_span_period
schema:
default: true
type: boolean
x-go-name: IncludeAheadSpanPeriod
x-order: '65'
x-go-name: IncludeAheadSpanPeriod
x-order: '65'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesIchimoku_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Ichimoku cloud
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '350'
x-url-hash: ichimoku
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/kama:
get:
description: The Kaufman Adaptive Moving Average (KAMA) endpoint calculates the KAMA for a specified financial instrument, returning a time series of values that reflect the average price adjusted for market volatility. This endpoint helps users identify trends by smoothing out price fluctuations while remaining sensitive to significant price movements.
operationId: GetTimeSeriesKama
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesKama_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Kaufman adaptive moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '360'
x-url-hash: kama
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/keltner:
get:
description: The Keltner Channel endpoint provides data for a volatility-based technical indicator that combines the Exponential Moving Average (EMA) and the Average True Range (ATR) to form a channel around a security's price. This endpoint returns the upper, middle, and lower bands of the channel, which can be used to identify potential overbought or oversold conditions, assess trend direction, and detect possible price breakouts.
operationId: GetTimeSeriesKeltner
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 20
format: int64
type: integer
x-go-name: TimePeriod
x-order: '61'
x-go-name: TimePeriod
x-order: '61'
- description: The time period used for calculating the Average True Range. Takes values in the range from `1` to `800`
in: query
name: atr_time_period
schema:
default: 10
format: int64
type: integer
x-go-name: ATRTimePeriod
x-order: '62'
x-go-name: ATRTimePeriod
x-order: '62'
- description: The factor used to adjust the indicator's sensitivity
in: query
name: multiplier
schema:
default: 2
format: int64
type: integer
x-go-name: Multiplier
x-order: '63'
x-go-name: Multiplier
x-order: '63'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '64'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '65'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesKeltner_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Keltner channel
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '370'
x-url-hash: keltner
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/kst:
get:
description: The Know Sure Thing (KST) endpoint provides a momentum oscillator that combines four smoothed rates of change into a single trend-following indicator. This endpoint returns data that helps users identify potential trend reversals, as well as overbought or oversold conditions in the market.
operationId: GetTimeSeriesKst
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The time period for the first Rate of Change calculation.
in: query
name: roc_period_1
schema:
default: 10
format: int64
type: integer
x-go-name: RocPeriod1
x-order: '61'
x-go-name: RocPeriod1
x-order: '61'
- description: The time period for the second Rate of Change calculation.
in: query
name: roc_period_2
schema:
default: 15
format: int64
type: integer
x-go-name: RocPeriod2
x-order: '61'
x-go-name: RocPeriod2
x-order: '61'
- description: The time period for the third Rate of Change calculation.
in: query
name: roc_period_3
schema:
default: 20
format: int64
type: integer
x-go-name: RocPeriod3
x-order: '61'
x-go-name: RocPeriod3
x-order: '61'
- description: The time period for the forth Rate of Change calculation.
in: query
name: roc_period_4
schema:
default: 30
format: int64
type: integer
x-go-name: RocPeriod4
x-order: '61'
x-go-name: RocPeriod4
x-order: '61'
- description: The time period for the first Simple Moving Average.
in: query
name: sma_period_1
schema:
default: 10
format: int64
type: integer
x-go-name: SmaPeriod1
x-order: '62'
x-go-name: SmaPeriod1
x-order: '62'
- description: The time period for the second Simple Moving Average.
in: query
name: sma_period_2
schema:
default: 10
format: int64
type: integer
x-go-name: SmaPeriod2
x-order: '62'
x-go-name: SmaPeriod2
x-order: '62'
- description: The time period for the third Simple Moving Average.
in: query
name: sma_period_3
schema:
default: 10
format: int64
type: integer
x-go-name: SmaPeriod3
x-order: '62'
x-go-name: SmaPeriod3
x-order: '62'
- description: The time period for the forth Simple Moving Average.
in: query
name: sma_period_4
schema:
default: 15
format: int64
type: integer
x-go-name: SmaPeriod4
x-order: '62'
x-go-name: SmaPeriod4
x-order: '62'
- description: The time period used for generating the signal line.
in: query
name: signal_period
schema:
default: 9
format: int64
type: integer
x-go-name: SignalPeriod
x-order: '63'
x-go-name: SignalPeriod
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesKst_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Know sure thing
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '380'
x-url-hash: kst
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/linearreg:
get:
description: The Linear Regression endpoint (LINEARREG) calculates the best-fit straight line through a series of financial data points. It returns the slope and intercept values of this line, allowing users to determine the overall direction of a market trend and identify potential support or resistance levels.
operationId: GetTimeSeriesLinearReg
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62.'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '63'
x-go-name: TimePeriod
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLinearReg_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Linear regression
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '390'
x-url-hash: linearreg
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/linearregangle:
get:
description: The Linear Regression Angle endpoint (LINEARREGANGLE) calculates the angle of the linear regression line for a given time series of stock prices. It returns the slope of the trend line, expressed in degrees, which helps users identify the direction and steepness of a trend over a specified period. This data is useful for detecting upward or downward trends in asset prices.
operationId: GetTimeSeriesLinearRegAngle
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLinearRegAngle_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Linear regression angle
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '400'
x-url-hash: linearregangle
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/linearregintercept:
get:
description: The Linear Regression Intercept endpoint (LINEARREGINTERCEPT) calculates the y-intercept of a linear regression line for a given dataset. It returns the value where the regression line crosses the y-axis, providing a numerical reference point for understanding the starting position of a trend over a specified period. This can be useful for users needing to establish baseline values in their data analysis.
operationId: GetTimeSeriesLinearRegIntercept
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLinearRegIntercept_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Linear regression intercept
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '410'
x-url-hash: linearregintercept
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/linearregslope:
get:
description: The Linear Regression Slope endpoint (LINEARREGSLOPE) calculates the slope of a linear regression line for a given dataset, reflecting the rate of change in the data trend over a specified period. It returns a numerical value representing this slope, which can be used to assess the direction and strength of the trend in the dataset.
operationId: GetTimeSeriesLinearRegSlope
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLinearRegSlope_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Linear regression slope
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '420'
x-url-hash: linearregslope
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ln:
get:
description: The Natural Logarithm (LN) endpoint computes the natural logarithm of a specified input value, returning a numerical result. This endpoint is useful for users needing to perform logarithmic transformations on data, which can be applied in various financial calculations and advanced mathematical analyses.
operationId: GetTimeSeriesLn
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLn_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Natural logarithm
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '430'
x-url-hash: ln
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/log10:
get:
description: The Base-10 Logarithm (LOG10) endpoint computes the base-10 logarithm of a specified input value. It returns a numerical result that represents the power to which the number 10 must be raised to obtain the input value. This endpoint is useful for transforming data into a logarithmic scale, which can simplify the analysis of exponential growth patterns or compress large ranges of data in financial calculations.
operationId: GetTimeSeriesLog10
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesLog10_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Base-10 logarithm
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '440'
x-url-hash: log10
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ma:
get:
description: The Moving Average (MA) endpoint provides the average price of a security over a specified time frame, offering a smoothed representation of price data. This endpoint returns the calculated moving average values, which can assist users in identifying price trends and potential support or resistance levels in the market.
operationId: GetTimeSeriesMa
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '63'
x-go-name: TimePeriod
x-order: '63'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMa_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '450'
x-url-hash: ma
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/macd:
get:
description: This endpoint calculates the Moving Average Convergence Divergence (MACD) for a specified financial instrument. It returns the MACD line, signal line, and histogram values, which help users identify potential trend reversals and trading opportunities by analyzing the relationship between two moving averages.
operationId: GetTimeSeriesMacd
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '63'
x-go-name: SlowPeriod
x-order: '63'
- description: The time period used for generating the signal line.
in: query
name: signal_period
schema:
default: 9
format: int64
type: integer
x-go-name: SignalPeriod
x-order: '64'
x-go-name: SignalPeriod
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMacd_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Moving average convergence divergence
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Momentum indicators
x-order: '460'
x-url-hash: macd
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/macd_slope:
get:
description: The Moving Average Convergence Divergence (MACD) Slope endpoint provides the rate of change of the MACD line for a given security. It returns data on how quickly the MACD line is rising or falling, offering insights into the momentum shifts in the security's price. This information is useful for traders looking to gauge the speed of price movements and potential trend reversals.
operationId: GetTimeSeriesMacdSlope
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '63'
x-go-name: SlowPeriod
x-order: '63'
- description: The time period used for generating the signal line.
in: query
name: signal_period
schema:
default: 9
format: int64
type: integer
x-go-name: SignalPeriod
x-order: '64'
x-go-name: SignalPeriod
x-order: '64'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '64'
x-go-name: TimePeriod
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMacdSlope_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Moving average convergence divergence slope
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '470'
x-starting-plan: pro,venture
x-url-hash: macd-slope
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/macdext:
get:
description: The Moving Average Convergence Divergence Extension (MACDEXT) endpoint provides a customizable version of the MACD indicator, allowing users to specify different moving average types and parameters. It returns data that includes the MACD line, signal line, and histogram values, tailored to the user's chosen settings. This endpoint is useful for traders who require flexibility in analyzing price trends and momentum by adjusting the calculation methods to fit their specific trading strategies.
operationId: GetTimeSeriesMacdExt
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: The type of fast moving average used in the calculation.
in: query
name: fast_ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: FastMAType
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '63'
x-go-name: SlowPeriod
x-order: '63'
- description: The type of slow moving average used in the calculation.
in: query
name: slow_ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: SlowMAType
x-order: '63'
- description: The time period used for generating the signal line.
in: query
name: signal_period
schema:
default: 9
format: int64
type: integer
x-go-name: SignalPeriod
x-order: '64'
x-go-name: SignalPeriod
x-order: '64'
- description: The type of fast moving average used for generating the signal line.
in: query
name: signal_ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: SignalMAType
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMacdExt_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Moving average convergence divergence extension
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '480'
x-url-hash: macdext
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/mama:
get:
description: The MESA Adaptive Moving Average (MAMA) endpoint calculates a moving average that adjusts to the dominant market cycle, offering a balance between quick response to price changes and noise reduction. It returns data that includes the adaptive moving average values, which can be used to identify trends and potential reversal points.
operationId: GetTimeSeriesMama
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: The limit for the fast moving average.
in: query
name: fast_limit
schema:
default: 0.5
format: double
type: number
x-go-name: FastLimit
x-order: '62'
x-go-name: FastLimit
x-order: '62'
- description: The limit for the slow moving average.
in: query
name: slow_limit
schema:
default: 0.05
format: double
type: number
x-go-name: SlowLimit
x-order: '63'
x-go-name: SlowLimit
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMama_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: MESA adaptive moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '490'
x-url-hash: mama
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/max:
get:
description: The Maximum (MAX) endpoint calculates and returns the highest value within a specified data series over a given period. This endpoint is useful for identifying potential resistance levels or detecting extreme price movements in financial data.
operationId: GetTimeSeriesMax
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMax_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Maximum
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '500'
x-url-hash: max
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/maxindex:
get:
description: The Maximum Index (MAXINDEX) endpoint identifies the position of the highest value within a specified data series over a given time frame. It returns the index where the peak value occurs, allowing users to pinpoint when the maximum price or value was reached in the series. This is useful for tracking the timing of significant peaks in financial data.
operationId: GetTimeSeriesMaxIndex
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMaxIndex_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Maximum Index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '510'
x-url-hash: maxindex
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/mcginley_dynamic:
get:
description: This endpoint calculates the McGinley Dynamic (MCGINLEY_DYNAMIC) indicator, which provides a refined moving average that adapts to market volatility. This endpoint returns data that reflects smoother price trends and identifies potential support or resistance levels more accurately than traditional moving averages. It is useful for users seeking to track price movements with reduced lag and enhanced responsiveness to market changes.
operationId: GetTimeSeriesMcGinleyDynamic
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMcGinleyDynamic_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: McGinley dynamic indicator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '520'
x-url-hash: mcginley-dynamic
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/medprice:
get:
description: The Median Price (MEDPRICE) endpoint calculates and returns the average of the high and low prices of a security for a specified period. This endpoint provides a simplified view of price movements, helping users quickly assess price trends by focusing on the midpoint of price action.
operationId: GetTimeSeriesMedPrice
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMedPrice_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Median price
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '530'
x-url-hash: medprice
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/mfi:
get:
description: The Money Flow Index (MFI) endpoint provides a volume-weighted momentum oscillator that quantifies buying and selling pressure by analyzing positive and negative money flow. It returns data indicating potential overbought or oversold conditions in a financial asset, aiding users in understanding market trends and price movements.
operationId: GetTimeSeriesMfi
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMfi_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Money flow index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '540'
x-url-hash: mfi
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/midpoint:
get:
description: The Midpoint (MIDPOINT) endpoint calculates the average value between the highest and lowest prices of a financial instrument over a specified period. It returns a time series of midpoint values, which can help users identify price trends and smooth out short-term fluctuations in the data.
operationId: GetTimeSeriesMidPoint
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMidPoint_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Midpoint
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '550'
x-url-hash: midpoint
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/midprice:
get:
description: The Midprice (MIDPRICE) endpoint calculates and returns the average of a financial instrument's highest and lowest prices over a specified time period. This data provides a smoothed representation of price movements, helping users identify potential support or resistance levels in the market.
operationId: GetTimeSeriesMidPrice
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMidPrice_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Midprice
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '560'
x-url-hash: midprice
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/min:
get:
description: The Minimum (MIN) Indicator endpoint provides the lowest value of a specified data series over a chosen time period. This endpoint is useful for identifying potential support levels or detecting extreme price movements in financial data.
operationId: GetTimeSeriesMin
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMin_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minimum
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '570'
x-url-hash: min
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/minindex:
get:
description: The Minimum Index (MININDEX) endpoint identifies the position of the lowest value within a specified data series over a given time frame. It returns the index number corresponding to the earliest occurrence of this minimum value. This is useful for pinpointing when the lowest price or value occurred in a dataset, aiding in time-based analysis of data trends.
operationId: GetTimeSeriesMinIndex
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMinIndex_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minimum index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '580'
x-url-hash: minindex
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/minmax:
get:
description: The Minimum and Maximum (MINMAX) endpoint identifies the lowest and highest values within a specified time frame for a given data series. It returns these extreme values, which can be used to detect potential support and resistance levels or significant price fluctuations in the data.
operationId: GetTimeSeriesMinMax
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMinMax_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minimum and maximum
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '590'
x-url-hash: minmax
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/minmaxindex:
get:
description: The Minimum and Maximum Index (MINMAXINDEX) endpoint identifies the positions of the lowest and highest values within a specified data series period. It returns indices that indicate when these extreme values occur, allowing users to pinpoint significant price changes over time.
operationId: GetTimeSeriesMinMaxIndex
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMinMaxIndex_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minimum and maximum index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '600'
x-url-hash: minmaxindex
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/minus_di:
get:
description: The Minus Directional Indicator (MINUS_DI) endpoint calculates and returns the strength of a security's downward price movement over a specified period. This data is useful for traders and analysts looking to identify bearish trends and assess the intensity of price declines in financial markets.
operationId: GetTimeSeriesMinusDI
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMinusDI_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minus directional indicator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '610'
x-url-hash: minus-di
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/minus_dm:
get:
description: The Minus Directional Movement endpoint (MINUS_DM) calculates the downward price movement of a security over a specified period. It returns a series of values indicating the strength of downward trends, useful for traders to identify potential selling opportunities or confirm bearish market conditions.
operationId: GetTimeSeriesMinusDM
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMinusDM_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Minus directional movement
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '620'
x-url-hash: minus-dm
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/mom:
get:
description: The Momentum (MOM) endpoint provides data on the rate of change in a security's price over a user-defined period. It returns a series of numerical values indicating the speed and direction of the price movement, which can help users detect emerging trends or potential reversals in the market.
operationId: GetTimeSeriesMom
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMom_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Momentum
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '630'
x-url-hash: mom
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/mult:
get:
description: The Multiplication (MULT) endpoint calculates the product of two input data series, returning a new data series that represents the element-wise multiplication of the inputs. This is useful for combining or adjusting technical indicators or price data to create custom metrics or to normalize values across different scales.
operationId: GetTimeSeriesMult
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '62'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesMult_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Multiplication
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '640'
x-url-hash: mult
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/natr:
get:
description: The Normalized Average True Range (NATR) endpoint provides a volatility indicator that calculates the average range of price movement over a specified period, expressed as a percentage of the security's price. This data allows users to compare volatility levels across different securities easily. The endpoint returns a time series of NATR values, which can be used to assess and compare the price volatility of various financial instruments.
operationId: GetTimeSeriesNatr
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesNatr_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Normalized average true range
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volatility indicators
x-order: '650'
x-url-hash: natr
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/obv:
get:
description: The On Balance Volume (OBV) endpoint provides a time series of the OBV indicator, which calculates cumulative volume to reflect buying and selling pressure over time. This endpoint returns data that helps users track volume trends in relation to price movements, aiding in the identification of potential trend continuations or reversals in a security's price.
operationId: GetTimeSeriesObv
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesObv_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: On balance volume
tags:
- technical_indicator
x-additional-notes: Take note that this endpoint is applicable to all instruments except currencies.
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volume indicators
x-order: '660'
x-url-hash: obv
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/percent_b:
get:
description: The Percent B (%B) endpoint calculates and returns the %B value, which indicates the position of a security's price relative to its Bollinger Bands. This data helps users determine if a security is near the upper or lower band, potentially signaling overbought or oversold conditions.
operationId: GetTimeSeriesPercent_B
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: The standard deviation applied in the calculation. Must be at least `1`
in: query
name: sd
schema:
default: 2
format: double
type: number
x-go-name: StandardDeviation
x-order: '63'
x-go-name: StandardDeviation
x-order: '63'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesPercent_B_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Percent B
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Momentum indicators
x-order: '670'
x-url-hash: percent-b
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/pivot_points_hl:
get:
description: The Pivot Points High Low (PIVOT_POINTS_HL) endpoint calculates key support and resistance levels for a security by analyzing its highest and lowest prices over a specified period. This endpoint returns data that includes pivot points, support levels, and resistance levels, which can be used to identify potential price reversal zones and optimize trade entry and exit strategies.
operationId: GetTimeSeriesPivotPointsHL
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 10
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesPivotPointsHL_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Pivot points high low
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '680'
x-starting-plan: pro,venture
x-url-hash: pivot-points-hl
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/plus_di:
get:
description: The Plus Directional Indicator endpoint (/plus_di) provides data on the strength of a security's upward price movement by calculating the Plus Directional Indicator (PLUS_DI). It returns a time series of PLUS_DI values, which can be used to assess the intensity of upward trends in a security's price over a specified period.
operationId: GetTimeSeriesPlusDI
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesPlusDI_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Plus directional indicator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '690'
x-url-hash: plus-di
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/plus_dm:
get:
description: The Plus Directional Movement (PLUS_DM) endpoint calculates the upward price movement of a financial security over a specified period. It returns numerical values representing the magnitude of upward price changes, which can be used to assess the strength of an uptrend. This data is essential for traders and analysts who need to evaluate the bullish momentum of a security.
operationId: GetTimeSeriesPlusDM
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesPlusDM_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Plus directional movement
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '700'
x-url-hash: plus-dm
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ppo:
get:
description: The Percentage Price Oscillator (PPO) endpoint calculates the percentage difference between two specified moving averages of a financial instrument's price. It returns data that includes the PPO values, which traders can use to identify potential trend reversals and generate trading signals.
operationId: GetTimeSeriesPpo
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods for fast moving average. Takes values in the range from `1` to `800`
in: query
name: fast_period
schema:
default: 12
format: int64
type: integer
x-go-name: FastPeriod
x-order: '62'
x-go-name: FastPeriod
x-order: '62'
- description: Number of periods for slow moving average. Takes values in the range from `1` to `800`
in: query
name: slow_period
schema:
default: 26
format: int64
type: integer
x-go-name: SlowPeriod
x-order: '63'
x-go-name: SlowPeriod
x-order: '63'
- description: The type of moving average used
in: query
name: ma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: MAType
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesPpo_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Percentage price oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '710'
x-url-hash: ppo
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/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:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRoc_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Rate of change
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '720'
x-url-hash: roc
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/rocp:
get:
description: The Rate of Change Percentage (ROCP) endpoint calculates and returns the percentage change in the price of a financial security over a user-defined period. This data helps users identify shifts in price momentum and potential trend reversals by providing a clear numerical representation of how much the price has increased or decreased in percentage terms.
operationId: GetTimeSeriesRocp
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRocp_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Rate of change percentage
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '730'
x-url-hash: rocp
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/rocr:
get:
description: The Rate of Change Ratio (ROCR) endpoint calculates and returns the ratio of a security's current price to its price from a specified number of periods ago. This data helps users track price momentum and identify potential trend reversals by providing a clear numerical value that reflects price changes over time.
operationId: GetTimeSeriesRocr
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRocr_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Rate of change ratio
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '740'
x-url-hash: rocr
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/rocr100:
get:
description: The Rate of Change Ratio 100 (ROCR100) endpoint calculates the percentage change in a security's price over a specified period, expressed as a ratio to 100. It returns data that highlights the momentum of the price movement and identifies potential trend reversals. This endpoint is useful for users looking to assess the strength and direction of a security's price trend over time.
operationId: GetTimeSeriesRocr100
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRocr100_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Rate of change ratio 100
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '750'
x-url-hash: rocr100
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/rsi:
get:
description: The Relative Strength Index (RSI) endpoint provides data on the RSI values for a specified financial instrument over a given period. It returns a series of RSI values, which indicate the momentum of price movements and help identify potential overbought or oversold conditions. This data is useful for traders looking to assess the strength of price trends and anticipate possible trend reversals.
operationId: GetTimeSeriesRsi
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRsi_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Relative strength index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Momentum indicators
x-order: '760'
x-url-hash: rsi
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/rvol:
get:
description: The Relative Volume endpoint (/rvol) provides a ratio comparing a security's current trading volume to its average volume over a specified period. This data helps users detect unusual trading activity and assess the strength of price movements, offering insights into potential market breakouts.
operationId: GetTimeSeriesRvol
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesRvol_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Relative volume
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volume indicators
x-order: '770'
x-starting-plan: grow,venture
x-url-hash: rvol
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sar:
get:
description: The Parabolic Stop and Reverse (SAR) endpoint provides data on potential support and resistance levels for a specified security, using its price and time. This endpoint returns numerical values that help traders determine possible entry and exit points in their trading strategies.
operationId: GetTimeSeriesSar
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The rate of change in the indicator's values.
in: query
name: acceleration
schema:
default: 0.02
format: double
type: number
x-go-name: Acceleration
x-order: '61'
x-go-name: Acceleration
x-order: '61'
- description: The maximum value considered for the indicator calculation.
in: query
name: maximum
schema:
default: 0.2
format: double
type: number
x-go-name: Maximum
x-order: '62'
x-go-name: Maximum
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSar_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Parabolic stop and reverse
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '780'
x-starting-plan: grow,venture
x-url-hash: sar
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sarext:
get:
description: The Parabolic SAR Extended (SAREXT) endpoint provides a customizable version of the Parabolic SAR indicator, which is used to identify potential entry and exit points in trading. Users can adjust parameters such as acceleration factors to tailor the indicator to specific trading strategies. The endpoint returns data points indicating potential trend reversals.
operationId: GetTimeSeriesSarExt
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The initial value for the indicator calculation.
in: query
name: start_value
schema:
default: 0
format: double
type: number
x-go-name: StartValue
x-order: '61'
x-go-name: StartValue
x-order: '61'
- description: The adjustment applied when the indicator's direction changes.
in: query
name: offset_on_reverse
schema:
default: 0
format: double
type: number
x-go-name: OffsetOnReverse
x-order: '62'
x-go-name: OffsetOnReverse
x-order: '62'
- description: The maximum acceleration value for long positions.
in: query
name: acceleration_limit_long
schema:
default: 0.02
format: double
type: number
x-go-name: AccelerationLimitLong
x-order: '63'
x-go-name: AccelerationLimitLong
x-order: '63'
- description: The acceleration value for long positions.
in: query
name: acceleration_long
schema:
default: 0.02
format: double
type: number
x-go-name: AccelerationLong
x-order: '63'
x-go-name: AccelerationLong
x-order: '63'
- description: The highest allowed acceleration for long positions.
in: query
name: acceleration_max_long
schema:
default: 0.2
format: double
type: number
x-go-name: AccelerationMaxLong
x-order: '63'
x-go-name: AccelerationMaxLong
x-order: '63'
- description: The maximum acceleration value for short positions.
in: query
name: acceleration_limit_short
schema:
default: 0.02
format: double
type: number
x-go-name: AccelerationLimitShort
x-order: '64'
x-go-name: AccelerationLimitShort
x-order: '64'
- description: The acceleration value for short positions.
in: query
name: acceleration_short
schema:
default: 0.02
format: double
type: number
x-go-name: AccelerationShort
x-order: '64'
x-go-name: AccelerationShort
x-order: '64'
- description: The highest allowed acceleration for short positions.
in: query
name: acceleration_max_short
schema:
default: 0.2
format: double
type: number
x-go-name: AccelerationMaxShort
x-order: '65'
x-go-name: AccelerationMaxShort
x-order: '65'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSarExt_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Parabolic stop and reverse extended
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '790'
x-url-hash: sarext
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sma:
get:
description: The Simple Moving Average (SMA) endpoint calculates and returns the average price of a security over a user-defined time period. This endpoint provides a series of data points that represent the smoothed price trend, which can help users identify potential price movements and evaluate historical price behavior.
operationId: GetTimeSeriesSma
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSma_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Simple moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Overlap studies
x-order: '800'
x-url-hash: sma
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sqrt:
get:
description: The Square Root (SQRT) endpoint computes the square root of a specified numerical input. It returns a single numerical value representing the square root, which can be used in various mathematical computations or financial models requiring this specific transformation.
operationId: GetTimeSeriesSqrt
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSqrt_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Square root
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '810'
x-url-hash: sqrt
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/stddev:
get:
description: The Standard Deviation (STDDEV) endpoint calculates the dispersion of a financial instrument's price data from its average value. It returns a numerical value representing the volatility of the asset over a specified period. This endpoint is useful for traders and analysts to assess price variability and identify periods of high or low volatility in the market.
operationId: GetTimeSeriesStdDev
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '63'
x-go-name: TimePeriod
x-order: '63'
- description: The standard deviation applied in the calculation.
in: query
name: sd
schema:
default: 2
format: double
type: number
x-go-name: StandardDeviation
x-order: '61'
x-go-name: StandardDeviation
x-order: '61'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesStdDev_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Standard deviation
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '820'
x-url-hash: stddev
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/stoch:
get:
description: The Stochastic Oscillator endpoint provides data on a momentum indicator that evaluates a security's closing price relative to its price range over a specified timeframe. It returns values indicating potential overbought or oversold conditions, aiding in identifying possible trend reversals. Users receive the %K and %D values, which are essential for analyzing the momentum and potential turning points in the market.
operationId: GetTimeSeriesStoch
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`
in: query
name: fast_k_period
schema:
default: 14
format: int64
type: integer
x-go-name: FastKPeriod
x-order: '61'
x-go-name: FastKPeriod
x-order: '61'
- description: The time period for the slow %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`
in: query
name: slow_k_period
schema:
default: 1
format: int64
type: integer
x-go-name: SlowKPeriod
x-order: '61'
x-go-name: SlowKPeriod
x-order: '61'
- description: The time period for the slow %D line in the Stochastic Oscillator. Takes values in the range from `1` to `800`
in: query
name: slow_d_period
schema:
default: 3
format: int64
type: integer
x-go-name: SlowDPeriod
x-order: '62'
x-go-name: SlowDPeriod
x-order: '62'
- description: The type of slow %K Moving Average used. Default is SMA.
in: query
name: slow_kma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: SlowKMAType
x-order: '63'
- description: The type of slow Displaced Moving Average used. Default is SMA.
in: query
name: slow_dma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: SlowDMAType
x-order: '64'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesStoch_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Stochastic oscillator
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-badge: High demand
x-group: Technical indicators/Momentum indicators
x-order: '830'
x-url-hash: stoch
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/stochf:
get:
description: The Stochastic Fast (STOCHF) endpoint calculates the fast version of the Stochastic Oscillator, providing data on the momentum of a financial instrument by comparing a particular closing price to a range of its prices over a specified period. This endpoint returns the %K and %D values, which are used to identify potential overbought or oversold conditions in the market. It is useful for traders who need quick, responsive insights into price movements, although it may generate more false signals due to its sensitivity.
operationId: GetTimeSeriesStochF
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from `1` to `800`
in: query
name: fast_k_period
schema:
default: 14
format: int64
type: integer
x-go-name: FastKPeriod
x-order: '61'
x-go-name: FastKPeriod
x-order: '61'
- description: The time period for the fast %D line in the Stochastic Oscillator. Takes values in the range from `1` to `800`
in: query
name: fast_d_period
schema:
default: 3
format: int64
type: integer
x-go-name: FastDPeriod
x-order: '62'
x-go-name: FastDPeriod
x-order: '62'
- description: The type of fast Displaced Moving Average used.
in: query
name: fast_dma_type
schema:
$ref: '#/components/schemas/MaTypeEnum'
x-go-name: FastDMAType
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesStochF_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Stochastic fast
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '840'
x-url-hash: stochf
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/stochrsi:
get:
description: The Stochastic Relative Strength Index (Stochastic RSI) endpoint calculates the Stochastic RSI values for a given financial instrument, providing data on its momentum and potential price reversals. This endpoint returns time-series data, including the %K and %D lines, which help users identify overbought or oversold conditions. Ideal for traders seeking to refine entry and exit points by analyzing short-term price movements.
operationId: GetTimeSeriesStochRsi
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: 'Specifies the price data type: open, high, low, or close.'
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeStochrsiEnum'
x-go-name: SeriesType
x-order: '63'
- description: Length of period for calculating the RSI component. Takes values in the range from `1` to `800`
in: query
name: rsi_length
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '64'
x-go-name: TimePeriod
x-order: '64'
- description: Period length for computing the stochastic oscillator of the RSI. Takes values in the range from `1` to `800`
in: query
name: stoch_length
schema:
default: 14
format: int64
type: integer
x-go-name: FastKPeriod
x-order: '61'
x-go-name: FastKPeriod
x-order: '61'
- description: Period for smoothing the %K line. Takes values in the range from `1` to `800`
in: query
name: k_period
schema:
default: 3
format: int64
type: integer
x-go-name: SlowKPeriod
x-order: '61'
x-go-name: SlowKPeriod
x-order: '61'
- in: query
name: slow_kma_type
schema:
type: string
x-go-name: SlowKMAType
x-go-name: SlowKMAType
- description: Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from `1` to `800`
in: query
name: d_period
schema:
default: 3
format: int64
type: integer
x-go-name: SlowDPeriod
x-order: '62'
x-go-name: SlowDPeriod
x-order: '62'
- in: query
name: slow_dma_type
schema:
type: string
x-go-name: SlowDMAType
x-go-name: SlowDMAType
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesStochRsi_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Stochastic relative strength index
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '850'
x-url-hash: stochrsi
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sub:
get:
description: The Subtraction (SUB) endpoint calculates the difference between two input data series, such as technical indicators or price data. It returns a time series of the resulting values, allowing users to compare or normalize data by highlighting the variance between the two series.
operationId: GetTimeSeriesSub
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type used as the first part of technical indicator
in: query
name: series_type_1
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType1
x-order: '62'
- description: Price type used as the second part of technical indicator
in: query
name: series_type_2
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType2
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSub_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Subtraction
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '860'
x-url-hash: sub
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/sum:
get:
description: The Summation (SUM) endpoint calculates the cumulative total of a specified data series over a defined time period. It returns a numerical value representing the sum, which can be used to track the aggregate value of financial data, such as stock prices or trading volumes, over time. This endpoint is useful for users needing to compute the total accumulation of a dataset for further analysis or reporting.
operationId: GetTimeSeriesSum
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '62'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSum_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Summation
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '870'
x-url-hash: sum
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/supertrend:
get:
description: The Supertrend endpoint provides data on the Supertrend indicator, a tool used to identify potential buy and sell signals in trending markets. It returns values that indicate the current trend direction and potential reversal points based on price, time, and volatility. Users can leverage this data to pinpoint optimal entry and exit points for trades.
operationId: GetTimeSeriesSuperTrend
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The period used for calculation in the indicator. Takes values in the range from `1` to `800`
in: query
name: period
schema:
default: 10
format: int64
type: integer
x-go-name: Period
x-order: '61'
x-go-name: Period
x-order: '61'
- description: The factor used to adjust the indicator's sensitivity.
in: query
name: multiplier
schema:
default: 3
format: int64
type: integer
x-go-name: Multiplier
x-order: '62'
x-go-name: Multiplier
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSuperTrend_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Supertrend
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volatility indicators
x-order: '880'
x-url-hash: supertrend
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/supertrend_heikinashicandles:
get:
description: The Supertrend Heikin Ashi candles endpoint provides data combining Supertrend signals with Heikin Ashi candlestick patterns. It returns a series of data points indicating trend direction and smoothed price movements, useful for identifying potential buy or sell opportunities in trading.
operationId: GetTimeSeriesSuperTrendHeikinAshiCandles
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The period used for calculation in the indicator. Takes values in the range from `1` to `800`
in: query
name: period
schema:
default: 10
format: int64
type: integer
x-go-name: Period
x-order: '61'
x-go-name: Period
x-order: '61'
- description: The factor used to adjust the indicator's sensitivity.
in: query
name: multiplier
schema:
default: 3
format: int64
type: integer
x-go-name: Multiplier
x-order: '62'
x-go-name: Multiplier
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesSuperTrendHeikinAshiCandles_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Supertrend Heikin Ashi candles
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volatility indicators
x-order: '890'
x-starting-plan: grow,venture
x-url-hash: supertrend-heikinashicandles
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/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:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: The factor used to adjust the indicator's volatility. Takes values in the range from `0` to `1`
in: query
name: v_factor
schema:
default: 0.7
format: double
type: number
x-go-name: VFactor
x-order: '63'
x-go-name: VFactor
x-order: '63'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesT3ma_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Triple exponential moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '900'
x-url-hash: t3ma
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/tema:
get:
description: The Triple Exponential Moving Average (TEMA) endpoint calculates and returns the TEMA values for a specified financial instrument over a given time period. This endpoint provides a series of data points that smooth out price fluctuations by applying three layers of exponential moving averages, allowing users to identify and track underlying trends in the instrument's price movement.
operationId: GetTimeSeriesTema
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: The time period used for calculation in the indicator. Default is 9.
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesTema_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Triple exponential moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '910'
x-url-hash: tema
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/trange:
get:
description: The True Range (TRANGE) endpoint calculates the range of price movement for a specified period, providing a measure of market volatility. It returns data that includes the highest and lowest prices over the period, along with the closing price from the previous period. This information is useful for traders to assess market volatility and adjust their trading strategies accordingly.
operationId: GetTimeSeriesTRange
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesTRange_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: True range
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Volatility indicators
x-order: '920'
x-url-hash: trange
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/trima:
get:
description: The Triangular Moving Average (TRIMA) endpoint calculates and returns the smoothed average price of a financial security over a specified period, with a focus on central data points. This endpoint provides a balanced view of price trends by applying a double smoothing process, making it useful for identifying underlying price patterns and reducing short-term fluctuations.
operationId: GetTimeSeriesTrima
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesTrima_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Triangular moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '930'
x-url-hash: trima
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/tsf:
get:
description: The Time Series Forecast (TSF) endpoint provides projected future price levels using linear regression analysis. It returns data that helps users identify potential support and resistance levels, as well as trend direction in a financial market. This endpoint is useful for traders seeking to anticipate price movements and adjust their strategies accordingly.
operationId: GetTimeSeriesTsf
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesTsf_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Time series forecast
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '940'
x-url-hash: tsf
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/typprice:
get:
description: The Typical Price (TYPPRICE) endpoint calculates and returns the average of a financial instrument's high, low, and close prices for a given period. This endpoint provides a simplified metric that reflects the central tendency of price movements, useful for traders and analysts who need a straightforward view of price trends.
operationId: GetTimeSeriesTypPrice
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesTypPrice_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Typical price
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '950'
x-url-hash: typprice
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/ultosc:
get:
description: The Ultimate Oscillator endpoint (/ultosc) calculates a momentum oscillator that integrates short, intermediate, and long-term price movements to detect potential overbought or oversold conditions and possible trend reversals. It returns a time series of oscillator values, which can be used to assess market momentum and identify entry or exit points in trading strategies.
operationId: GetTimeSeriesUltOsc
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: The first time period used for calculation in the indicator. Takes values in the range from `1` to `800`
in: query
name: time_period_1
schema:
default: 7
format: int64
type: integer
x-go-name: TimePeriod1
x-order: '62'
x-go-name: TimePeriod1
x-order: '62'
- description: The second time period used for calculation in the indicator. Takes values in the range from `1` to `800`
in: query
name: time_period_2
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod2
x-order: '62'
x-go-name: TimePeriod2
x-order: '62'
- description: The third time period used for calculation in the indicator. Takes values in the range from `1` to `800`
in: query
name: time_period_3
schema:
default: 28
format: int64
type: integer
x-go-name: TimePeriod3
x-order: '62'
x-go-name: TimePeriod3
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesUltOsc_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Ultimate oscillator endpoint
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '960'
x-url-hash: ultosc
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/var:
get:
description: The Variance (VAR) endpoint calculates the statistical variance of a financial data series, providing a measure of how much the data points deviate from the average value. It returns a numerical value representing this dispersion, which can be used to assess the volatility of a security over a specified period. This information is crucial for traders and analysts who need to evaluate the risk associated with price fluctuations in the market.
operationId: GetTimeSeriesVar
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesVar_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Variance
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Statistic functions
x-order: '960'
x-url-hash: var
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/vwap:
get:
description: The Volume Weighted Average Price (VWAP) endpoint provides the VWAP value for a specified stock or asset over a given time period. This indicator calculates the average price at which a security has traded throughout the day, based on both volume and price. It is useful for identifying the true average price of an asset, helping traders to assess the current price relative to the day's average.
operationId: GetTimeSeriesVwap
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: 'The time period for the standard deviation calculation. Must be greater than `0`. Recommended value is `9`.
This parameter is only used together with `sd`.'
in: query
name: sd_time_period
schema:
default: 0
format: int64
type: integer
x-go-name: SDTimePeriod
x-order: '62'
x-go-name: SDTimePeriod
x-order: '62'
- description: 'The standard deviation applied in the calculation. Must be greater than `0`. Recommended value is `2`.
This parameter is only used together with `sd_time_period`.'
in: query
name: sd
schema:
default: 0
format: double
type: number
x-go-name: StandardDeviation
x-order: '61'
x-go-name: StandardDeviation
x-order: '61'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesVwap_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Volume weighted average price
tags:
- technical_indicator
x-additional-notes: Take note that this endpoint is applicable to all instruments except currencies.
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '970'
x-url-hash: vwap
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/wclprice:
get:
description: 'The Weighted Close Price (WCLPRICE) endpoint calculates a security''s average price by giving additional weight to the closing price, using the formula: (High + Low + Close * 2) / 4.'
operationId: GetTimeSeriesWclPrice
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesWclPrice_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Weighted close price
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Price transform
x-order: '980'
x-url-hash: wclprice
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/willr:
get:
description: The Williams %R (WILLR) endpoint calculates the Williams Percent Range, a momentum indicator that evaluates a security's closing price relative to its high-low range over a specified period. This endpoint returns data that helps users identify potential overbought or oversold conditions and possible trend reversals in the market.
operationId: GetTimeSeriesWillR
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 14
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesWillR_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Williams %R
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Momentum indicators
x-order: '990'
x-url-hash: willr
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
/wma:
get:
description: The Weighted Moving Average (WMA) endpoint calculates and returns the WMA values for a given security over a specified period. This endpoint provides a time series of weighted averages, where recent prices have a higher influence, allowing users to track and analyze short-term price trends effectively.
operationId: GetTimeSeriesWma
parameters:
- description: Symbol ticker of the instrument. E.g. `AAPL`, `EUR/USD`, `ETH/BTC`, ...
in: query
name: symbol
schema:
type: string
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
x-go-name: Symbol
x-order: '10'
x-required-group: symbol
example: AAPL
- description: Filter by international securities identification number (ISIN). ISIN access is activating in the Data add-ons section
in: query
name: isin
schema:
type: string
x-go-name: Isin
x-order: '25'
x-required-group: symbol
x-go-name: Isin
x-order: '25'
x-required-group: symbol
example: US0378331005
- description: The FIGI of an instrument for which data is requested. This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
in: query
name: figi
schema:
type: string
x-go-name: Figi
x-order: '20'
x-required-group: symbol
x-go-name: Figi
x-order: '20'
x-required-group: symbol
example: BBG000B9Y5X2
- description: The CUSIP of an instrument for which data is requested. CUSIP access is activating in the Data add-ons section
in: query
name: cusip
schema:
type: string
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
x-go-name: Cusip
x-order: '26'
x-required-group: symbol
example: '594918104'
- description: Interval between two consecutive points in time series
in: query
name: interval
required: true
schema:
$ref: '#/components/schemas/IntervalEnum'
x-go-name: Interval
x-order: '30'
example: 1min
- description: Number of data points to retrieve. Supports values in the range from `1` to `5000`. Default `30` when no date parameters are set, otherwise set to maximum
in: query
name: outputsize
schema:
default: 30
format: int64
type: integer
x-go-name: PageSize
x-order: '80'
x-go-name: PageSize
x-order: '80'
- description: Exchange where instrument is traded
in: query
name: exchange
schema:
type: string
x-go-name: Exchange
x-order: '40'
x-go-name: Exchange
x-order: '40'
example: NASDAQ
- description: Market Identifier Code (MIC) under ISO 10383 standard
in: query
name: mic_code
schema:
type: string
x-go-name: MicCode
x-order: '50'
x-go-name: MicCode
x-order: '50'
example: XNAS
- description: The country where the instrument is traded, e.g., `United States` or `US`
in: query
name: country
schema:
type: string
x-go-name: Country
x-order: '60'
x-go-name: Country
x-order: '60'
example: United States
- description: The asset class to which the instrument belongs
in: query
name: type
schema:
$ref: '#/components/schemas/TypeEnum'
x-go-name: Type
x-order: '70'
example: Common Stock
- description: 'Timezone at which output datetime will be displayed. Supports:
- 1.
Exchange for local exchange time
- 2.
UTC for datetime at universal UTC standard
- 3. Timezone name according to the IANA Time Zone Database. E.g.
America/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.
Take 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`
Default location:
- Forex and Cryptocurrencies -
UTC
- Stocks - where exchange is located (e.g. for AAPL it will be
America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location
Examples:
- 1.
&symbol=AAPL&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
- 2.
&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
- 3.
&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00
'
in: query
name: start_date
schema:
type: string
x-go-name: StartDate
x-order: '150'
x-go-name: StartDate
x-order: '150'
example: '2024-08-22T15:04:05'
- description: The ending date and time for data selection, see `start_date` description for details.
in: query
name: end_date
schema:
type: string
x-go-name: EndDate
x-order: '160'
x-go-name: EndDate
x-order: '160'
example: '2024-08-22T16:04:05'
- description: Specifies the exact date to get the data for. Could be the exact date, e.g. `2021-10-27`, or in human language `today` or `yesterday`
in: query
name: date
schema:
type: string
x-go-name: Date
x-order: '140'
x-go-name: Date
x-order: '140'
example: '2021-10-27'
- description: Sorting order of the output
in: query
name: order
schema:
$ref: '#/components/schemas/OrderEnum'
x-go-name: Order
x-order: '130'
- description: 'Returns quotes that include pre-market and post-market data. Only for the `Pro` plan (individual) and `Venture` plan (business) and above.
Available at the `1min`, `5min`, `15min`, and `30min` intervals for US equities.
Open, high, low, close values are supplied without volume'
in: query
name: prepost
schema:
default: false
type: boolean
x-go-name: Prepost
x-order: '110'
x-go-name: Prepost
x-order: '110'
- description: The format of the response data
in: query
name: format
schema:
$ref: '#/components/schemas/FormatEnum'
x-go-name: Format
x-order: '90'
- description: The separator used in the CSV response data
in: query
name: delimiter
schema:
default: ;
type: string
x-go-name: Delimiter
x-order: '100'
x-go-name: Delimiter
x-order: '100'
- description: 'Specifies the number of decimal places for floating values.
Should be in range [0, 11] inclusive.
By default, the number of decimal places is automatically determined based on the values provided'
in: query
name: dp
schema:
default: -1
format: int64
type: integer
x-go-name: DecimalPlaces
x-order: '120'
x-go-name: DecimalPlaces
x-order: '120'
- description: A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object
in: query
name: previous_close
schema:
default: false
type: boolean
x-go-name: PreviousPrice
x-order: '170'
x-go-name: PreviousPrice
x-order: '170'
- description: Adjusting mode for prices
in: query
name: adjust
schema:
$ref: '#/components/schemas/AdjustEnum'
x-go-name: Adjust
x-order: '180'
- description: Price type on which technical indicator is calculated
in: query
name: series_type
schema:
$ref: '#/components/schemas/SeriesTypeEnum'
x-go-name: SeriesType
x-order: '61'
- description: Number of periods to average over. Takes values in the range from `1` to `800`
in: query
name: time_period
schema:
default: 9
format: int64
type: integer
x-go-name: TimePeriod
x-order: '62'
x-go-name: TimePeriod
x-order: '62'
- description: Specify if OHLC values should be added in the output
in: query
name: include_ohlc
schema:
default: false
type: boolean
x-go-name: IncludeOHLC
x-order: '132'
x-go-name: IncludeOHLC
x-order: '132'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTimeSeriesWma_200_response'
description: ''
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiBadRequestErrorResponseBody'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiUnauthorizedErrorResponseBody'
description: ''
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiForbiddenErrorResponseBody'
description: ''
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiNotFoundErrorResponseBody'
description: ''
'414':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiParameterTooLongErrorResponseBody'
description: ''
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiTooManyRequestsErrorResponseBody'
description: ''
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInternalServerErrorResponseBody'
description: ''
summary: Weighted moving average
tags:
- technical_indicator
x-api-credits-cost: '1'
x-api-credits-type: symbol
x-group: Technical indicators/Overlap studies
x-order: '1000'
x-url-hash: wma
x-required:
anyOf:
- required:
- symbol
- isin
- figi
- cusip
components:
schemas:
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'
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'
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
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
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
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
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
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
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
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
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
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
ApiForbiddenErrorResponseBody:
properties:
code:
description: Error code
examples:
- 403
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- API key lacks permissions for the requested resource
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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
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
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'
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
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
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
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'
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
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
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
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'
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'
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
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
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
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
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
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
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
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
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
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'
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
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
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
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
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'
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
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
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'
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
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
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
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
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
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'
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
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
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'
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
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'
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'
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'
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
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'
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'
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
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
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
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
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
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
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
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
IntervalEnum:
enum:
- 1min
- 5min
- 15min
- 30min
- 45min
- 1h
- 2h
- 4h
- 8h
- 1day
- 1week
- 1month
type: string
x-go-name: Interval
x-order: '30'
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
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
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
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'
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
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
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'
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
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
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
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
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
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
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
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
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'
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
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
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
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'
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
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
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
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
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'
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
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'
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
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
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
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
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
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
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
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
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
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'
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
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'
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
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
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
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
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
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'
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
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
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
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
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
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
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
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
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
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
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'
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
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
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
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'
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
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
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
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'
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
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
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
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'
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
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
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
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
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
ApiInternalServerErrorResponseBody:
properties:
code:
description: Error code
examples:
- 500
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Internal server error
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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
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'
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'
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
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
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
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
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'
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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'
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
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
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
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
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'
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
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
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'
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
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
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
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
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
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
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
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'
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
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
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
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
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'
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
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
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
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
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
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
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
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
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
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
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'
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'
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'
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'
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
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
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
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
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'
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
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
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
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
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
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
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'
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
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
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
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
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
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
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'
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'
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
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
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
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
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
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
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
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'
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
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
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
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'
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
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
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'
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
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
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
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
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
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
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'
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
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
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
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
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'
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'
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'
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'
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
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
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
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
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
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'
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
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
FormatEnum:
default: JSON
enum:
- JSON
- CSV
type: string
x-go-name: Format
x-order: '90'
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
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
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'
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'
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
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
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'
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'
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'
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
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:
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
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
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'
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
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
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'
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
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
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
SeriesTypeStochrsiEnum:
default: close
enum:
- open
- high
- low
- close
type: string
x-go-name: SeriesTypeStochrsi
x-order: '63'
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'
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
MaTypeEnum:
default: SMA
enum:
- SMA
- EMA
- WMA
- DEMA
- TEMA
- TRIMA
- KAMA
- MAMA
- T3MA
type: string
x-go-name: MaType
x-order: '63'
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
SeriesTypeEnum:
default: open
enum:
- close
- open
- high
- low
- volume
type: string
x-go-name: SeriesType
x-order: '62'
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
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
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
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
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
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
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'
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'
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
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
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
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
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'
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
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
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
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'
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
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'
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'
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
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'
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
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
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
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
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'
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
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
AdjustEnum:
default: splits
enum:
- all
- splits
- dividends
- none
type: string
x-go-name: Adjust
x-order: '180'
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
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
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
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
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'
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'
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
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
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
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
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
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
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
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'
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
ApiUnauthorizedErrorResponseBody:
properties:
code:
description: Error code
examples:
- 401
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- apikey parameter is incorrect or not specified
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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'
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
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
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'
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
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'
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
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'
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
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
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
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'
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
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
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:
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'
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
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'
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_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'
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
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
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'
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
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'
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
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'
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'
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
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
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
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
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
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
ApiParameterTooLongErrorResponseBody:
properties:
code:
description: Error code
examples:
- 414
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Input parameter array exceeds the allowed length
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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'
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
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
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
ApiNotFoundErrorResponseBody:
properties:
code:
description: Error code
examples:
- 404
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- symbol or figi parameter is missing or invalid
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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
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
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
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
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
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'
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'
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
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
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
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'
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'
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
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'
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
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
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'
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'
ApiTooManyRequestsErrorResponseBody:
properties:
code:
description: Error code
examples:
- 429
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- You have run out of API credits for the current minute. 1000 API credits were used, with the current limit being 987. Wait for the next minute or consider upgrading your plan at https://twelvedata.com/pricing
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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
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
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
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
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
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
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
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
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'
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'
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
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'
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'
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'
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'
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'
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'
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
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
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'
OrderEnum:
default: desc
enum:
- asc
- desc
type: string
x-go-name: Order
x-order: '130'
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
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
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
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
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
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
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
ApiBadRequestErrorResponseBody:
properties:
code:
description: Error code
examples:
- 400
format: int64
type: integer
x-go-name: Code
message:
description: Error message
examples:
- Invalid request
type: string
x-go-name: Message
status:
description: Error status
examples:
- error
type: string
x-go-name: Status
required:
- code
- message
- status
type: object
x-go-package: gitlab.atlasgroup.ai/twelvedata/api/route/description
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
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'
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
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'