Referral Dashboard

Returns the referral center summary: the user's code, live rebate rate, commission totals by state and business line, and downline counts. Open to any authenticated wallet.

GET /api/v1/referral/dashboard
Authorization: Bearer <token>

Response

{
  "referral_code": "4DDDC2D4",
  "referral_link": "https://zanbara.app/?ref=4DDDC2D4",
  "my_rebate_rate": "0.10",
  "claimable_commission": "45.00",
  "pending_commission": "12.50",
  "total_commission": "125.50",
  "spot_commission": "40.00",
  "futures_commission": "85.50",
  "direct_traders_count": 8,
  "affiliates_count": 1,
  "last_claimed_at": "2026-04-10T08:15:00Z"
}

Response Fields

Field	Type	Description
referral_code	string | null	User's referral code; null if not created yet
referral_link	string | null	Ready-to-share link containing the code; null if no code
my_rebate_rate	string	Live tier-derived rebate rate as a decimal fraction (e.g., "0.10" = 10%), recomputed at request time
claimable_commission	string	Commission that can be claimed now (chain_sync_status='synced' AND status='pending')
pending_commission	string	Commission accrued but not yet batch-synced on-chain (chain_sync_status='pending')
total_commission	string	Total commission already settled on-chain (chain_sync_status='synced', all statuses)
spot_commission	string	Synced commission from spot trading
futures_commission	string	Synced commission from futures trading
direct_traders_count	int64	Number of directly bound traders (is_affiliate = false)
affiliates_count	int64	Number of downline affiliates (is_affiliate = true)
last_claimed_at	string | null	Finish time of the most recent successful commission claim (ISO 8601); null if never claimed

All amount fields are decimal strings in USDT.

my_rebate_rate is the Starter-floor tier rate: every user is at least Starter (10%); higher tiers require BOTH the referral-count and referred-volume thresholds (see Referral System Overview).

Code Examples

Python

import requests

BASE_URL = "https://api.prex.world/api/v1"
JWT_TOKEN = "your_jwt_token"

resp = requests.get(
    f"{BASE_URL}/referral/dashboard",
    headers={"Authorization": f"Bearer {JWT_TOKEN}"},
)
data = resp.json()

print(f"Code: {data['referral_code']}  Link: {data['referral_link']}")
print(f"Rebate rate: {data['my_rebate_rate']}")
print(f"Claimable: {data['claimable_commission']}, Pending sync: {data['pending_commission']}")
print(f"Total: {data['total_commission']} (spot {data['spot_commission']} / futures {data['futures_commission']})")
print(f"Direct traders: {data['direct_traders_count']}, Affiliates: {data['affiliates_count']}")
print(f"Last claimed: {data['last_claimed_at']}")