GEgetmytg
Profile

Get user referral information

Changed on

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

get/v1/profile/referral

Request

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

Response

Response for status 200

referral_linkstring uri required

User's referral link

Example response

{
  "referral_info": {
    "referrals_count": 5,
    "profit": {
      "amount": "1.50",
      "currency_code": "USD"
    },
    "balance": {
      "amount": "1.50",
      "currency_code": "USD"
    }
  },
  "current_level": {
    "name": "Bronze",
    "percent": 2.5,
    "progress": {
      "deposits": 250,
      "referrals": 5
    }
  },
  "next_level": {
    "name": "Silver",
    "percent": 5,
    "requirements": {
      "deposits": 100,
      "referrals": 100,
      "remaining_referrals": 95
    }
  },
  "levels": [
    {
      "name": "Bronze",
      "percent": 2.5
    }
  ],
  "referral_link": "https://t.me/your_bot?start=user-123456789"
}

Changes