🌟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'
user_identifier	No	Filter to a specific user's row
identifier_type	No	Identifier type for the user_identifier filter
page	No	Page number (default 1)
page_size	No	Results per page (max 100)

The points leaderboard takes no other filters. user_type, currency_address, from, to, and conversion_external_ids are not supported — they were removed from GetPointsLeaderboardParams and ranking always covers the whole program. Use getPayoutsLeaderboard if you need to rank by currency or by conversion.

With extra fields

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

await Fuul.getPointsLeaderboard({
  fields: 'tier,referred_volume,enduser_volume,enduser_revenue',
});

The referred_volume values are returned in USD.

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 reference.