🌟Points

Retrieve the points leaderboard using the getPointsLeaderboard method.

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

await Fuul.getPointsLeaderboard({});

Example response:

{
  "total_results": 240,
  "page": 1,
  "page_size": 10,
  "results": [
    {
      "address": "0x1234...",
      "total_amount": 15000,
      "rank": 1,
      "total_attributions": 85
    }
  ]
}
Parameter
Required
Description

fields

No

Extra fields: 'tier,referred_volume,enduser_volume,enduser_revenue'

With extra fields

circle-info

The referred_volume values are returned in USD.

circle-info

Leaderboard responses are paginated. Use page and page_size (max 100 per page) to retrieve the full leaderboard.

For full endpoint details, see the API referencearrow-up-right.

Last updated