Referrals API

​

Overview

The Referrals API allows users to check referral code information and claim new referral codes on the UniDex platform.

​

Request Body

​

Response Fields

​

For getCodeInfo action

​

For claimCode action

​

Example Usage

​

Check Code Information

​

Claim Code

​

Example Responses

​

For getCodeInfo

{
  "code": "MYREFERRALCODE",
  "bytes32Code": "0x4d59524546455252414c434f44450000000000000000000000000000000000",
  "owner": "0x1234567890123456789012345678901234567890",
  "isClaimed": true
}

​

For unclaimed code

{
  "code": "MYREFERRALCODE",
  "bytes32Code": "0x4d59524546455252414c434f44450000000000000000000000000000000000",
  "owner": "Code not claimed",
  "isClaimed": false
}

​

For claimCode

{
  "calldata": "0x4d59524546455252414c434f4445000000000000000000000000000000000000",
  "contractAddress": "0xe3ca135782e4a17aFb31a63ee3b15351C891A1A2",
  "code": "MYREFERRALCODE",
  "bytes32Code": "0x4d59524546455252414c434f44450000000000000000000000000000000000"
}

​

Error Responses

The endpoint will return appropriate error messages for:

• Missing action ({"error": "Missing action"})
• Missing code for getCodeInfo ({"error": "Missing code"})
• Missing code or userAddress for claimCode ({"error": "Missing code or userAddress"})
• Invalid userAddress ({"error": "Invalid userAddress"})
• Already claimed referral code ({"error": "Referral code is already claimed"})