Get My Referred Users

Your own referred users, paginated, filtered, and sorted server-side. counts covers all your referred users regardless of the active filter; total counts only rows matching the current status filter.

GET /referral/usdc/referrals

Get My Referred Users

cURL

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

200

{
  "counts": {
    "all": 123,
    "awaiting": 123,
    "earning": 123
  },
  "entries": [
    {
      "account": "<string>",
      "avatarAccount": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "displayName": "<string>",
      "earnedRaw": "<string>",
      "feesGeneratedRaw": "<string>",
      "pfpUrl": "<string>",
      "referredProfileId": 123,
      "username": "<string>",
      "volumeRaw": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

Money and volume fields are raw USDC with 6 decimals, returned as strings — divide by 1e6 for the dollar amount.

The status filter distinguishes referred users who have traded (earning) from those who have signed up but not traded yet (awaiting). counts always covers all your referred users regardless of the active filter, so filter chips stay accurate across pages; total counts only the rows matching the current status filter.

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: 10

Number of items per page (1-100).

Required range: 1 <= x <= 100

offset · number · default: 0

Offset into the result set.

Required range: x >= 0

status · enum<string> · default: all

Filter by activity: awaiting = has not traded yet, earning = has traded.

Available options: all, awaiting, earning

sortBy · enum<string> · default: earned

Sort column.

Available options: createdAt, earned, fees, volume

sortOrder · enum<string> · default: DESC

Sort direction.

Available options: ASC, DESC

Response

200

application/json

Paginated referred users with filter counts

counts · object · required

Show child attributes

entries · object[] · required

Show child attributes

limit · number · required

offset · number · required

total · number · required

Rows matching the current status filter (drives pagination of the current view).