Перейти к основному содержимому

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

Возвращает информацию о реферальной программе для текущего аутентифицированного пользователя, включая реферальный код, кто его пригласил, общий доход и статистику по уровням.

Аутентификация

Обязательно. Bearer-токен должен быть включён в заголовок Authorization.

Запрос

Без параметров запроса.

Пример

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

Ответ

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
}
}
}

Поля ответа

ПолеТипОписание
referral_codestringУникальный реферальный код пользователя для распространения
referrerobjectПользователь, который пригласил текущего пользователя (или null)
referrer.namestringОтображаемое имя пригласившего
referrer.image_urlstringURL аватара пригласившего
total_earningsfloat64Общий доход от реферальной программы
total_referralsintОбщее количество приглашённых пользователей на всех уровнях
total_volumefloat64Суммарный торговый объём всех рефералов
total_depositsfloat64Суммарные пополнения всех рефералов
statsobjectРазбивка реферальной статистики по уровням
stats.level1objectСтатистика уровня 1 (прямые рефералы)
stats.level1.countintКоличество рефералов уровня 1
stats.level1.total_volumefloat64Общий торговый объём рефералов уровня 1
stats.level1.earningsfloat64Доход от рефералов уровня 1
stats.level1.feefloat64Комиссионная ставка для уровня 1 (15%)
stats.level2objectСтатистика уровня 2 (та же структура, что и у уровня 1)
stats.level2.feefloat64Комиссионная ставка для уровня 2 (4%)
stats.level3objectСтатистика уровня 3 (та же структура, что и у уровня 1)
stats.level3.feefloat64Комиссионная ставка для уровня 3 (1%)

Ошибки

СтатусКодОписание
401unauthorizedОтсутствует или недействителен токен аутентификации