Convert raw OHLC data into derived series or aggregated values to feed other indicators or reveal different perspectives on price (e.g. typical price, HLC3, weighted close, arithmetic transforms like SUM, AVG, LOG, SQRT).
The Addition (ADD) endpoint calculates the sum of two input data series, such as technical indicators or price data, and returns the combined result. This endpoint is useful for users who need to aggregate data points to create custom indicators or analyze the combined effect of multiple data series in financial analysis.
Route
/addAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type_1
stringPrice type used as the first part of technical indicator
Supports: close, open, high, low, volume
Default:
open
series_type_2
stringPrice type used as the second part of technical indicator
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "ADD - Arithmetic Addition",
"series_type_1": "open",
"series_type_2": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"add": "402.10798",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Average (AVG) endpoint calculates the arithmetic mean of a specified data series over a chosen time period. It returns a smoothed dataset that helps users identify trends by reducing short-term fluctuations. This endpoint is useful for obtaining a clearer view of data trends, particularly in time series analysis.
Route
/avgAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
time_period
integerNumber of periods to average over. Takes values in the range from 1 to 800
Default:
9
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "AVG - Average",
"series_type": "close",
"time_period": 9
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"avg": "201.53871",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Average Price (AVGPRICE) endpoint calculates and returns the mean value of a security's open, high, low, and close prices. This endpoint provides a straightforward metric to assess the overall price level of a security over a specified period.
Route
/avgpriceAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "AVGPRICE - Average Price"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"avgprice": "201.02449",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Ceiling (CEIL) endpoint rounds each value in the input data series up to the nearest whole number. It returns a series where each original data point is adjusted to its ceiling value, which can be useful for precise calculations or when integrating with other technical indicators that require integer inputs.
Route
/ceilAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "CEIL - CEIL",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"ceil": "202.0",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Division (DIV) endpoint calculates the result of dividing one data series by another, providing a normalized output. It is commonly used to combine or adjust multiple technical indicators or price data for comparative analysis. This endpoint returns the division results as a time series, allowing users to easily interpret and utilize the normalized data in their financial models or charts.
Route
/divAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type_1
stringPrice type used as the first part of technical indicator
Supports: close, open, high, low, volume
Default:
open
series_type_2
stringPrice type used as the second part of technical indicator
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "DIV - Arithmetic Division",
"series_type_1": "open",
"series_type_2": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"div": "1.00201",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Exponential (EXP) Indicator endpoint computes the exponential value of a specified input, providing a numerical result that is commonly applied in complex mathematical and financial computations.
Route
/expAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "EXP - Exponential",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"exp": "2.0649375034375067e+87",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Floor (FLOOR) endpoint processes numerical input data by rounding each value down to the nearest integer. It returns a series of adjusted data points that can be used for further calculations or combined with other datasets. This endpoint is useful for users needing to simplify data by removing decimal precision, aiding in scenarios where integer values are required.
Route
/floorAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "FLOOR - FLOOR",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"floor": "201.0",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The heikinashi candles endpoint provides smoothed candlestick data by averaging price information to reduce market noise. It returns a series of Heikin Ashi candles, which include open, high, low, and close values, making it easier to identify trends and potential reversals in asset prices. This endpoint is useful for traders and analysts seeking a clearer view of market trends without the volatility present in traditional candlestick charts.
Route
/heikinashicandlesAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "HEIKINASHICANDLES - Heikin-Ashi Candles"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"heikinhighs": "201.25599",
"heikinopens": "200.9825",
"heikincloses": "201.02449",
"heikinlows": "200.85199",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The High, Low, Close Average (HLC3) endpoint calculates and returns the average of a security's high, low, and close prices for a specified period. This endpoint provides a straightforward metric to assess price trends, helping users quickly identify the average price level of a security over time.
Route
/hlc3API credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "HLC3 - High, Low, Close Average Values"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"hlc3": "201.05266",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Natural Logarithm (LN) endpoint computes the natural logarithm of a specified input value, returning a numerical result. This endpoint is useful for users needing to perform logarithmic transformations on data, which can be applied in various financial calculations and advanced mathematical analyses.
Route
/lnAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "LN - Natural Logarithm to the base of constant e",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"ln": "5.30355",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Base-10 Logarithm (LOG10) endpoint computes the base-10 logarithm of a specified input value. It returns a numerical result that represents the power to which the number 10 must be raised to obtain the input value. This endpoint is useful for transforming data into a logarithmic scale, which can simplify the analysis of exponential growth patterns or compress large ranges of data in financial calculations.
Route
/log10API credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "LOG10 - Logarithm to base 10",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"log10": "2.3033",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Median Price (MEDPRICE) endpoint calculates and returns the average of the high and low prices of a security for a specified period. This endpoint provides a simplified view of price movements, helping users quickly assess price trends by focusing on the midpoint of price action.
Route
/medpriceAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "MEDPRICE - Median Price"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"medprice": "201.05399",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Multiplication (MULT) endpoint calculates the product of two input data series, returning a new data series that represents the element-wise multiplication of the inputs. This is useful for combining or adjusting technical indicators or price data to create custom metrics or to normalize values across different scales.
Route
/multAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type_1
stringPrice type used as the first part of technical indicator
Supports: close, open, high, low, volume
Default:
open
series_type_2
stringPrice type used as the second part of technical indicator
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "MULT - Arithmetic Multiply",
"series_type_1": "open",
"series_type_2": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"mult": "40422.66609",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Square Root (SQRT) endpoint computes the square root of a specified numerical input. It returns a single numerical value representing the square root, which can be used in various mathematical computations or financial models requiring this specific transformation.
Route
/sqrtAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "SQRT - Square Root",
"series_type": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"sqrt": "14.17921",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Subtraction (SUB) endpoint calculates the difference between two input data series, such as technical indicators or price data. It returns a time series of the resulting values, allowing users to compare or normalize data by highlighting the variance between the two series.
Route
/subAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type_1
stringPrice type used as the first part of technical indicator
Supports: close, open, high, low, volume
Default:
open
series_type_2
stringPrice type used as the second part of technical indicator
Supports: close, open, high, low, volume
Default:
close
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "SUB - Arithmetic Subtraction",
"series_type_1": "open",
"series_type_2": "close"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"sub": "0.404",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Summation (SUM) endpoint calculates the cumulative total of a specified data series over a defined time period. It returns a numerical value representing the sum, which can be used to track the aggregate value of financial data, such as stock prices or trading volumes, over time. This endpoint is useful for users needing to compute the total accumulation of a dataset for further analysis or reporting.
Route
/sumAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
series_type
stringPrice type on which technical indicator is calculated
Supports: close, open, high, low, volume
Default:
close
time_period
integerNumber of periods to average over. Takes values in the range from 1 to 800
Default:
9
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "SUM - Summation",
"series_type": "close",
"time_period": 9
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"sum": "1812.70842",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Typical Price (TYPPRICE) endpoint calculates and returns the average of a financial instrument's high, low, and close prices for a given period. This endpoint provides a simplified metric that reflects the central tendency of price movements, useful for traders and analysts who need a straightforward view of price trends.
Route
/typpriceAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "TYPPRICE - Typical Price"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"typprice": "201.05266",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}
The Weighted Close Price (WCLPRICE) endpoint calculates a security's average price by giving additional weight to the closing price, using the formula: (High + Low + Close * 2) / 4.
Route
/wclpriceAPI credits cost
1 per symbol
symbol
stringSymbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, ...
Example:
AAPL
figi
stringThe 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
stringLook 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
stringLook 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
stringInterval between two consecutive points in time series
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1min
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard
Example:
XNAS
country
stringThe country where the instrument is traded, e.g., United States or US
Example:
United States
type
stringThe 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
integerNumber 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
stringThe format of the response data
Supports: JSON, CSV
Default:
JSON
delimiter
stringThe separator used in the CSV response data
Default:
;
prepost
booleanReturns 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
integerSpecifies 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
stringSorting order of the output
Supports: asc, desc
Default:
desc
include_ohlc
booleanSpecify if OHLC values should be added in the output
Supports: true, false
Default:
false
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found hereInterval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
date
stringSpecifies 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
stringCan be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05
Default location:
UTCAmerica/New_York)timezone parameter is provided.timezone is given then, start_date and end_date will be used in the specified location
Examples:
&symbol=AAPL&start_date=2019-08-09T15:50:00&…&symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…&symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&...
Example:
2024-08-22T15:04:05
end_date
stringThe ending date and time for data selection, see start_date description for details.
Example:
2024-08-22T16:04:05
previous_close
booleanA 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
stringAdjusting mode for prices
Supports: all, splits, dividends, none
Default:
splits
Response
{
"meta": {
"symbol": "AAPL",
"interval": "1min",
"currency": "USD",
"exchange_timezone": "America/New_York",
"exchange": "NASDAQ",
"mic_code": "XNAS",
"type": "Common Stock",
"indicator": {
"name": "WCLPRICE - Weighted Close Price"
}
},
"values": [
{
"datetime": "2019-08-09 15:59:00",
"wclprice": "201.052",
"open": "148.73500",
"high": "148.86000",
"low": "148.73000",
"close": "148.85001",
"volume": "624277"
}
],
"status": "ok"
}