Now Live: Cboe Europe real-time data for all major European stocks.

Volatility indicators

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.

Average true range

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.

Route

API credits cost

1 per symbol

✱ One of these parameters is required

symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

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.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

dp

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

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

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Example: 2024-08-22T15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22T16:04:05

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

Number of periods to average over

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

atr

string

ATR value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

close

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM
View as Markdown

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "ATR - Average True Range",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "atr": "0.19828",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Normalized average true range

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.

Route

API credits cost

1 per symbol

✱ One of these parameters is required

symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

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.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

time_period

integer

Number of periods to average over. Takes values in the range from 1 to 800

Default: 14

type

string

The asset class to which the instrument belongs

Supports: 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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

dp

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

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

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Example: 2024-08-22T15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22T16:04:05

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

time_period

integer

The time period used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

natr

string

natr value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

close

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM
View as Markdown

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "NATR - Normalized Average True Range",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "natr": "0.09862",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Supertrend

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.

Route

API credits cost

1 per symbol

✱ One of these parameters is required

symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

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.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

period

integer

The period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 10

multiplier

integer

The factor used to adjust the indicator's sensitivity.

Default: 3

type

string

The asset class to which the instrument belongs

Supports: 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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

dp

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

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

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Example: 2024-08-22T15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22T16:04:05

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

period

integer

The period used for calculation in the indicator

multiplier

integer

The factor used to adjust the indicator's sensitivity

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

supertrend

string

SuperTrend value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

close

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM
View as Markdown

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUPERTREND - SuperTrend Indicator",
            "period": 10,
            "multiplier": 3
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "supertrend": "201.56432",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Supertrend Heikin Ashi candles

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.

Route

API credits cost

1 per symbol

This API endpoint is available on the Grow plan (individual) and the Venture plan (business) and above.
✱ One of these parameters is required

symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

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.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

period

integer

The period used for calculation in the indicator. Takes values in the range from 1 to 800

Default: 10

multiplier

integer

The factor used to adjust the indicator's sensitivity.

Default: 3

type

string

The asset class to which the instrument belongs

Supports: 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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

dp

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

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

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Example: 2024-08-22T15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22T16:04:05

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

Json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

period

integer

The period used for calculation in the indicator

multiplier

integer

The multiplier used for calculation in the indicator

values

array of object

Array of time series data points

Attributes

datetime

string

Datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

supertrend

string

SuperTrend value

heikinhighs

string

Heikin-Ashi high values

heikinopens

string

Heikin-Ashi open values

heikincloses

string

Heikin-Ashi close values

heikinlows

string

Heikin-Ashi low values

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

close

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM
View as Markdown

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "SUPERTREND_HEIKINASHICANDLES - SuperTrendHeikinAshiCandles Indicator",
            "period": 10,
            "multiplier": 3
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "supertrend": "201.66713",
            "heikinhighs": "201.25599",
            "heikinopens": "200.9825",
            "heikincloses": "201.02449",
            "heikinlows": "200.85199",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

True range

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.

Route

API credits cost

1 per symbol

✱ One of these parameters is required

symbol

string

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...

Example: AAPL

figi

string

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.

Example: BBG000B9Y5X2

isin

string

Look up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.

Example: US0378331005

cusip

string

Look up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.

Example: 594918104

✱ interval

string

Interval between two consecutive points in time series

Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month

Example: 1min

exchange

string

Exchange where instrument is traded

Example: NASDAQ

mic_code

string

Market Identifier Code (MIC) under ISO 10383 standard

Example: XNAS

country

string

The country where the instrument is traded, e.g., United States or US

Example: United States

type

string

The asset class to which the instrument belongs

Supports: 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

Example: Common Stock

outputsize

integer

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

Default: 30

format

string

The format of the response data

Supports: JSON, CSV

Default: JSON

delimiter

string

The separator used in the CSV response data

Default: ;

prepost

boolean

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

Default: false

dp

integer

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

Default: -1

order

string

Sorting order of the output

Supports: asc, desc

Default: desc

include_ohlc

boolean

Specify if OHLC values should be added in the output

Supports: true, false

Default: false

timezone

string

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

Default: Exchange

date

string

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

Example: 2021-10-27

start_date

string

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

Example: 2024-08-22T15:04:05

end_date

string

The ending date and time for data selection, see start_date description for details.

Example: 2024-08-22T16:04:05

previous_close

boolean

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

Default: false

adjust

string

Adjusting mode for prices

Supports: all, splits, dividends, none

Default: splits

meta

object

json object with request general information

Attributes

symbol

string

The ticker symbol of an instrument for which data was requested.

interval

string

The time gap between consecutive data points.

currency

string

The currency of a traded instrument.

exchange_timezone

string

The timezone of the exchange where the instrument is traded.

exchange

string

The exchange name where the instrument is traded.

mic_code

string

The Market Identifier Code (MIC) of the exchange where the instrument is traded.

type

string

The asset class to which the instrument belongs.

indicator

object

Technical indicator information

Attributes

name

string

Name of the technical indicator

values

array of object

Array of time series data points

Attributes

datetime

string

datetime in local market time for equities and in UTC for forex and cryptocurrencies referring to when the bar with specified interval was opened

trange

string

trange value

open

string

Price at the opening of current bar. Returned when include_ohlc is true.

high

string

Highest price which occurred during the current bar. Returned when include_ohlc is true.

low

string

Lowest price which occurred during the current bar. Returned when include_ohlc is true.

close

string

Close price at the end of the bar. Returned when include_ohlc is true.

volume

string

Trading volume which occurred during the current bar. Returned when include_ohlc is true.

status

string

Response status

Copy for LLM
View as Markdown

Response

{
    "meta": {
        "symbol": "AAPL",
        "interval": "1min",
        "currency": "USD",
        "exchange_timezone": "America/New_York",
        "exchange": "NASDAQ",
        "mic_code": "XNAS",
        "type": "Common Stock",
        "indicator": {
            "name": "TRANGE - True Range"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "trange": "0.404",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}