Getting leaderboards and individual earnings using Fuul SDK
This article shows how to get onchain payout rewards - individually or in a leaderboard format
Projects can decide to show a leaderboard or a user profile on their own website.
Leaderboard
To get the affiliate leaderboard for your project use the getPayoutsLeaderboard
method.
currency_address
is the address of the currency on the chain that the project is distributing payouts. Remember projects can payout different tokens for different conversions.
A simple response for retrieving this information would be the following:
You can also filter out this information for a specific user by passing on the user_address,
dates with the from
and to
parameters, and type of users with user_type
.
You can retrieve the tier and the volume information of users by adding them on the fields
parameter as follows:
The referred_volume
parameter will be returned in USD values.
Payouts for a specific address per conversion
To get all payouts for an address use the getUserPayoutsByConversion
method.
You can also filter out dates as follows:
A simple response for retrieving this information would be the following:
You can also get the data directly from the API. Please check out our interactive documentation here
Last updated