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, type of users with user_type and spefific conversions with their ids.
import { Fuul } from ('@fuul/sdk');
await Fuul.getPayoutsLeaderboard({
currency_address: '0x12345',
user_address: '0x12345' ,
from: new Date('2021-01-01'),
to: new Date('2022-01-01'),
user_type: 'all', // all, affiliate or end_user
conversions: '1,2,3'
});
You can retrieve the tier and the volume information of users by adding them on the fields parameter as follows:
import { Fuul } from ('@fuul/sdk');
await Fuul.getUserPayoutsByConversion({
user_address: '0x12345',
from: new Date('2021-01-01'),
to: new Date('2022-01-01'),
});
A simple response for retrieving this information would be the following: