Skip to main content

referral Info Endpoint Method

Retrieves referral program data, including referral codes, total referred users, accumulated rewards, and referee lists.

Updated on
Jun 15, 2026

Parameters

type
string
REQUIRED

Request type identifier specifying 'referral' as the info endpoint method to retrieve referral program data and affiliate statistics

user
string
REQUIRED

Ethereum-compatible wallet address in 42-character hexadecimal format (0x...) of the account whose referral program data you want to query

Returns

referredBy
object

Information about the user who referred this account, including Ethereum address and referral code.

referrer
string

Ethereum wallet address of the referrer.

code
string

Referral code used during signup.

cumVlm
string

Cumulative volume in USDC associated with this user's referrals.

unclaimedRewards
string

Total referral rewards in USDC that have been earned but not yet claimed.

claimedRewards
string

Total referral rewards in USDC that have already been claimed.

builderRewards
string

Rewards earned for building or contributing to the referral system in USDC.

referrerState
object

Current state of the user as a referrer, including stage and detailed referral data.

stage
string

Current stage of the referrer ('ready', 'inactive', etc.).

data
object

Detailed referral data for this referrer.

code
string

Referral code assigned to this referrer.

referralStates
array

Array of objects representing each referred user and their contribution to rewards.

cumVlm
string

Cumulative volume generated by this referred user.

cumRewardedFeesSinceReferred
string

Total fees earned since the user was referred.

cumFeesRewardedToReferrer
string

Total fees rewarded to the referrer for this user.

timeJoined
integer

Unix timestamp in milliseconds when this user joined via referral.

user
string

Ethereum address of the referred user.

rewardHistory
array

Array of historical reward events for this user.

tokenToState
array

Array mapping collateral token IDs to referral state data.

tokenId
integer

ID of the collateral token.

state
object

Referral state information for this token.

cumVlm
string

Cumulative volume associated with this token.

unclaimedRewards
string

Unclaimed rewards for this token.

claimedRewards
string

Claimed rewards for this token.

builderRewards
string

Builder rewards for this token.

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free