Leaderboard

Get aggregated leaderboard statistics

Returns aggregate statistics across all makers including total profit, volume, deposits, and average success rate.

get/v2/leaderboard/summary

Request

  • Base URL
    https://api.peer.xyz
  • URL
    https://api.peer.xyz/v2/leaderboard/summary
  • Auth
    none declared

Response

Summary retrieved successfully

successboolean required
messagestring required
statusCodenumber required
errorCodestring

Example response

{
  "responseObject": {
    "totalMakers": 1247,
    "totalRealizedProfitUsd": 2450000,
    "totalFilledVolumeUsd": 85000000,
    "totalGrossDepositedUsd": 12500000,
    "averageSuccessRatePercent": 94.5,
    "meta": {
      "cachedAt": "2024-12-14T18:40:00Z",
      "cacheExpiresAt": "2024-12-14T18:45:00Z",
      "builtAt": "2024-12-14T18:40:00Z",
      "effectiveWindow": "lifetime"
    }
  }
}

Changes

No recorded changes to this operation across all 35 revisions of this API.