🔈Volume

Retrieve the volume leaderboard using the getVolumeLeaderboard method. This shows transaction volume generated by users.

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

await Fuul.getVolumeLeaderboard({
  user_type: 'affiliate',
});

user_type is optional. Use 'affiliate' for referred volume or 'end_user' for direct user volume.

Example response:

{
  "total_results": 89,
  "page": 1,
  "page_size": 10,
  "results": [
    {
      "address": "0x1234...",
      "total_amount": "1250000.00",
      "rank": 1
    }
  ]
}

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.