> For the complete documentation index, see [llms.txt](https://headhunter-1.gitbook.io/headhunter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://headhunter-1.gitbook.io/headhunter/core-features/placeholders.md).

# Placeholders

{% hint style="info" %}
HeadHunter placeholders require [<mark style="color:$primary;">PlaceholderAPI (PAPI)</mark>](https://www.spigotmc.org/resources/placeholderapi.6245/) to be installed on your server.
{% endhint %}

### Usage

All HeadHunter placeholders use the headhunter identifier. The format is: <mark style="color:$primary;">%headhunter\_\<placeholder>%</mark>

These can be used anywhere PlaceholderAPI is supported (scoreboards, holograms, chat plugins, etc).

### Placeholder List:

#### Levels

| Placeholder                   | Description                                                                                                                       |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| %headhunter\_level%           | The player's current HeadHunter level. Returns `Max Prestige` if the player is at max prestige.                                   |
| %headhunter\_previous\_level% | The player's previous HeadHunter level.                                                                                           |
| %headhunter\_next\_level%     | The player's next HeadHunter level. Returns `Max Prestige` if the next level is max prestige, or `-1` if already at max prestige. |
| %headhunter\_current\_mob%    | The player's current mob at their level. Returns `Max Prestige` if at max prestige, or `none` if no mob is assigned.              |

#### Heads

| Placeholder                    | Description                                                  |
| ------------------------------ | ------------------------------------------------------------ |
| `%headhunter_total_heads%`     | The total number of heads the player has collected.          |
| `%headhunter_remaining_heads%` | The number of heads the player still needs to level up.      |
| `%headhunter_required_heads%`  | The total heads required to level up from the current level. |

#### Economy

| Placeholder                               | Description                                                                               |
| ----------------------------------------- | ----------------------------------------------------------------------------------------- |
| `%headhunter_levelup_cost%`               | The money cost to level up from the current level (formatted currency).                   |
| `%headhunter_remaining_money_needed%`     | The remaining money the player needs to level up (formatted currency).                    |
| `%headhunter_level_total_money%`          | The total money needed to level up from the current level (formatted currency).           |
| `%headhunter_previous_level_total_money%` | The total money that was needed to level up from the previous level (formatted currency). |


---

# 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://headhunter-1.gitbook.io/headhunter/core-features/placeholders.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.