GET
Get leaderboard rankings

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

Query Parameters

metric_name
enum<string>
required

The leaderboard metric to retrieve.

Available options:
volume,
projected_pnl,
predictions
time_period
enum<string>
default:all

Time window for volume and predictions calculations. Defaults to all.

Available options:
daily,
weekly,
monthly,
yearly,
all
categoryId
integer

Optional event category filter.

limit
integer
default:20

Maximum number of leaderboard entries to return (1-100). Defaults to 20.

Required range: 1 <= x <= 100

Response

Leaderboard ranking successfully retrieved.

success
boolean
required
Example:

true

data
object
required