> ## Documentation Index
> Fetch the complete documentation index at: https://docs.limitless.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

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.

<Info>
  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.
</Info>


## OpenAPI

````yaml GET /referral/usdc/leaderboard/friends
openapi: 3.0.0
info:
  title: Limitless Exchange API
  description: >-
    Production-ready REST API for prediction market trading, portfolio
    management, and market data on Limitless Exchange (Base L2).
  version: '1.0'
  contact:
    name: API Support
    url: https://limitless.exchange
    email: help@limitless.network
servers:
  - url: https://api.limitless.exchange
    description: Production API
security: []
tags:
  - name: Authentication
    description: User authentication and session management
  - name: Markets
    description: Browse, search, and analyze prediction markets
  - name: Market Navigation
    description: Navigation tree, market pages, and property filters
  - name: Trading
    description: Create, manage, and cancel orders
  - name: Portfolio
    description: Position tracking, trade history, and performance
  - name: API Tokens
    description: Scoped API token management for partner integrations
  - name: Partner Accounts
    description: Sub-account creation and allowance recovery for partner integrations
  - name: System
    description: Public API state and availability information
  - name: Referral
    description: Referral program earnings, referred users, and leaderboards
  - name: Leaderboard
    description: >-
      Live Unrealized PnL leaderboards for open markets and biggest open
      positions
paths:
  /referral/usdc/leaderboard/friends:
    get:
      tags:
        - Referral
      summary: Get Friends Leaderboard
      description: >-
        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.
      operationId: ReferralUsdcController_getFriendsLeaderboard
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of items per page (1-100).
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 100
        - name: offset
          required: false
          in: query
          description: Offset into the result set.
          schema:
            type: number
            minimum: 0
            default: 0
            maximum: 10000
        - name: sortBy
          required: false
          in: query
          description: Sort column.
          schema:
            type: string
            enum:
              - earned
              - fees
              - referred
            default: earned
        - name: sortOrder
          required: false
          in: query
          description: Sort direction.
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
      responses:
        '200':
          description: Ranked page of your referred users who are earning referrers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralUsdcLeaderboardResponseDto'
        '400':
          description: Invalid query parameters
        '401':
          description: Unauthorized
      security:
        - HmacAuth: []
components:
  schemas:
    ReferralUsdcLeaderboardResponseDto:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/ReferralUsdcLeaderboardEntryDto'
        limit:
          type: number
        me:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferralUsdcLeaderboardMeDto'
          description: >-
            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.
        offset:
          type: number
        total:
          type: number
          description: Total ranked referrers on the board.
      required:
        - entries
        - limit
        - offset
        - total
    ReferralUsdcLeaderboardEntryDto:
      type: object
      properties:
        account:
          type: string
          description: The referrer's account address.
        avatarAccount:
          type: string
          description: Address used to derive the fallback avatar.
        displayName:
          type: string
          nullable: true
        earnedRaw:
          type: string
          description: >-
            Total USDC this referrer has earned from the program. Raw USDC with
            6 decimals, returned as a string. Divide by 1e6 for the dollar
            amount.
        feesGeneratedRaw:
          type: string
          description: >-
            Total taker fees this referrer's referred users have generated. Raw
            USDC with 6 decimals, returned as a string. Divide by 1e6 for the
            dollar amount.
        pfpUrl:
          type: string
          nullable: true
        rank:
          type: number
          description: >-
            Absolute rank under the active sort. Ranks stay absolute across
            pages.
        referredCount:
          type: number
          description: Number of credited referred users.
        referrerProfileId:
          type: number
      required:
        - account
        - avatarAccount
        - displayName
        - earnedRaw
        - feesGeneratedRaw
        - pfpUrl
        - rank
        - referredCount
        - referrerProfileId
    ReferralUsdcLeaderboardMeDto:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/ReferralUsdcLeaderboardEntryDto'
        rank:
          type: number
          description: Your absolute rank under the active sort.
      required:
        - entry
        - rank
  securitySchemes:
    HmacAuth:
      type: apiKey
      in: header
      name: lmts-api-key
      description: >-
        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.

````