Skip to main content

Referral Status

Both sides of the current user's referral state: as a referrer (own code, referees) and as a referee (bound code).

GET /referral/status

Auth: Authorization: Bearer <JWT> from the EIP-712 login. API keys are not accepted.

Response

{
"as_referrer": {
"has_code": true,
"code": "4DDDC2D4",
"code_created_at": 1772010604000,
"total_referrals": 3,
"referees": [
{ "address": "0xabc...", "bound_at": 1770000000000 }
]
},
"as_referee": {
"is_bound": false,
"referrer_address": null,
"referrer_code": null,
"bound_at": null
}
}
FieldTypeDescription
as_referrer.has_codeboolWhether a code exists
as_referrer.codestring | null8-char uppercase hex code
as_referrer.code_created_atint64 | nullms
as_referrer.total_referralsintReferees currently bound
as_referrer.refereesarrayMost recent 50 referees
as_referee.is_boundboolBound to someone's code
as_referee.referrer_address / referrer_codestring | null
as_referee.bound_atint64 | nullms