Referral API

Endpoints for the referral program.

Endpoints

Get Referral Code

GET /referral/code

Retrieve the user's unique referral code.

Query Parameters:

Parameter	Type	Required	Description
walletAddress	string	Yes	User wallet address

Response:

{
  "referralCode": "ABC123XYZ",
  "walletAddress": "0x..."
}

---

Apply Referral Code

POST /referral/apply

Apply a referral code to a new wallet.

Request Body:

Field	Type	Required	Description
walletAddress	string	Yes	New user's wallet address
referralCode	string	Yes	Referral code to apply

---

Skip Referral

POST /referral/skip

Skip the referral code step for a new wallet.

Request Body:

Field	Type	Required	Description
walletAddress	string	Yes	New user's wallet address

---

Get User Referrals

GET /referral/referrals

Retrieve a list of all referrals made by a user.

Query Parameters:

Parameter	Type	Required	Description
walletAddress	string	Yes	Referrer's wallet address

Response:

{
  "referrals": [
    {
      "referredAddress": "0x...",
      "status": "active",
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "totalCount": 5,
  "rewardStatus": {
    "referralsCount": 5,
    "rewardsClaimed": {}
  }
}