Parameters
- typestringREQUIRED
Request type identifier specifying 'referral' as the info endpoint method to retrieve referral program data and affiliate statistics
- userstringREQUIRED
Ethereum-compatible wallet address in 42-character hexadecimal format (0x...) of the account whose referral program data you want to query
Returns
- referredByobject
Information about the user who referred this account, including Ethereum address and referral code.
- referrerstring
Ethereum wallet address of the referrer.
- codestring
Referral code used during signup.
- cumVlmstring
Cumulative volume in USDC associated with this user's referrals.
- unclaimedRewardsstring
Total referral rewards in USDC that have been earned but not yet claimed.
- claimedRewardsstring
Total referral rewards in USDC that have already been claimed.
- builderRewardsstring
Rewards earned for building or contributing to the referral system in USDC.
- referrerStateobject
Current state of the user as a referrer, including stage and detailed referral data.
- stagestring
Current stage of the referrer ('ready', 'inactive', etc.).
- dataobject
Detailed referral data for this referrer.
- codestring
Referral code assigned to this referrer.
- referralStatesarray
Array of objects representing each referred user and their contribution to rewards.
- cumVlmstring
Cumulative volume generated by this referred user.
- cumRewardedFeesSinceReferredstring
Total fees earned since the user was referred.
- cumFeesRewardedToReferrerstring
Total fees rewarded to the referrer for this user.
- timeJoinedinteger
Unix timestamp in milliseconds when this user joined via referral.
- userstring
Ethereum address of the referred user.
- rewardHistoryarray
Array of historical reward events for this user.
- tokenToStatearray
Array mapping collateral token IDs to referral state data.
- tokenIdinteger
ID of the collateral token.
- stateobject
Referral state information for this token.
- cumVlmstring
Cumulative volume associated with this token.
- unclaimedRewardsstring
Unclaimed rewards for this token.
- claimedRewardsstring
Claimed rewards for this token.
- builderRewardsstring
Builder rewards for this token.