Skip to main content
Referral and reward endpoints provide access to referral information, referral code management, XP rewards, weekly summaries, and reward history. These endpoints require authentication using either a JWT bearer token or API Key authentication. See the Authentication guide for details.

Referral Summary

Retrieve the authenticated user’s referral information.

REST

TypeScript SDK

The response includes:
  • referral_code
  • referrer_code
  • referrer_user_id
  • downline_count
Example response:

Bind a Referrer

Associate the authenticated user with a referral code.

REST

TypeScript SDK

The response returns the updated referral summary.
A referral can typically only be bound once. Refer to the platform rules for the current referral policy.

Rewards Summary

Retrieve the user’s XP balance, weekly statistics, and reward history.

REST

TypeScript SDK

Or with optional query parameters:
The response includes:
  • xp_balance
  • current_week
  • history
  • ledger
Example response:
Refer to the API Reference for the complete RewardSummaryResponse schema.