Get Perpl's leaderboard ranked by PnL or by volume
/v1/chains/{chain}/perpl/leaderboardCall this for the top accounts of Perpl's public leaderboard, ranked by by (pnl, the default, or volume) for the period (all time, the default, or the last day). Each row has the rank in that ranking, the wallet address, its pnl_usd and volume_usd, and volume_share, the volume of the row over the volume of all rows of that board (about 5,000 accounts), a number from 0 to 1. limit is 1 to 100, 25 by default.
The figures are Perpl's own and Sona does not recompute them, which coverage says with perpl_leaderboard_figures. The volume counts both sides of every trade, so it is about twice the traded volume, and Perpl does not publish what its PnL figure includes. Sona reads the four boards every 10 minutes, and as_of is the time Perpl stamped on the board that was served. A board older than 30 minutes is not served. meta.as_of describes the chain snapshot that gave the collateral decimals, not the board.
Sona keeps an answer for 1 minute.
Path parameters
| Name | Type | Description |
|---|---|---|
chainRequired | string | The chain, as a CAIP-2 chain ID. Only Monad, |
Query parameters
| Name | Type | Description |
|---|---|---|
by | stringDefault pnl | The ranking: |
period | stringDefault all |
|
limit | integerDefault 25 | The most rows to return, from 1 to 100. A value out of range answers 400 |
Response
The answer, wrapped in the {data, meta, links} envelope.
| Field | Type | Description |
|---|---|---|
| as_of | string | A moment in RFC 3339, UTC, in whole seconds. |
| by | string | pnlvolume |
| chain | string | The CAIP-2 id of the chain. |
| coverage | array of strings | The codes of the limits that apply to this answer, in a fixed order. It is empty when none applies. The status route explains each code. |
| items | array of objects | |
| kind | string | perpl_leaderboard |
| period | string | allday |
Cost
1 credit. The time limit is 5 seconds.
Errors
| Status | Code |
|---|---|
| 400 | invalid_query |
| 404 | unsupported_chain |
| 429 | rate_limitedcredits_exhausted |
| 500 | internal |
| 503 | upstream_unavailable |
| 504 | deadline_exceeded |
400 invalid_query for an unknown by or period, a limit outside 1 to 100 or another query key, 404 unsupported_chain, 429 rate_limited or credits_exhausted, 503 upstream_unavailable while the board was not read yet or is older than 30 minutes, and 504 deadline_exceeded.