Referrals

Handler to get referrer statistics. Non-affiliate referrers must meet the minimum trade volume threshold to see their referral codes. Affiliate referrers always see all codes.

get/api/v1/referrals/stats/{account}

Path parameters

accountstring required

The referrer's wallet address (not a subaccount address)

Response

Successfully retrieved referrer stats

codesstring[] required

List of referral codes visible to this referrer. Non-affiliate referrers must meet the volume threshold to see their codes.

is_affiliateboolean required

Whether this referrer has any affiliate-designated codes. Affiliates always see all their codes regardless of trade volume.

referrer_accountstring required

The referrer's wallet address

total_codes_createdinteger required

Total number of referral codes created by this referrer. Always accurate regardless of code visibility (non-affiliates below the volume threshold will see an empty codes array but this still reflects the true count).

total_referralsinteger required

Total number of users referred

volume_threshold_metboolean required

Whether the account meets the minimum trade volume threshold to see non-affiliate referral codes

Changes

No recorded changes to this endpoint across all 1 revision of this API.