Skip to main content
GET
cURL

Authorizations

Authorization
string
header
default:ApiKey <key>
required

Scoped API key with required prefix "ApiKey ". Available scopes: metrics:read, reported_metrics:write and mm_metrics:read.

Query Parameters

assets
string[]

Comma-separated asset symbols, e.g. BTC,ETH_PERP. Only assets of your organizations are allowed (see /v1/organizations/). Defaults to all of them.

Maximum array length: 100
bps
number<double>[]
required

Comma-separated distances from the mid price, in basis points (1 bps = 0.01%), e.g. 0.5,1,2.

Maximum array length: 25
Example:
chart_bps
number<double>[]

Depth levels in bps for the charts. Defaults to bps.

Maximum array length: 25
chart_interval
enum<string>
default:1h
  • 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 chart data using the biggest periods possible.
Available options:
1M,
1w,
1d,
4h,
1h,
30m,
15m,
5m,
1m,
c
Minimum string length: 1
interval
enum<string>
required
  • a - Will return the aggregate of the data for the specified time range.
Available options:
a
Minimum string length: 1
Example:

"a"

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
Minimum string length: 1
Example:

"1-day"

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_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
Minimum string length: 1
market_hours_timezone
string
default:America/New_York

Time zone of the market-hours sessions.

Minimum string length: 1
sections
enum<string>[]
Maximum array length: 100
  • table - Table
  • charts - Charts
Available options:
table,
charts
time_end
string<date-time>

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

time_start
string<date-time>

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

Response

Object with coverage and the requested table and charts sections.

coverage
object[]
required

Same rows as table.volumes; empty when table is not requested.

table
object

Aggregates over the window. Only when sections includes table.

charts
object

Time series at chart_interval. Only when sections includes charts.