Referral

Query Referral Code

get

/info/referral/code

Query parameters

userAddrstringRequired

Responses

200

Referral code info

No content

get/info/referral/code

const resp = await fetch(`${BASE_URL}/info/referral/code?userAddr=0xabc...`);

200

Referral code info

No content

Query Referral Summary

get

/info/referral/summary

Query parameters

userAddrstringRequired

periodstringOptionalDefault: all

startTimeinteger · int64Optional

endTimeinteger · int64Optional

Responses

200

Referral summary statistics

No content

get/info/referral/summary

const resp = await fetch(
  `${BASE_URL}/info/referral/summary?userAddr=0xabc...&period=all`
);

200

Referral summary statistics

No content

Query Referral List

get

/info/referral/referrals

Query parameters

userAddrstringRequired

pageintegerOptionalDefault: 1

sizeintegerOptionalDefault: 10

sortBystringOptionalDefault: dateJoined

sortOrderstringOptionalDefault: desc

searchstringOptional

Responses

200

Paginated referral list

No content

get/info/referral/referrals

const resp = await fetch(
  `${BASE_URL}/info/referral/referrals?userAddr=0xabc...&page=1&size=10`
);

200

Paginated referral list

No content

Query Referral Payouts

get

/info/referral/payouts

Query parameters

userAddrstringRequired

pageintegerOptionalDefault: 1

sizeintegerOptionalDefault: 10

Responses

200

Paginated payout list

No content

get/info/referral/payouts

const resp = await fetch(
  `${BASE_URL}/info/referral/payouts?userAddr=0xabc...`
);

200

Paginated payout list

No content

Query Referral Tiers

get

/info/referral/tiers

Returns referral tier configuration (no parameters).

Responses

200

Tier config list

No content

get/info/referral/tiers

const resp = await fetch(`${BASE_URL}/info/referral/tiers`);

200

Tier config list

No content