GET /leaderboard

Returns the wallet leaderboard for your project, ranked by total SOL reclaimed. Automatically scoped to the project linked to your API key.

Request


GET https://api.aerosol.com/api/v1/burner/leaderboard

Headers

Header	Required	Description
`X-Api-Key` or `Authorization`	Yes	API key or session token

Query parameters

All parameters are optional.

Parameter	Type	Description
`payer`	`string`	Filter to a specific wallet address
`transactionType`	`string`	Filter by transaction type (e.g., `token_account_closure`, `token_burn`)
`startDate`	`string`	ISO 8601 date string for range start
`endDate`	`string`	ISO 8601 date string for range end

Example request


curl "https://api.aerosol.com/api/v1/burner/leaderboard?startDate=2026-01-01T00:00:00Z" \
  -H "X-Api-Key: ak_live_..."

Response

200 OK


[
  {
    "payer": "DRpbCBMxVnDK7maPM5tGv6MvB3v1sRMC86PZ8okm21hy",
    "totalGrossRebate": 45678901234,
    "totalNetRebate": 43394956172,
    "totalTransactionCount": 1523,
    "transactionTypeCounts": {
      "token_account_closure": 1200,
      "token_burn": 300,
      "nft_burn": 23
    },
    "totalDonationAmount": 4567890123,
    "totalDonationCount": 456,
    "totalCommunityAmount": 6851835185
  }
]

Response fields

Field	Type	Description
`payer`	`string`	Wallet address
`totalGrossRebate`	`number`	Total SOL reclaimed before fees, in lamports
`totalNetRebate`	`number`	Total SOL kept after fees, in lamports
`totalTransactionCount`	`number`	Total transactions
`transactionTypeCounts`	`Record<string, number>`	Breakdown by transaction type
`totalDonationAmount`	`number`	Total donated to your project, in lamports
`totalDonationCount`	`number`	Number of donations
`totalCommunityAmount`	`number`	Total community contribution, in lamports

Error responses

Status	Cause
400	Invalid date format or query parameter
401	Invalid or missing credentials
429	Rate limit exceeded

SDK example


const leaderboard = await client.getLeaderboard({
  startDate: new Date('2026-01-01'),
  endDate: new Date('2026-04-01'),
})