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

# Referral Rewards

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

## Request

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

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.

## Path parameters

- `address` string, required

## Response `200`

Successful response

- object
  - `result` 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.

## 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/rewards/: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)