# Leaderboards

InviteCount provides leaderboards for both invites and messages, allowing your community to compete and track their rankings.

***

## Viewing Leaderboards

| Command                        | Description                     |
| ------------------------------ | ------------------------------- |
| `/leaderboard invites [page]`  | Top inviters by total invites   |
| `/leaderboard bonus [page]`    | Top inviters by bonus invites   |
| `/leaderboard fakes [page]`    | Top inviters by fake invites    |
| `/leaderboard left [page]`     | Top inviters by left invites    |
| `/leaderboard regular [page]`  | Top inviters by regular invites |
| `/leaderboard messages [page]` | Top members by messages sent    |

Each page displays 10 members. Use the `page` parameter to browse further.

***

## :star2: Pinned Leaderboard

**Premium only.** Create an auto-updating leaderboard embed that refreshes every 15 minutes.

### Create a Pin

```
/leaderboard pin create [channel] [title] [description] [only_members]
```

| Parameter      | Default         | Description                               |
| -------------- | --------------- | ----------------------------------------- |
| `channel`      | Current channel | Channel where the pin will be posted      |
| `title`        | *(default)*     | Custom title for the embed                |
| `description`  | *(default)*     | Custom description for the embed          |
| `only_members` | `false`         | Only show members currently in the server |

### Update a Pin

```
/leaderboard pin update [title] [description] [only_members]
```

Updates the existing pin's settings and refreshes it immediately.

{% hint style="info" %}
The pinned leaderboard displays the **top 10 inviters** and updates automatically every 15 minutes. Only one pin per server is supported.
{% endhint %}

### Pin Embed Customization

The pinned leaderboard embed can be further customized via the [dashboard](https://invite-count.xyz/dashboard):

* Title, description, and color
* Footer text and icon
* Thumbnail and image
* Author name, icon, and URL

{% hint style="warning" %}
If your server loses premium status, the pinned leaderboard will be automatically deleted.
{% endhint %}

***

## Tips

* Use `/delete invites <@member>` to completely remove a member from the leaderboard.
* Use `/reset all invites` to reset everyone's invites to 0 without deleting the data.
* Leaderboards only show members who have data — new members with 0 invites won't appear until they get their first invite.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.invite-count.xyz/features/leaderboards.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
