Skip to main content
GET
/
v1
/
leaderboard
Get PnL Leaderboards
curl --request GET \
  --url https://api.clicker.xyz/v1/leaderboard \
  --header 'Authorization: Bearer <token>'
{
  "sections": [
    {
      "key": "<string>",
      "title": "<string>",
      "description": "<string>",
      "commenters": [
        {
          "reason": {
            "title": "<string>",
            "value": "<string>",
            "format": "currency"
          },
          "id": "<string>",
          "name": "<string>",
          "images": {
            "raw": "<string>",
            "xs": "<string>",
            "sm": "<string>"
          },
          "addresses": [
            "<string>"
          ],
          "metadata": {
            "farcasterUsername": "<string>",
            "farcasterId": 123,
            "lensHandle": "<string>",
            "ensName": "<string>",
            "twitterHandle": "<string>",
            "debankName": "<string>",
            "commentCount30d": 123,
            "pnl30d": 123,
            "winRate30d": 123,
            "tradeCount30d": 123,
            "roiPercent30d": 123,
            "perAddressPnl30d": {},
            "perAddressRoiPercent30d": {},
            "perChainPnl30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            },
            "perChainRoiPercent30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            },
            "perChainVolumeUsd30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            }
          },
          "metrics": {
            "thisPartner": {
              "followingCount": 123,
              "followerCount": 123
            },
            "allPartners": {
              "followingCount": 123,
              "followerCount": 123
            },
            "comments": {
              "commentCount30d": 123,
              "commentCountAllTime": 123
            },
            "copytradedAllTime": {
              "count": 123,
              "distinctActors": 123,
              "volumeUSD": 123
            }
          }
        }
      ],
      "others": [
        {
          "reason": {
            "title": "<string>",
            "value": "<string>",
            "format": "currency"
          },
          "id": "<string>",
          "name": "<string>",
          "images": {
            "raw": "<string>",
            "xs": "<string>",
            "sm": "<string>"
          },
          "addresses": [
            "<string>"
          ],
          "metadata": {
            "farcasterUsername": "<string>",
            "farcasterId": 123,
            "lensHandle": "<string>",
            "ensName": "<string>",
            "twitterHandle": "<string>",
            "debankName": "<string>",
            "commentCount30d": 123,
            "pnl30d": 123,
            "winRate30d": 123,
            "tradeCount30d": 123,
            "roiPercent30d": 123,
            "perAddressPnl30d": {},
            "perAddressRoiPercent30d": {},
            "perChainPnl30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            },
            "perChainRoiPercent30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            },
            "perChainVolumeUsd30d": {
              "solana": 123,
              "ethereum": 123,
              "base": 123,
              "hyperliquid": 123
            }
          },
          "metrics": {
            "thisPartner": {
              "followingCount": 123,
              "followerCount": 123
            },
            "allPartners": {
              "followingCount": 123,
              "followerCount": 123
            },
            "comments": {
              "commentCount30d": 123,
              "commentCountAllTime": 123
            },
            "copytradedAllTime": {
              "count": 123,
              "distinctActors": 123,
              "volumeUSD": 123
            }
          }
        }
      ]
    }
  ]
}
V1 is deprecated. We recommend using Leaderboard V2 which provides a simpler, filter-based API with per-chain PnL breakdowns.
The V1 leaderboard returns multiple sections (categories) in a single response. Each section contains two arrays: commenters (traders with swap comments) and others (traders without comments).

​
Migration to V2

See the V2 Leaderboard documentation for migration guidance.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:50
Required range: 0 < x <= 250
​
sections

Response

200

​
sections
object[]
required