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 seperated list of assets <asset>,<asset>.Defaults to all assets the user has access to if not provided.

Maximum array length: 100
bps
number<double>[]
Maximum array length: 25
Example:
lookback
enum<string>
  • 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"

organizations
string[]

Comma seperated list of organization slugs <slug>,<slug>.Defaults to all organizations the user is member of, if not provided.Available organizations are returned in the /v1/organizations endpoint.

Maximum array length: 100
time_end
string<date-time>
time_start
string<date-time>

Response

An object with rows (one per organization, exchange and pair) and facets (the organizations, exchanges, assets and bases in rows). Depth columns are named after the requested bps levels (bid_<bps>bps, ask_<bps>bps and their _coverage); the schema lists the default 50, 100 and 200.

rows
object[]
required
facets
object
required