Skip to main content
GET
Trader leaderboard

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}$
metric
enum<string>
Available options:
realizedPnl,
volume
limit
integer
Required range: 1 <= x <= 100
cursor
string
Maximum string length: 200
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

Rank within one category (a Category.id, as /venue-events?categoryIds= takes). Includes its sub-categories: football covers NFL games. At most 1.

Maximum array length: 1
Minimum string length: 1
venueEventIds

Rank traders on these events. Each id is expanded to the same event on every venue. At most 5. Cannot be combined with categoryIds, from or to.

Maximum array length: 5
Minimum string length: 1
userIds

Return only these users' rows (AGG user ids), unpaginated. At most 100, or 20 with a timestamp from/to. Requested users with no stats in the slice are omitted (the single-user lookups return a zero row instead). Cannot be combined with the single-user lookups or cursor.

Maximum array length: 100
Minimum string length: 1

Response

200

data
object[]
required

This page of results.

nextCursor
string | null
required

Pass as cursor to fetch the next page; null on the last page.

hasMore
boolean
required

true when another page exists.