> For the complete documentation index, see [llms.txt](https://docs.xandtech.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xandtech.fr/home/xplayercurrencies/features/leaderboard.md).

# Leaderboard

Ranks the top wallet balances for one currency.

```yaml
leaderboard-enabled: true
leaderboard-size: 10
menu-size: 54
menu-border-material: BLACK_STAINED_GLASS_PANE
```

| Key                    | Description                                                                                                                                                                                                                                                                                                                        |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `leaderboard-enabled`  | Master toggle for this currency's leaderboard menu.                                                                                                                                                                                                                                                                                |
| `leaderboard-size`     | How many players to rank. On `YAML` storage specifically, building the leaderboard means scanning every player data file, which gets slow with many thousands of players - `SQLITE`/`MYSQL` query this instantly instead (see [Installation](/home/xplayercurrencies/getting-started/installation.md#choosing-a-storage-backend)). |
| `menu-size`            | Total inventory size for this currency's leaderboard **and** transaction-logs menus - must be a multiple of 9 between 27 and 54 (3-6 rows); anything else is rounded to the nearest valid size.                                                                                                                                    |
| `menu-border-material` | The glass (or any `Material`) framing those menus. Minecraft glass panes only come in 16 fixed colors: `BLACK`/`WHITE`/`RED`/`ORANGE`/`YELLOW`/`LIME`/`GREEN`/`CYAN`/`LIGHT_BLUE`/`BLUE`/`PURPLE`/`MAGENTA`/`PINK`/`BROWN`/`GRAY`/`LIGHT_GRAY`, each as `<COLOR>_STAINED_GLASS_PANE`.                                              |

## Commands

```
/currencies top <currency>
/coins top          (or /coins leaderboard, if "command" is set)
```

Requires `xplayercurrencies.balance.self` (default: `true`).

## Bypass

A player with `xplayercurrencies.leaderboard.bypass` (default: `op`) is hidden from every currency's leaderboard regardless of balance - typically granted to staff/admins whose balance isn't representative. Only reliably applied while that player is online when the leaderboard is generated.

## Bank leaderboard

The [bank](/home/xplayercurrencies/features/bank.md) balance is separate storage and has its own ranking, exposed via the `bank_rank` [PlaceholderAPI](/home/xplayercurrencies/integrations/placeholderapi.md) placeholder and shown inside the bank menu itself.

Next: [Fraud Detection](/home/xplayercurrencies/features/fraud-detection.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.xandtech.fr/home/xplayercurrencies/features/leaderboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.