Endpoint referenceLeaderboard
GET /v1/leaderboard
Trader leaderboard from the indexer projections, ranked in SQL per deployment scope. scope selects the venue (testnet today; mainnet stays empty until launch, and a scope from another Stellar network answers not_indexed_here with zero rows). Rank by realized PnL (sort=pnl, default) or traded notional (sort=volume); ties break on the other metric, then trader, so ranks are unique and pages never overlap. Pages slice an immutable snapshot: pass the returned snapshot id with the next offset to keep ranks stable while paging, and watch snapshotChanged for the moment the board recomputed underneath you. updatedAt is when the index last advanced (unix seconds).
Query Parameters
scope?string
Value in
- "testnet"
- "mainnet"
sort?string
Value in
- "pnl"
- "volume"
limit?integer
Range
1 <= value <= 200offset?integer
Range
0 <= valuesnapshot?string
Length
length <= 128Response Body
application/json
curl -X GET "https://example.com/v1/leaderboard"{ "sort": "pnl", "scope": "testnet", "network": "string", "state": "ok", "updatedAt": null, "total": 0, "limit": 0, "offset": 0, "snapshot": "string", "snapshotChanged": true, "leaders": [ { "rank": 0, "trader": "string", "pnl": "string", "volume": "string", "trades": 0, "liqCount": 0 } ]}