Sign in
Partners

Retrieve the leaderboard

Ranks referrers by partner business earnings — all-time by default, or over the current day, month, year, or trailing 30 days. Authentication is optional: authenticated callers also get their own standing, anonymous callers get the rankings alone.

get/partners/leaderboard

Query parameters

period'day' | 'month' | 'year' | 'last_30_days' | 'all_time'

Time window for the rankings. day, month, and year count earnings since the start of the current calendar day, month, or year; last_30_days counts earnings over the trailing 30 days; all_time ranks lifetime earnings.

Response

caller has no referral earnings

Example response

{
  "leaders": [
    {
      "first_referral_started_at": "2026-01-01T12:00:00.000Z",
      "rank": 1,
      "total_earnings_usd": "100.00",
      "total_volume_usd": "0.00",
      "user": {
        "city": "Austin",
        "country": "US",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Marcus Webb",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "marcuswebb"
      }
    }
  ],
  "me": {
    "first_referral_started_at": "2026-01-01T12:00:00.000Z",
    "rank": 2,
    "total_earnings_usd": "4.00",
    "total_volume_usd": "40.00",
    "user": {
      "city": "Austin",
      "country": "US",
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Marcus Webb",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "marcuswebb"
    }
  }
}

Changes

Changed in 3 of the 74 revisions of this API.4

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc2See the full diff
    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3a06a605784b1See the full diff
    • ○

      api operation id retrieveBusinessReferralLeaderboard removed and replaced with retrievePartnerLeaderboard

      api-operation-id-removed

Of the 74 revisions, 1 has no diff computed.