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

# Referral earnings

> Commission from members you referred, funded from the taker fee they pay on fills. Lifetime totals by currency, split into what is still waiting for the daily payout (`pending_by_currency`) and what has already been paid to your wallet (`paid_by_currency`); the same per referred member; the payout history, one entry per payout sweep; when the next payout is due; and how often the sweep runs.



## OpenAPI

````yaml /api-reference/openapi/calibri.yaml get /api/v2/atlas/account/referrals/earnings
openapi: 3.1.0
info:
  title: Calibri API
  version: 1.0.0
  description: >-
    The Calibri API. Discover markets, read live books, place signed orders, and
    manage positions and account data.

    Routed by path prefix to the service that answers it — which is an
    implementation detail, not something a caller has to reason about.
servers:
  - description: Production
    url: https://calibri.io
security: []
tags:
  - name: Health
    description: Service liveness.
    x-displayName: Health
  - name: Events
    description: Discover events and their metadata.
    x-displayName: Events
  - name: Markets
    description: List markets and load market detail for trading.
    x-displayName: Markets
  - name: Series
    description: Recurring event series.
    x-displayName: Series
  - name: Tags
    description: Editorial shelves used to browse the catalogue.
    x-displayName: Tags
  - name: Market Data
    description: Order book, depth, trade tape, tickers, and candles.
    x-displayName: Market Data
  - name: Assets
    description: Underlying asset price history for price-feed markets.
    x-displayName: Assets
  - name: Community
    description: Leaderboard and platform activity.
    x-displayName: Community
  - name: Currencies
    description: Currency registry.
    x-displayName: Currencies
  - name: Trade
    description: Place, list, and cancel orders.
    x-displayName: Trade
  - name: Positions
    description: Your matched contracts.
    x-displayName: Positions
  - name: Wallet
    description: Self-custody Safe, passkey, session keys, and relay.
    x-displayName: Wallet
  - name: Rewards
    description: Maker rebates and referral earnings.
    x-displayName: Rewards
  - name: Account
    description: Balances, ledger, PnL, limits, preferences, and profile.
    x-displayName: Account
  - name: Categories
    description: Categories
    x-displayName: Categories
  - name: Other
    description: Other
    x-displayName: Other
externalDocs:
  description: ''
  url: ''
paths:
  /api/v2/atlas/account/referrals/earnings:
    get:
      tags:
        - Rewards
      summary: Referral earnings
      description: >-
        Commission from members you referred, funded from the taker fee they pay
        on fills. Lifetime totals by currency, split into what is still waiting
        for the daily payout (`pending_by_currency`) and what has already been
        paid to your wallet (`paid_by_currency`); the same per referred member;
        the payout history, one entry per payout sweep; when the next payout is
        due; and how often the sweep runs.
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralEarningsEntity'
          description: ''
      security:
        - apiKey: []
components:
  schemas:
    ReferralEarningsEntity:
      properties:
        by_referred:
          description: The same, broken down per referred member.
          items:
            $ref: '#/components/schemas/ReferredMemberEntity'
          type: array
        total_earned_by_currency:
          additionalProperties:
            type: string
          description: Total earned, keyed by currency.
          example:
            usdc: '12.50'
          type: object
      required:
        - total_earned_by_currency
        - by_referred
      type: object
    ReferredMemberEntity:
      properties:
        earned_by_currency:
          additionalProperties:
            type: string
          description: What this referred member has earned you, keyed by currency.
          example:
            usdc: '5.00'
          type: object
        last_trade_at:
          description: When they last traded. ISO-8601.
          example: '2026-08-06T18:22:00Z'
          type:
            - string
            - 'null'
        member_id:
          description: >-
            The referred member. An internal id, not a UID — it identifies the
            row, and is not a handle you can look anyone up by.
          example: 42
          type: number
      required:
        - member_id
        - earned_by_currency
      type: object
  securitySchemes:
    apiKey:
      description: >-
        HMAC-signed API key. Send X-Auth-Apikey, X-Auth-Nonce and
        X-Auth-Signature.
      in: header
      name: X-Auth-Apikey
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.