---
title: "Get user referral information"
method: GET
path: "/v1/profile/referral"
tags: ["Profile"]
---

# Get user referral information

`GET /v1/profile/referral`

## Request

- Base URL: `https://api.getmytg.com`
- URL: `https://api.getmytg.com/v1/profile/referral`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns user's referral program status, including current level, commission percentage, referral count, and earnings.

## Response `200`

Response for status 200

- object
  - `referral_info` object, required
    - `referrals_count` integer, required: Total number of referrals
    - `profit` object, required: Total lifetime referral earnings
      - `amount` string, required: Monetary amount as a string with up to 2 decimal places.
      - `currency_code` string, required: ISO 4217 currency code.
    - `balance` object, required: Current referral balance
      - `amount` string, required: Monetary amount as a string with up to 2 decimal places.
      - `currency_code` string, required: ISO 4217 currency code.
  - `current_level` object, required
    - `name` 'bronze' | 'silver' | 'gold' | 'platinum', required: Name of the current referral level
    - `percent` number, required: Commission percentage
    - `progress` object, required
      - `deposits` number, required: Total deposits from referrals (in USD)
      - `referrals` integer, required: Number of active referrals
  - `next_level` object, nullable, required: Next level information. Null if already at max level
    - `name` 'bronze' | 'silver' | 'gold' | 'platinum', required: Name of the next referral level
    - `percent` number, required: Commission percentage for the next level
    - `requirements` object, required
      - `deposits` number, required: Required total deposits from referrals
      - `referrals` integer, required: Required number of referrals
      - `remaining_deposits` number, required: Remaining deposits to reach the next level
      - `remaining_referrals` integer, required: Remaining referrals to reach the next level
  - `levels` object[], required: All available referral levels
    - `name` 'bronze' | 'silver' | 'gold' | 'platinum', required: Name of the referral level
    - `percent` number, required: Commission percentage
    - `required_deposits` number, required: Required deposits to reach this level
    - `required_referrals` integer, required: Required referrals to reach this level
  - `referral_link` string, uri, required: User's referral link

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `404`: Response for status 404
- `429`: Response for status 429
- `500`: Internal server error

## Changes

- **2026-11-03** `aa3ff24cbee2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getmytg/apis/get-my-tg-api/changes/v1/profile/referral/get.md)

---

[API](https://skmtc.dev/getmytg/apis/get-my-tg-api.md) - [All operations](https://skmtc.dev/getmytg/apis/get-my-tg-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getmytg/apis/get-my-tg-api/revisions/aa3ff24cbee2?raw)