Agara

Get a reward program's leaderboard

POST/api/v1/rewards/leaderboard/list

The program's board for its current phase, its top rows, and the position of each requested wallet. A requested wallet that is not on the board, or whose profile is private, comes back with a null rank, so a response never says why a wallet is missing. On a REFERRAL program every row and ranked position carries the wallet's referral figures, and target_rank and gap_to_target_micro are always null. Public, no authentication required.

Request Body

application/json

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/v1/rewards/leaderboard/list" \  -H "Content-Type: application/json" \  -d '{    "program_id": "4f6c2a1e-8d3b-4c1a-9a2e-6b1f0c3d5e7a",    "limit": 100,    "wallets": [      "0x51c2f3a1b0e4d5c6a7b8c9d0e1f2a3b4c5d69a10"    ]  }'
{  "program_id": "string",  "phase": "UPCOMING",  "board": {    "snapshot_kind": "LIVE",    "provisional": true,    "cutoff_at": "string",    "data_through_at": "string",    "computed_at": "string",    "next_refresh_at": "string",    "stale": true,    "ranked_wallets": 0  },  "entries": [    {      "rank": 0,      "address": "string",      "display_name": "string",      "avatar_url": "string",      "private": true,      "volume_micro": "string",      "prize_micro": "string",      "referral": {        "score_ppm": 0,        "qualified_traders": 0      }    }  ],  "positions": [    {      "address": "string",      "rank": 0,      "display_name": "string",      "avatar_url": "string",      "volume_micro": "string",      "prize_micro": "string",      "referral": {        "score_ppm": 0,        "qualified_traders": 0      },      "target_rank": 0,      "gap_to_target_micro": "string"    }  ]}