> 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/integrations/placeholderapi.md).

# PlaceholderAPI

When [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is installed, XPlayerCurrencies registers the `xplayercurrencies` identifier - every placeholder below is `%xplayercurrencies_<...>%`.

All per-currency placeholders follow `%xplayercurrencies_<currency id>_<field>%`, e.g. `%xplayercurrencies_coins_balance%`. Every "online player" field returns an empty string for an offline player.

## General

| Placeholder                   | Description           |
| ----------------------------- | --------------------- |
| `%xplayercurrencies_version%` | The plugin's version. |

## Per-currency

| Placeholder                                  | Description                                      |
| -------------------------------------------- | ------------------------------------------------ |
| `%xplayercurrencies_<id>_name%`              | `name-display`.                                  |
| `%xplayercurrencies_<id>_name_plural%`       | `name-display-plural`.                           |
| `%xplayercurrencies_<id>_icon%`              | `icon-display`.                                  |
| `%xplayercurrencies_<id>_symbol%`            | `symbol`.                                        |
| `%xplayercurrencies_<id>_balance%`           | Raw balance number (online player only).         |
| `%xplayercurrencies_<id>_balance_formatted%` | Balance with symbol/thousands-separator applied. |
| `%xplayercurrencies_<id>_shop_enabled%`      | `true`/`false`.                                  |
| `%xplayercurrencies_<id>_shop_count%`        | How many shops this currency has.                |
| `%xplayercurrencies_<id>_bank_enabled%`      | `true`/`false`.                                  |

## Bank - `%xplayercurrencies_<id>_bank_<field>%`

| Field               | Needs the player online? | Description                                                             |
| ------------------- | ------------------------ | ----------------------------------------------------------------------- |
| `next_interest`     | No                       | Time until the next interest payout (e.g. `45m 12s`, `2h 3m`, `1d 4h`). |
| `rank`              | No                       | Bank-leaderboard rank (blank if unranked).                              |
| `balance`           | Yes                      | Raw bank balance.                                                       |
| `balance_formatted` | Yes                      | Formatted bank balance.                                                 |
| `tier`              | Yes                      | Current tier level (`0` = base).                                        |
| `tier_name`         | Yes                      | Current tier's name (`Base` at level 0).                                |
| `interest_rate`     | Yes                      | Current interest rate %.                                                |
| `max_balance`       | Yes                      | Current tier's cap.                                                     |
| `is_max_tier`       | Yes                      | `true`/`false`.                                                         |
| `next_tier_name`    | Yes                      | Name of the next tier (blank at max).                                   |
| `next_tier_cost`    | Yes                      | Upgrade cost of the next tier (blank at max).                           |
| `projected_24h`     | Yes                      | Projected bank balance 24 hours from now, at the current rate.          |
| `notify_disabled`   | Yes                      | Whether this player disabled the interest-received notification.        |

## Shop - `%xplayercurrencies_<id>_shop_<shopId>_<field>%`

| Field        | Description                       |
| ------------ | --------------------------------- |
| `name`       | The shop's display name.          |
| `item_count` | Number of items configured in it. |

## Shop item - `%xplayercurrencies_<id>_shop_<shopId>_<slot>_<field>%`

`<slot>` is the item's slot number in that shop (see the in-game item editor's "Move To Slot" button, or the shop's own YAML file).

| Field                      | Description                                                            |
| -------------------------- | ---------------------------------------------------------------------- |
| `name`                     | Item display name (falls back to a prettified material name if unset). |
| `enabled`                  | `true`/`false`.                                                        |
| `buy_price`                | Formatted buy price, or `-` if not buyable.                            |
| `sell_price`               | Formatted sell price, or `-` if not sellable.                          |
| `stock`                    | Current stock, or `∞` if stock isn't enabled for this item.            |
| `stock_max`                | Max stock, or `∞`.                                                     |
| `in_stock`                 | `true`/`false`.                                                        |
| `price_multiplier`         | Current dynamic-pricing multiplier (`1` if dynamic pricing is off).    |
| `purchase_limit_remaining` | Remaining purchases for the requesting player, or `∞`.                 |
| `purchase_limit_used`      | Purchases already made by the requesting player.                       |

Next: [Cross-Server Sync](/home/xplayercurrencies/integrations/cross-server-redis.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/integrations/placeholderapi.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.