📊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 array of records where each key is a referred user's address. Each entry contains:

Field	Type	Description
volume	number	Total volume generated by the referred user (USD)
earnings	array	Earnings per currency, each with currency (address, chainId) and amount
date_joined	string	When the referred user first converted

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

API reference

Feature	API endpoint	Reference
Payouts by referrer	GET /v1/payouts/by-referrer	View
Referred volume	GET /v1/payouts/leaderboard/referred-volume	View