πŸ’―Leaderboard Data

Retrieve and display leaderboard rankings for your incentive programs. Fuul provides three leaderboard types:

Leaderboard
SDK method
What it ranks

getPayoutsLeaderboard

Onchain token rewards earned

getPointsLeaderboard

Point rewards earned

getVolumeLeaderboard

Trading/transaction volume generated

circle-info

Leaderboard data is updated hourly. Recent conversions and payouts will appear within a maximum of one hour.

Common parameters

All leaderboard methods support these filters:

Parameter
Type
Supported by
Description

user_identifier

string

All

Filter to a specific user (for individual rewards)

identifier_type

string

All

'evm_address', 'solana_address', 'xrpl_address'

user_type

string

Payouts, Volume

'affiliate' or 'end_user' (omit for all)

fields

string

Payouts, Points

Comma-separated extra fields: 'tier,referred_volume,enduser_volume,enduser_revenue,referred_users'

conversion_external_ids

number[]

Payouts

Array of conversion IDs to filter by

circle-info

The leaderboard response returns only the top 100 users.

Last updated