Skip to main content
GET
Get Contest Leaderboard

Endpoint

GET /api/contests/{id}/leaderboard Returns a contest leaderboard sorted by PnL or volume.

Parameters

Usage Example

Response Structure

The generated API panel lists the response schema for status codes: 200, 404, 503, 500. Error responses generally return an error or message field.

Path Parameters

id
string
required

Contest ID.

Query Parameters

sortBy
string

Sort field: pnl or volume.

Example:

"pnl"

limit
integer

Items to return.

Example:

50

offset
integer

Pagination offset.

Example:

0

Response

Successful response

The response is of type object.