📊Referred Metrics

Retrieve referral performance data — which users were referred by an affiliate, how much volume they generated, and how much the referrer earned.

Referred users for a specific affiliate

Use getPayoutsByReferrer to get payout and volume information for each user referred by a specific affiliate:

import { Fuul } from '@fuul/sdk';

const results = await Fuul.getPayoutsByReferrer({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address',
});

The response is an object where each key is a referred user and each value contains:

Field	Description
Volume	Total volume generated by the referred user
Earnings	Total earnings attributed to the referrer from this user

Referred volume for a set of users

Use getReferredVolume to retrieve the referred volume for multiple users at once:

import { Fuul } from '@fuul/sdk';

const results = await Fuul.getReferredVolume({
  user_identifiers: ['0x1234...', '0x5678...'],
  identifier_type: 'evm_address',
});

Referred volume leaderboard

To get the full referred volume leaderboard, use the volume leaderboard with user_type = 'affiliate':

🔈Volume