🪙Tokens

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 data is not updated in real time due to performance considerations. Recent conversions and payouts will appear on the leaderboard within a maximum of one hour.

To get the affiliate leaderboard for your project use the getPayoutsLeaderboard method.

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

await Fuul.getPayoutsLeaderboard({ currency_address: '0x12345' });

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:

{
  "total_results": 100,
  "page": 1,
  "page_size": 10,
  "results": [
    {
      "address": "0xBfBAdD58B65B54D1a5cEa6d9c730fbd57c182d32",
      "total_amount": 200, // Already formatted with the corresponding decimals
      "rank": 1,
      "total_attributions": 10
    },
    {
      "address": "0xg9BAdD58B65B54D1a5c216d9c730fbd57c182d56",
      "total_amount": 170,  // Already formatted with the corresponding decimals
      "rank": 2,
      "total_attributions": 9
    }
  ]
}

The leaderboard response will always return only the top 100 users

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.getPayoutsLeaderboard({ 
    currency_address: '0x12345',
    fields: 'tier,referred_volume,referred_users'
});

The referred_volume parameter will be returned in USD values.