Skip to main content
Rank pairs by market data (JSON body)

Authorizations

Authorization
string
header
default:Token <token>
required

Token-based authentication with required prefix "Token ". Example: "Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"

Query Parameters

filename
string

File name of the CSV download. Defaults to data.csv.

type
enum<string>

csv returns a CSV file instead of JSON.

Available options:
csv

Body

assets
string[]

Comma separated list of assets. Defaults to all authorized assets. Regular users may request at most 100 assets and, when omitted, receive the first 100 authorized assets ordered by symbol; staff are unlimited.

time_start
string<date-time>

Window start, ISO 8601. UTC when no offset is given.

time_end
string<date-time>

Window end, ISO 8601. UTC when no offset is given.

lookback
enum<string>

Relative window ending now. Can't be combined with time_start/time_end.

  • 30-minutes - 30-minutes
  • 1-hour - 1-hour
  • 3-hours - 3-hours
  • 6-hours - 6-hours
  • 12-hours - 12-hours
  • 1-day - 1-day
  • 7-days - 7-days
  • 1-month - 1-month
  • 3-months - 3-months
  • 6-months - 6-months
  • 1-year - 1-year
Available options:
30-minutes,
1-hour,
3-hours,
6-hours,
12-hours,
1-day,
7-days,
1-month,
3-months,
6-months,
1-year
interval
enum<string>
  • 1M - Aggregated in 1 month periods.
  • 1w - Aggregated in 1 week periods.
  • 1d - Aggregated in 1 day periods.
  • 4h - Aggregated in 4 hour periods.
  • 1h - Aggregated in 1 hour periods.
  • 30m - Aggregated in 30 minute periods.
  • 15m - Aggregated in 15 minute periods.
  • 5m - Aggregated in 5 minute periods.
  • 1m - Aggregated in 1 minute periods.
  • c - Will return all the data for the specified time range using the biggest periods possible.
  • a - Will return the aggregate of the data for the specified time range.
Available options:
1M,
1w,
1d,
4h,
1h,
30m,
15m,
5m,
1m,
c,
a
market_hours_preset
enum<string>

Trading session to restrict the window to. Requires market_hours_days; can't be combined with time_start/time_end or lookback.

  • pre-market - pre-market
  • opening-bell - opening-bell
  • market-hours - market-hours
  • closing-bell - closing-bell
  • after-hours - after-hours
  • blue-ocean - blue-ocean
  • weekend-hours - weekend-hours
Available options:
pre-market,
opening-bell,
market-hours,
closing-bell,
after-hours,
blue-ocean,
weekend-hours
market_hours_days
string

Days to include, as comma-separated week:day pairs such as this:1,last:5, or a JSON array of {"week", "day"} objects. week is this or last; day is 0 (Sunday) to 6 (Saturday).

market_hours_timezone
string
default:America/New_York

Time zone of the market-hours sessions.

exchanges
string[]

Comma-separated exchange slugs, e.g. binance,okx. Defaults to all exchanges.

Maximum array length: 100
types
enum<string>
  • all - Spot and Perp
  • spot - Spot
  • perp - Perp
Available options:
all,
spot,
perp
page
integer
default:1

Page number; each page has 20 rows.

Required range: x >= 1
bps
number<double>[]

Depth levels to return, in basis points.

Maximum array length: 25
sort_by
string
default:volume

Column to sort by: volume, price_change, usd_open_interest, funding_rate_8h, tick_bps, or a depth column such as bid_2bps.

Pattern: ^(volume|price_change|usd_open_interest|funding_rate_8h|tick_bps|bid_[0-9]+(?:\.[0-9]+)?bps|ask_[0-9]+(?:\.[0-9]+)?bps)$
sort_direction
enum<string>
default:desc
  • asc - Ascending
  • desc - Descending
Available options:
asc,
desc

Response

asset
string
required
exchange
object
required
pair
string
required
price_change
number<double> | null
required
volume
number<double>
required
usd_open_interest
number<double>
funding_rate_8h
number<double>
tick_bps
number<double> | null
tick_bps_status
string | null
tick_bps_samples
number<double> | null
bid_0bps
number<double> | null
bid_0.05bps
number<double> | null
bid_0.1bps
number<double> | null
bid_0.15bps
number<double> | null
bid_0.25bps
number<double> | null
bid_0.5bps
number<double> | null
bid_0.75bps
number<double> | null
bid_1bps
number<double> | null
bid_2bps
number<double> | null
bid_3bps
number<double> | null
bid_5bps
number<double> | null
bid_10bps
number<double> | null
bid_15bps
number<double> | null
bid_20bps
number<double> | null
bid_25bps
number<double> | null
bid_30bps
number<double> | null
bid_40bps
number<double> | null
bid_50bps
number<double> | null
bid_60bps
number<double> | null
bid_75bps
number<double> | null
bid_100bps
number<double> | null
bid_150bps
number<double> | null
bid_200bps
number<double> | null
bid_300bps
number<double> | null
bid_500bps
number<double> | null
ask_0bps
number<double> | null
ask_0.05bps
number<double> | null
ask_0.1bps
number<double> | null
ask_0.15bps
number<double> | null
ask_0.25bps
number<double> | null
ask_0.5bps
number<double> | null
ask_0.75bps
number<double> | null
ask_1bps
number<double> | null
ask_2bps
number<double> | null
ask_3bps
number<double> | null
ask_5bps
number<double> | null
ask_10bps
number<double> | null
ask_15bps
number<double> | null
ask_20bps
number<double> | null
ask_25bps
number<double> | null
ask_30bps
number<double> | null
ask_40bps
number<double> | null
ask_50bps
number<double> | null
ask_60bps
number<double> | null
ask_75bps
number<double> | null
ask_100bps
number<double> | null
ask_150bps
number<double> | null
ask_200bps
number<double> | null
ask_300bps
number<double> | null
ask_500bps
number<double> | null