Get Friends Leaderboard

The global leaderboard scoped to your own referred users: each row is that user’s own referral standing (their referred count and referral earnings), keeping the global ranking. Only referred users who are themselves earning referrers appear. The response never carries a me block.

GET /referral/usdc/leaderboard/friends

Get Friends Leaderboard

cURL

curl --request GET \
  --url https://api.limitless.exchange/referral/usdc/leaderboard/friends \
  --header 'lmts-api-key: <api-key>'

200

{
  "entries": [
    {
      "account": "<string>",
      "avatarAccount": "<string>",
      "displayName": "<string>",
      "earnedRaw": "<string>",
      "feesGeneratedRaw": "<string>",
      "pfpUrl": "<string>",
      "rank": 123,
      "referredCount": 123,
      "referrerProfileId": 123,
      "username": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123,
  "me": {
    "entry": {
      "account": "<string>",
      "avatarAccount": "<string>",
      "displayName": "<string>",
      "earnedRaw": "<string>",
      "feesGeneratedRaw": "<string>",
      "pfpUrl": "<string>",
      "rank": 123,
      "referredCount": 123,
      "referrerProfileId": 123,
      "username": "<string>"
    },
    "rank": 123
  }
}

The global leaderboard scoped to your own referred users. Each row is that user’s own referral standing (their referred count and their referral earnings — not your cut from them), keeping the global ranking.

Only referred users who are themselves earning referrers appear, so the board can be sparse until your network grows. The response never carries a me block.

Authorizations

lmts-api-key · string · header · required

Scoped API token with HMAC-SHA256 signing. Requires three headers: lmts-api-key (token ID), lmts-timestamp (ISO-8601), lmts-signature (Base64-encoded HMAC). See Authentication docs for details.

Query Parameters

limit · number · default: 100

Number of items per page (1-100).

Required range: 1 <= x <= 100

offset · number · default: 0

Offset into the result set.

Required range: 0 <= x <= 10000

sortBy · enum<string> · default: earned

Sort column.

Available options: earned, fees, referred

sortOrder · enum<string> · default: DESC

Sort direction.

Available options: ASC, DESC

Response

200

application/json

Ranked page of your referred users who are earning referrers

entries · object[] · required

Show child attributes

limit · number · required

offset · number · required

total · number · required

Total ranked referrers on the board.

me · object | null

Your own rank and entry, pinned even when outside the returned page. Present on the global board when the request is authenticated; null when you have no ranked position; omitted on the friends board.

Show child attributes