Skip to main content
GET
Trader leaderboard series

Integration guide

Authorizations

x-app-id
string
header
required

Your application ID. Required on app-tier and user-tier routes. Omitted on routes that authenticate with x-app-api-key only.

Query Parameters

from

UTC calendar day, inclusive

Pattern: ^\d{4}-\d{2}-\d{2}$
to

UTC calendar day, inclusive

Pattern: ^\d{4}-\d{2}-\d{2}$
interval
enum<string>

day (default): one point per UTC day, from/to are days. hour: one point per hour from from, from/to are timestamps, at most 31 days.

Available options:
day,
hour
userId
string
Minimum string length: 1
externalId
string
Minimum string length: 1
username
string
Minimum string length: 1
walletAddress
string
Minimum string length: 1
categoryIds

Limit the series to one category (a Category.id). At most 1.

Maximum array length: 1
Minimum string length: 1

Response

200

userId
string | null
required

AGG user id; null when no user was given (app-wide series).

from
string
required

First day of the series (UTC, inclusive); for interval=hour, the start timestamp (ISO-8601 UTC).

to
string
required

Last day of the series (UTC, inclusive), never after today; for interval=hour, the exclusive end timestamp, never after now.

totals
object
required
points
object[]
required

One point per UTC day in [from, to] (or per hour in [from, to) for interval=hour), oldest first. Points without activity are 0.

Maximum array length: 744