🌟Points

This article shows how to get point 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 points leaderboard for your project use the getPointsLeaderboard method.

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

await Fuul.getPointsLeaderboard();

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,
      "rank": 1,
      "total_attributions": 10
      
    },
    {
      "address": "0xg9BAdD58B65B54D1a5c216d9c730fbd57c182d56",
      "total_amount": 200,
      "rank": 2,
      "total_attributions": 10
    }
  ]
}

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.getPointsLeaderboard(fields: 'tier,referred_volume');

The referred_volume parameter will be returned in USD values.