Skip to main content

Referral Dashboard

Aggregated earnings, tier and recent activity for the current referrer.

GET /referral/dashboard

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

Response (tier reached)

{
"code": "4DDDC2D4",
"total_referrals": 8,
"active_referrals": 3,
"total_earnings": "125.50",
"pending_earnings": "45.00",
"claimed_earnings": "80.50",
"total_referred_volume": "52000.00",
"tier": {
"level": 1,
"name": "Bronze",
"commission_rate": "0.12",
"rate_bps": 1200,
"next_tier_referrals": 20,
"next_tier_volume": "100000.00"
},
"recent_activity": [
{ "referral_address": "0xabc...", "event_type": "trade", "volume": "10000.00", "commission": "1.50", "timestamp": 1771900000000 }
],
"bound_referral": null
}

Response (below Starter threshold)

{
"code": "4DDDC2D4",
"total_referrals": 0,
"active_referrals": 0,
"total_earnings": "0",
"pending_earnings": "0",
"claimed_earnings": "0",
"total_referred_volume": "0",
"tier": null,
"tier_note": "Minimum rebate threshold not reached: ≥1 referee and ≥ $1,000 cumulative referee volume required",
"recent_activity": [],
"bound_referral": null
}
FieldTypeDescription
codestring | nullOwn referral code
total_referralsintBound referees
active_referralsintReferees that traded in the last 30 days
total_earnings / pending_earnings / claimed_earningsstringUSDT; claimed = total − pending
total_referred_volumestringCumulative USD volume of all referees
tierobject | nullCurrent tier; null below Starter
tier.next_tier_referrals / tier.next_tier_volumeint / string | nullRequirements for the next tier; null at Diamond
tier_notestringOnly present when tier is null
recent_activityarrayLast 20 commission events
bound_referralobject | nullYour own upstream referrer, if bound

Tier thresholds are listed on the overview.