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

> Earnings totals for one address.

### Endpoint

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

Earnings totals for one address.

### Parameters

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

Two of these field names are misleading. `claimableMicroUsdc` is lifetime gross earnings, and `unpaidMicroUsdc` includes amounts no published batch carries yet. Neither is the claimable amount; use the [claim proof](/developer/api-reference/endpoint/referral-proof).

### Usage Example

```bash theme={null}
curl -X GET "https://backend-global.gains.trade/api/referrals/rewards/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/rewards/{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/rewards/{address}:
    get:
      tags:
        - Referrals
      summary: Referral Rewards
      description: >-
        Earnings totals for one address. Note that `claimableMicroUsdc` is
        lifetime gross earnings and `unpaidMicroUsdc` includes amounts no
        published batch carries yet; neither is the claimable amount.
      operationId: get_referral-rewards
      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/ReferralRewards'
        '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:
    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.
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        success:
          type: boolean
      additionalProperties: true

````