GET /api/v1/users/me/referral/info

Returns referral program information for the currently authenticated user, including their referral code, who referred them, total earnings, and per-level statistics.

Authentication

Required. Bearer token must be included in the Authorization header.

Request

No request body or query parameters required.

Example

curl -X GET https://intotes.com/api/v1/users/me/referral/info \
  -H "Authorization: Bearer <token>"

Response

200 OK

{
  "referral_code": "ABC123XY",
  "referrer": {
    "name": "Bob",
    "image_url": "https://cdn.intotes.com/avatars/10.jpg"
  },
  "total_earnings": 34250,
  "total_referrals": 25,
  "total_volume": 15600000,
  "total_deposits": 4800000,
  "stats": {
    "level1": {
      "count": 10,
      "total_volume": 9500000,
      "earnings": 28500,
      "fee": 0.15
    },
    "level2": {
      "count": 9,
      "total_volume": 4200000,
      "earnings": 4620,
      "fee": 0.04
    },
    "level3": {
      "count": 6,
      "total_volume": 1900000,
      "earnings": 1130,
      "fee": 0.01
    }
  }
}

Response Fields

Field	Type	Description
referral_code	string	The user's unique referral code to share
referrer	object	The user who referred the current user (or null)
referrer.name	string	Referrer's display name
referrer.image_url	string	Referrer's avatar URL
total_earnings	int64	Total earnings from the referral program in kopecks
total_referrals	int64	Total number of referred users across all levels
total_volume	int64	Combined trading volume of all referrals in kopecks
total_deposits	int64	Combined deposit amount of all referrals in kopecks
stats	object	Breakdown of referral stats by level
stats.level1	object	Level 1 (direct referrals) statistics
stats.level1.count	int64	Number of level 1 referrals
stats.level1.total_volume	int64	Total trading volume of level 1 referrals in kopecks
stats.level1.earnings	int64	Earnings from level 1 referrals in kopecks
stats.level1.fee	float64	Commission rate for level 1 (15%)
stats.level2	object	Level 2 statistics (same structure as level 1)
stats.level2.fee	float64	Commission rate for level 2 (4%)
stats.level3	object	Level 3 statistics (same structure as level 1)
stats.level3.fee	float64	Commission rate for level 3 (1%)

Errors

Status	Code	Description
401	unauthorized	Missing or invalid authentication token