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

# Get referral summary

> Returns the authenticated user's referral code, referees, reward totals, and the current weekly epoch. Requires SIWE bearer auth.



## OpenAPI

````yaml /api-spec/openapi.yaml get /referral/summary
openapi: 3.0.3
info:
  title: United Market API
  version: 1.0.0
  description: >-
    Public backend API for market data, trading, authentication, profiles,
    comments, and leaderboards.
servers:
  - url: https://api.unitedmarket.ai
    description: United Market backend
security: []
tags:
  - name: Markets
    description: >-
      Market discovery, market details, orderbooks, tickers, price history, and
      trades.
  - name: Orders
    description: Signed order submission, cancellation, order lookup, and balances.
  - name: Authentication
    description: SIWE wallet authentication.
  - name: Discovery
    description: Tags and market groups.
  - name: Social
    description: Comments, users, and leaderboard data.
  - name: Fees
    description: Effective trading fee rate per market.
  - name: Referral
    description: Referral codes, attribution, and reward summaries.
paths:
  /referral/summary:
    get:
      tags:
        - Referral
      summary: Get referral summary
      description: >-
        Returns the authenticated user's referral code, referees, reward totals,
        and the current weekly epoch. Requires SIWE bearer auth.
      operationId: getReferralSummary
      responses:
        '200':
          description: Referral summary returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralSummary'
      security:
        - bearerAuth: []
components:
  schemas:
    ReferralSummary:
      type: object
      additionalProperties: true
      properties:
        code:
          type: string
        rewardBps:
          type: integer
          description: Referrer's share of referees' platform fees, in basis points.
          example: 3000
        refereeCount:
          type: integer
        referees:
          type: array
          items:
            type: object
            properties:
              address:
                type: string
              username:
                type: string
                nullable: true
              referredAt:
                type: string
                format: date-time
                nullable: true
              volumeUsd:
                type: number
              feesUsd:
                type: number
              rewardUsd:
                type: number
        totals:
          type: object
          properties:
            downlineVolumeUsd:
              type: number
            lifetimeRewardUsd:
              type: number
            currentEpochRewardUsd:
              type: number
            paidUsd:
              type: number
            unpaidUsd:
              type: number
        epoch:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SIWE access token returned by POST /auth/verify.

````