Skip to main content
GET
/
api
/
contests
/
{id}
/
leaderboard
Get Contest Leaderboard
curl --request GET \
  --url https://backend-global.gains.trade/api/contests/{id}/leaderboard
{}

​
Endpoint

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

​
Parameters

ParameterLocationRequiredTypeDescription
idpathYesstringContest ID.
sortByqueryNostringSort field: pnl or volume.
limitqueryNointegerItems to return.
offsetqueryNointegerPagination offset.

​
Usage Example

curl -X GET "https://backend-global.gains.trade/api/contests/contest-id/leaderboard"

​
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.