> For the complete documentation index, see [llms.txt](https://docs.fuul.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fuul.xyz/developer-guide/getting-leaderboard-data/points.md).

# Points

Retrieve the points leaderboard using the `getPointsLeaderboard` method.

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

await Fuul.getPointsLeaderboard({});
```

Example response:

```json
{
  "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_type`       | No       | `'affiliate'` or `'end_user'` to filter by user type                  |
| `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)                                            |

### With extra fields

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

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

{% hint style="info" %}
The `referred_volume` values are returned in USD.
{% endhint %}

{% hint style="info" %}
Leaderboard responses are paginated. Use `page` and `page_size` (max 100 per page) to retrieve the full leaderboard.
{% endhint %}

For full endpoint details, see the [API reference](https://fuul.readme.io/reference/getpointsleaderboard).