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

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

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.


## OpenAPI

````yaml GET /referral/usdc/referrals
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/referrals:
    get:
      tags:
        - Referral
      summary: Get My Referred Users
      description: >-
        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.
      operationId: ReferralUsdcController_getReferrals
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of items per page (1-100).
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 10
        - name: offset
          required: false
          in: query
          description: Offset into the result set.
          schema:
            type: number
            minimum: 0
            default: 0
        - name: status
          required: false
          in: query
          description: >-
            Filter by activity: `awaiting` = has not traded yet, `earning` = has
            traded.
          schema:
            type: string
            enum:
              - all
              - awaiting
              - earning
            default: all
        - name: sortBy
          required: false
          in: query
          description: Sort column.
          schema:
            type: string
            enum:
              - createdAt
              - earned
              - fees
              - volume
            default: earned
        - name: sortOrder
          required: false
          in: query
          description: Sort direction.
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
      responses:
        '200':
          description: Paginated referred users with filter counts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralUsdcReferralsResponseDto'
        '400':
          description: Invalid query parameters
        '401':
          description: Unauthorized
      security:
        - HmacAuth: []
components:
  schemas:
    ReferralUsdcReferralsResponseDto:
      type: object
      properties:
        counts:
          $ref: '#/components/schemas/ReferralUsdcReferralsCountsDto'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/ReferralUsdcReferralEntryDto'
        limit:
          type: number
        offset:
          type: number
        total:
          type: number
          description: >-
            Rows matching the current status filter (drives pagination of the
            current view).
      required:
        - counts
        - entries
        - limit
        - offset
        - total
    ReferralUsdcReferralsCountsDto:
      type: object
      properties:
        all:
          type: number
          description: Every credited referred user.
        awaiting:
          type: number
          description: Referred users who have not traded yet.
        earning:
          type: number
          description: Referred users who have traded.
      required:
        - all
        - awaiting
        - earning
    ReferralUsdcReferralEntryDto:
      type: object
      properties:
        account:
          type: string
          description: The referred user's account address.
        avatarAccount:
          type: string
          description: Address used to derive the fallback avatar.
        createdAt:
          type: string
          format: date-time
          description: When the referral was credited.
        displayName:
          type: string
          nullable: true
        earnedRaw:
          type: string
          description: >-
            USDC you have earned from this user's fills. Raw USDC with 6
            decimals, returned as a string. Divide by 1e6 for the dollar amount.
        feesGeneratedRaw:
          type: string
          description: >-
            Taker fees this user has generated. Raw USDC with 6 decimals,
            returned as a string. Divide by 1e6 for the dollar amount.
        pfpUrl:
          type: string
          nullable: true
        referredProfileId:
          type: number
        volumeRaw:
          type: string
          description: >-
            The referred user's trading volume. Raw USDC with 6 decimals,
            returned as a string. Divide by 1e6 for the dollar amount.
      required:
        - account
        - avatarAccount
        - createdAt
        - displayName
        - earnedRaw
        - feesGeneratedRaw
        - pfpUrl
        - referredProfileId
        - volumeRaw
  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.

````