Skip to main content
GET
Get Referral Leaderboard
This endpoint is public — no authentication required. When the request is authenticated, the response additionally carries a me block pinning your own rank and entry, even when you are outside the returned page.
Anonymous responses are CDN-cached for up to 5 minutes; authenticated responses are private with a 60-second cache. Ranks are absolute across pages and follow the active sortBy.

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

Ranked referral leaderboard page

entries
object[]
required
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.