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

# Referral Summary

> Dashboard composite for one address.

### Endpoint

`GET /api/referrals/summary/{address}`

Dashboard composite for one address.

### Parameters

| Parameter | Location | Required | Type   | Description  |
| --------- | -------- | -------- | ------ | ------------ |
| `address` | path     | Yes      | string | EVM address. |

`vip` is `null` when no tier snapshot exists. `effectiveRate` reports the standard programme rate; a negotiated partner rate is applied to earnings but is not reflected in this field.

### Usage Example

```bash theme={null}
curl -X GET "https://backend-global.gains.trade/api/referrals/summary/0x1111111111111111111111111111111111111111"
```

### Response Structure

The generated API panel lists the response schema for status codes: 200, 400, 500. Error responses return an `error` field.


## OpenAPI

````yaml get /api/referrals/summary/{address}
openapi: 3.0.3
info:
  title: Gains Network Backend API
  version: 1.0.0
  description: >-
    OpenAPI reference for Gains Network backend-global and public chain-specific
    trading backend endpoints.
servers:
  - url: https://backend-global.gains.trade
    description: Backend Global API
  - url: https://backend-arbitrum.gains.trade
    description: Arbitrum trading backend
  - url: https://backend-base.gains.trade
    description: Base trading backend
  - url: https://backend-polygon.gains.trade
    description: Polygon trading backend
  - url: https://backend-sepolia.gains.trade
    description: Arbitrum Sepolia trading backend
  - url: http://localhost:3002
    description: Local backend-global development server
security: []
tags:
  - name: Health
  - name: Stats
  - name: APR
  - name: Trading History
  - name: Personal Trading History
  - name: Leaderboard
  - name: Holding Rates
  - name: Contests
  - name: Dapp
  - name: Wallet
  - name: Circle
  - name: Solana
  - name: Transak
  - name: Bridge
  - name: Campaigns
  - name: VIP
  - name: Notifications
  - name: Referrals
  - name: Trading Backend
  - name: Legacy Contests
  - name: Rewards
paths:
  /api/referrals/summary/{address}:
    get:
      tags:
        - Referrals
      summary: Referral Summary
      description: >-
        Dashboard composite for one address; code, referral counts, rewards,
        effective rate and VIP tier. `vip` is null when no tier snapshot exists.
      operationId: get_referral-summary
      parameters:
        - name: address
          in: path
          required: true
          schema:
            type: string
          description: EVM address.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/ReferralSummary'
        '400':
          description: Invalid address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ReferralSummary:
      type: object
      properties:
        account:
          type: string
        code:
          type: string
          nullable: true
        referralsCount:
          type: object
          properties:
            l1:
              type: integer
            l2:
              type: integer
        rewards:
          $ref: '#/components/schemas/ReferralRewards'
        effectiveRate:
          type: object
          description: >-
            Standard programme rate. Negotiated partner rates are applied to
            earnings but not reflected here.
          properties:
            l1RateBps:
              type: integer
            l2RateBps:
              type: integer
        vip:
          type: object
          nullable: true
          properties:
            tier:
              type: integer
            cashbackBps:
              type: integer
            stakedGns:
              type: string
            volume30dUsd:
              type: string
            stakeTier:
              type: integer
            volumeTier:
              type: integer
            next:
              type: object
              nullable: true
              properties:
                tier:
                  type: integer
                stakedGns:
                  type: string
                volumeUsd:
                  type: string
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        success:
          type: boolean
      additionalProperties: true
    ReferralRewards:
      type: object
      properties:
        account:
          type: string
        lifetimeUsd:
          type: string
          description: Decimal USD. Same quantity as claimableMicroUsdc, different unit.
        l1Usd:
          type: string
          description: Decimal USD.
        l2Usd:
          type: string
          description: Decimal USD.
        cashbackUsd:
          type: string
          description: Decimal USD. Zero while cashback is inactive.
        claimableMicroUsdc:
          type: string
          description: >-
            Micro-USDC integer. Lifetime gross earnings, NOT the claimable
            amount.
        settledMicroUsdc:
          type: string
          description: Micro-USDC integer. Already claimed on-chain, from indexed events.
        unpaidMicroUsdc:
          type: string
          description: >-
            Micro-USDC integer. Lifetime minus settled; includes amounts not yet
            in a published batch.

````