🌟Points

This article shows how to get point individual rewards

Projects can decide to show a leaderboard or a user profile on their own website.

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

Points for a specific address

To get the points rewards for your project use the getPointsLeaderboard method filtered by user address.

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

await Fuul.({ user_address: '0x12345' });
await Fuul.getPointsLeaderboard({ 
    user_address: '0x12345' ,
    from: new Date('2021-01-01'), // Optional
    to: new Date('2022-01-01'), // Optional
    user_type: 'all', // all, affiliate or end_user
    conversions: '1,2,3' // Optional
});

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
      
    }
  ]
}

Points for a specific address per conversion

To get all points for an address by conversion use the getUserPointsByConversion method.

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

await Fuul.getUserPointsByConversion({ user_address: '0x12345' });

You can also filter out dates as follows:

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

await Fuul.getUserPointsByConversion({
      user_address: '0x12345',
      from: new Date('2021-01-01'),
      to: new Date('2022-01-01'),
});

A simple response for retrieving this information would be the following:

{
  "total_results": 100,
  "page": 1,
  "page_size": 10,
  "results": [
    {
      "is_referrer": true,
      "conversion_id": "4bdabf2c-271a-4d66-afd0-a9f24119810a",
      "conversion_name": "Buy",
      "total_amount": 200
    },
    {
      "is_referrer": false,
      "conversion_id": "4bdabf2c-271a-4d66-afd0-a9f24119810a",
      "conversion_name": "Buy",
      "total_amount": 400
    }
  ]
}

Points history for a specific address

To get all points history for an address use the getUserPointsMovements method.

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

await Fuul.getUserPointsMovements({
      user_address: '0x12345',
      from: new Date('2021-01-01'), // optional
      to: new Date('2022-01-01'), // optional
});

A simple response for retrieving this information would be the following:

{
  "total_results": 100,
  "page": 1,
  "page_size": 10,
  "results": [
    {
        "payout_id": null,
        "project_name": "project 1",
        "date": "2025-04-08T14:34:32.913Z",
        "is_referrer": false,
        "conversion_id": "bb569548-52d9-46c5-9137-2787c8310de7",
        "conversion_name": "conversion name",
        "total_amount": "123",
        "payout_status": "confirmed",
        "payout_status_details": null
    }
  ]
}