Endpoint referenceLeaderboard
GET /v1/leaderboard/rank
One trader's rank and row on the full board for a (scope, sort), looked up in the same snapshot the board pages slice, so it is always consistent with the pages and costs no extra scan. rank is null when the trader is not on the board.
Query Parameters
trader*string
Match
^G[A-Z2-7]{55}$Length
56 <= length <= 56scope?string
Value in
- "testnet"
- "mainnet"
sort?string
Value in
- "pnl"
- "volume"
Response Body
application/json
curl -X GET "https://example.com/v1/leaderboard/rank?trader=stringstringstringstringstringstringstringstringstringst"{ "trader": "string", "sort": "pnl", "scope": "testnet", "network": "string", "state": "ok", "rank": null, "total": 0, "snapshot": "string", "updatedAt": null, "entry": null}