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

Momentum indicators

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).

Average directional index High demand

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.

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

adx

string

ADX 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": "ADX - Average Directional Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "adx": "49.22897",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Average directional movement index rating

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.

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

adxr

string

Adxr 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": "ADXR - Average Directional Movement Index Rating",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "adxr": "37.43665",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Absolute price oscillator

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.

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

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

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

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

Number of periods for fast moving average

slow_period

integer

Number of periods for slow moving average

ma_type

string

Type of moving average used

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

apo

string

APO 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": "APO - Absolute Price Oscillator",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "apo": "-0.54508",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Aroon indicator

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.

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

aroon_down

string

Aroon down value

aroon_up

string

Aroon up 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": "AROON - Aroon Indicator",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "aroon_down": "92.85714",
            "aroon_up": "0.0",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Aroon oscillator

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.

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

aroonosc

string

Aroon oscillator 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": "AROONOSC - Aroon Oscillator",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "aroonosc": "-92.85714",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Balance of power

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.

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

bop

string

Bop 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": "BOP - Balance of Power"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "bop": "0.27231",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Commodity channel index

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.

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

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

cci

string

CCI 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": "CCI - Commodity Channel Index",
            "time_period": 20
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "cci": "-122.30794",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Chande momentum oscillator

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

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

cmo

string

CMO 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": "CMO - Chande Momentum Oscillator",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "cmo": "-71.24979",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Coppock curve

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.

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

long_roc_period

integer

Number of periods for long term rate of change. Takes values in the range from 1 to 800

Default: 14

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

short_roc_period

integer

Number of periods for short term rate of change. Takes values in the range from 1 to 800

Default: 11

wma_period

integer

Number of periods for weighted moving average. Takes values in the range from 1 to 800

Default: 10

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

series_type

string

Price type on which technical indicator is calculated

wma_period

integer

Number of periods for weighted moving average

long_roc_period

integer

Number of periods for long term rate of change

short_roc_period

integer

Number of periods for short term rate of change

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

coppock

string

Coppock 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": "COPPOCK - Coppock Curve",
            "series_type": "close",
            "wma_period": 10,
            "long_roc_period": 14,
            "short_roc_period": 11
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "coppock": "-1.37253",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Connors relative strength index

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.

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

percent_rank_period

integer

Number of periods used to calculate PercentRank. Takes values in the range from 1 to 800

Default: 100

rsi_period

integer

Number of periods for RSI used to calculate price momentum. Takes values in the range from 1 to 800

Default: 3

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

up_down_length

integer

Number of periods for RSI used to calculate up/down trend. Takes values in the range from 1 to 800

Default: 2

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

series_type

string

Price type on which technical indicator is calculated

rsi_period

integer

Number of periods for RSI used to calculate price momentum

up_down_length

integer

Number of periods for RSI used to calculate up/down trend

percent_rank_period

integer

Number of periods used to calculate PercentRank

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

crsi

string

crsi 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": "CRSI - ConnorsRSI",
            "series_type": "close",
            "rsi_period": 3,
            "up_down_length": 2,
            "percent_rank_period": 100
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "crsi": "74.76102",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Detrended price oscillator

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

centered

boolean

Specifies if there should be a shift to match the current price

Default: false

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

series_type

string

Price type on which technical indicator is calculated

time_period

integer

Number of periods to average over

centered

boolean

Specifies if there should be a shift to match the current price

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

dpo

string

DPO 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": "DPO - Detrended Price Oscillator",
            "series_type": "close",
            "time_period": 21,
            "centered": false
        }
    },
    "values": [
        {
            "datetime": "2025-04-01",
            "dpo": "-7.99619",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Directional movement index

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.

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

dx

string

dx 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": "DX - Directional Movement Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "dx": "68.70803",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Know sure thing

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.

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

roc_period_1

integer

The time period for the first Rate of Change calculation.

Default: 10

roc_period_2

integer

The time period for the second Rate of Change calculation.

Default: 15

roc_period_3

integer

The time period for the third Rate of Change calculation.

Default: 20

roc_period_4

integer

The time period for the forth Rate of Change calculation.

Default: 30

sma_period_1

integer

The time period for the first Simple Moving Average.

Default: 10

sma_period_2

integer

The time period for the second Simple Moving Average.

Default: 10

sma_period_3

integer

The time period for the third Simple Moving Average.

Default: 10

sma_period_4

integer

The time period for the forth Simple Moving Average.

Default: 15

signal_period

integer

The time period used for generating the signal line.

Default: 9

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

roc_period_1

integer

The time period for the first Rate of Change calculation

roc_period_2

integer

The time period for the second Rate of Change calculation

roc_period_3

integer

The time period for the third Rate of Change calculation

roc_period_4

integer

The time period for the forth Rate of Change calculation

sma_period_1

integer

The time period for the first Simple Moving Average

sma_period_2

integer

The time period for the second Simple Moving Average

sma_period_3

integer

The time period for the third Simple Moving Average

sma_period_4

integer

The time period for the forth Simple Moving Average

signal_period

integer

The time period used for generating the signal line

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

kst

string

KST value

kst_signal

string

KST signal 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": "KST - Know Sure Thing",
            "roc_period_1": 10,
            "roc_period_2": 15,
            "roc_period_3": 20,
            "roc_period_4": 30,
            "sma_period_1": 10,
            "sma_period_2": 10,
            "sma_period_3": 10,
            "sma_period_4": 15,
            "signal_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "kst": "-4.58644",
            "kst_signal": "-2.05236",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Moving average convergence divergence High demand

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

signal_period

integer

The time period used for generating the signal line.

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

Fast period value

slow_period

integer

Slow period value

signal_period

integer

Signal period value

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

macd

string

MACD value

macd_signal

string

MACD signal line value

macd_hist

string

MACD histogram 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": "MACD - Moving Average Convergence Divergence",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "signal_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd": "-0.3998",
            "macd_signal": "-0.25279",
            "macd_hist": "-0.147",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Moving average convergence divergence slope

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.

Route

API credits cost

1 per symbol

This API endpoint is available on the Pro 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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

signal_period

integer

The time period used for generating the signal line.

Default: 9

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

slow_period

integer

The longer time period for calculation

signal_period

integer

The time period used for generating the signal line

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

macd_slope

string

MACD slope value

macd_signal_slope

string

MACD signal slope value

macd_hist_slope

string

MACD histogram slope 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": "MACD_SLOPE - Moving Average Convergence Divergence Regression Slope",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "signal_period": 9,
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd_slope": "0.13358",
            "macd_signal_slope": "0.05345",
            "macd_hist_slope": "0.08013",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Moving average convergence divergence extension

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

fast_ma_type

string

The type of fast moving average used in the calculation.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

slow_ma_type

string

The type of slow moving average used in the calculation.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

signal_period

integer

The time period used for generating the signal line.

Default: 9

signal_ma_type

string

The type of fast moving average used for generating the signal line.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

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

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

fast_ma_type

string

The type of fast moving average used in the calculation

slow_period

integer

The longer time period for calculation

slow_ma_type

string

The type of slow moving average used in the calculation

signal_period

integer

The time period used for generating the signal line

signal_ma_type

string

The type of moving average used for generating the signal line

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

macd

string

MACD value

macd_signal

string

MACD signal line value

macd_hist

string

MACD histogram 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": "MACDEXT - Moving Average Convergence Divergence Extended",
            "series_type": "close",
            "fast_period": 12,
            "fast_ma_type": "SMA",
            "slow_period": 26,
            "slow_ma_type": "SMA",
            "signal_period": 9,
            "signal_ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "macd": "-0.54508",
            "macd_signal": "-0.25615",
            "macd_hist": "-0.28894",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Money flow index

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.

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

mfi

string

MFI 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": "MFI - Money Flow Index",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mfi": "22.68525",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minus directional indicator

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.

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

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

minus_di

string

Minus_di 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": "MINUS_DI - Minus Directional Indicator",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minus_di": "46.60579",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Minus directional movement

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.

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

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

minus_dm

string

Minus Directional Movement 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": "MINUS_DM - Minus Directional Movement",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "minus_dm": "0.96291",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Momentum

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

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

mom

string

Mom 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": "MOM - Momentum",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "mom": "-1.14",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Percent B High demand

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

sd

double

The standard deviation applied in the calculation. Must be at least 1

Default: 2

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

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

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation in the indicator

sd

double

The standard deviation applied in the calculation

ma_type

string

The type of moving average used

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

percent_b

string

Percent_b 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": "PERCENT_B - %B Indicator",
            "series_type": "close",
            "time_period": 20,
            "sd": 2,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "percent_b": "0.11981",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Plus directional indicator

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.

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

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

plus_di

string

plus_di 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": "PLUS_DI - Plus Directional Indicator",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "plus_di": "7.69578",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Plus directional movement

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.

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

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

plus_dm

string

plus_dm 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": "PLUS_DM - Plus Directional Movement",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "plus_dm": "0.159",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Percentage price oscillator

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

fast_period

integer

Number of periods for fast moving average. Takes values in the range from 1 to 800

Default: 12

slow_period

integer

Number of periods for slow moving average. Takes values in the range from 1 to 800

Default: 26

ma_type

string

The type of moving average used

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

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

series_type

string

Price type on which technical indicator is calculated

fast_period

integer

The shorter time period for calculation

slow_period

integer

The longer time period for calculation

ma_type

string

The type of moving average used

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

ppo

string

PPO 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": "PPO - Percentage Price Oscillator",
            "series_type": "close",
            "fast_period": 12,
            "slow_period": 26,
            "ma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ppo": "-0.2696",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Rate of change

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

time_period

integer

The time period used for calculation

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

roc

string

roc 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": "ROC - Rate of change",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "roc": "-0.56383",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Rate of change percentage

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

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

rocp

string

ROCP 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": "ROCP - Rate of change percentage",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocp": "-0.00564",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Rate of change ratio

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

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

rocr

string

ROCR 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": "ROCR - Rate of change ratio",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocr": "0.99436",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Rate of change ratio 100

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

time_period

integer

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

Default: 9

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

series_type

string

Price type on which technical indicator is calculated

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

rocr100

string

rocr100 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": "ROCR100 - Rate of change ratio 100 scale",
            "series_type": "close",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rocr100": "99.43617",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Relative strength index High demand

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.

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

series_type

string

Price type on which technical indicator is calculated

Supports: close, open, high, low, volume

Default: close

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

series_type

string

Price type on which technical indicator is calculated

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

rsi

string

RSI 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": "RSI - Relative Strength Index",
            "series_type": "close",
            "time_period": 14
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "rsi": "16.57887",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Stochastic oscillator High demand

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.

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

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 14

slow_k_period

integer

The time period for the slow %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 1

slow_d_period

integer

The time period for the slow %D line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 3

slow_kma_type

string

The type of slow %K Moving Average used. Default is SMA.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

slow_dma_type

string

The type of slow Displaced Moving Average used. Default is SMA.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

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

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator

slow_k_period

integer

The time period for the slow %K line in the Stochastic Oscillator

slow_d_period

integer

The time period for the slow %D line in the Stochastic Oscillator

slow_kma_type

string

The type of slow %K Moving Average used

slow_dma_type

string

The type of slow Displaced Moving Average used

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

slow_k

string

slow_k value

slow_d

string

slow_d 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": "STOCH - Stochastic Oscillator",
            "fast_k_period": 14,
            "slow_k_period": 1,
            "slow_d_period": 3,
            "slow_kma_type": "SMA",
            "slow_dma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "slow_k": "11.35168",
            "slow_d": "7.5293",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Stochastic fast

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.

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

fast_k_period

integer

The time period for the fast %K line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 14

fast_d_period

integer

The time period for the fast %D line in the Stochastic Oscillator. Takes values in the range from 1 to 800

Default: 3

fast_dma_type

string

The type of fast Displaced Moving Average used.

Supports: SMA, EMA, WMA, DEMA, TEMA, TRIMA, KAMA, MAMA, T3MA

Default: SMA

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

fast_k_period

integer

The fast_k period used for calculation in the indicator

fast_d_period

integer

The fast_d period used for calculation in the indicator

fast_dma_type

string

The type of fast Displaced Moving Average used

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

fast_k

string

fast_k value

fast_d

string

fast_d 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": "STOCHF - Stochastic Fast",
            "fast_k_period": 14,
            "fast_d_period": 3,
            "fast_dma_type": "SMA"
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "fast_k": "11.35168",
            "fast_d": "7.5293",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Stochastic relative strength index

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.

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

stoch_length

integer

Period length for computing the stochastic oscillator of the RSI. Takes values in the range from 1 to 800

Default: 14

k_period

integer

Period for smoothing the %K line. Takes values in the range from 1 to 800

Default: 3

d_period

integer

Period for smoothing the %D line, which is a moving average of %K. Takes values in the range from 1 to 800

Default: 3

series_type

string

Specifies the price data type: open, high, low, or close.

Supports: open, high, low, close

Default: close

rsi_length

integer

Length of period for calculating the RSI component. 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: ;

slow_kma_type

string

slow_dma_type

string

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

series_type

string

Price type on which technical indicator is calculated

rsi_length

integer

Length of period for calculating the RSI component

stoch_length

integer

Period length for computing the stochastic oscillator of the RSI

k_period

integer

Period for smoothing the %K line

d_period

integer

Period for smoothing the %D line, which is a moving average of %K

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

k

string

K value

d

string

D 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": "STOCHRSI - Stochastic RSI",
            "series_type": "close",
            "rsi_length": 14,
            "stoch_length": 14,
            "k_period": 3,
            "d_period": 3
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "k": "100.0",
            "d": "33.33333",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Ultimate oscillator endpoint

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.

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_1

integer

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

Default: 7

time_period_2

integer

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

Default: 14

time_period_3

integer

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

Default: 28

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_1

integer

The first time period used for calculation in the indicator

time_period_2

integer

The second time period used for calculation in the indicator

time_period_3

integer

The third 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

ultosc

string

Ultimate Oscillator 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": "ULTOSC - Ultimate Oscillator",
            "time_period_1": 7,
            "time_period_2": 14,
            "time_period_3": 28
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "ultosc": "25.17927",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}

Williams %R

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.

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

willr

string

Williams %R 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": "WILLR - Williams %R",
            "time_period": 9
        }
    },
    "values": [
        {
            "datetime": "2019-08-09 15:59:00",
            "willr": "-84.8916",
            "open": "148.73500",
            "high": "148.86000",
            "low": "148.73000",
            "close": "148.85001",
            "volume": "624277"
        }
    ],
    "status": "ok"
}