---
title: "Referral Summary"
method: GET
path: "/api/referrals/summary/{address}"
tags: ["Referrals"]
---

# Referral Summary

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

## Request

- Base URL: `https://backend-global.gains.trade`
- URL: `https://backend-global.gains.trade/api/referrals/summary/{address}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gains/apis/gains-network-backend-api/docs/api/referrals/summary/:address/get.ts> (a function with typed inputs; its response is checked against the schema)

Dashboard composite for one address; code, referral counts, rewards, effective rate and VIP tier. `vip` is null when no tier snapshot exists.

## Path parameters

- `address` string, required

## Response `200`

Successful response

- object
  - `result` ReferralSummary
    - `account` string
    - `code` string, nullable
    - `referralsCount` object
      - `l1` integer
      - `l2` integer
    - `rewards` ReferralRewards
      - `account` string
      - `lifetimeUsd` string: Decimal USD. Same quantity as claimableMicroUsdc, different unit.
      - `l1Usd` string: Decimal USD.
      - `l2Usd` string: Decimal USD.
      - `cashbackUsd` string: Decimal USD. Zero while cashback is inactive.
      - `claimableMicroUsdc` string: Micro-USDC integer. Lifetime gross earnings, NOT the claimable amount.
      - `settledMicroUsdc` string: Micro-USDC integer. Already claimed on-chain, from indexed events.
      - `unpaidMicroUsdc` string: Micro-USDC integer. Lifetime minus settled; includes amounts not yet in a published batch.
    - `effectiveRate` object: Standard programme rate. Negotiated partner rates are applied to earnings but not reflected here.
      - `l1RateBps` integer
      - `l2RateBps` integer
    - `vip` object, nullable
      - `tier` integer
      - `cashbackBps` integer
      - `stakedGns` string
      - `volume30dUsd` string
      - `stakeTier` integer
      - `volumeTier` integer
      - `next` object, nullable
        - `tier` integer
        - `stakedGns` string
        - `volumeUsd` string

## Other responses

- `400`: Invalid address
- `500`: Internal server error

## Changes

- **2026-11-03** `4b415b6ff9d6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gains/apis/gains-network-backend-api/changes/api/referrals/summary/:address/get.md)

---

[API](https://skmtc.dev/gains/apis/gains-network-backend-api.md) - [All operations](https://skmtc.dev/gains/apis/gains-network-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gains/apis/gains-network-backend-api/revisions/4b415b6ff9d6?raw)