> For the complete documentation index, see [llms.txt](https://docs.ohalee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ohalee.com/products/ultimateguilds/placeholders.md).

# Placeholders

UltimateGuilds registers a **PlaceholderAPI** expansion under the identifier `guilds`. Install [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) and the placeholders below resolve against the guild of the player they are parsed for.

{% hint style="info" %}
If the player is not in a guild, `%guilds_inguild%` returns `false` and most placeholders fall back to a configurable "guild not found" message. `%guilds_tag%` has its own fallback when the player has no guild or the guild has no tag.
{% endhint %}

<table><thead><tr><th width="300">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%guilds_inguild%</td><td><code>true</code> / <code>false</code> — whether the player is in a guild</td></tr><tr><td>%guilds_name%</td><td>The guild's name</td></tr><tr><td>%guilds_tag%</td><td>The guild's tag</td></tr><tr><td>%guilds_leader%</td><td>Username of the Guild Master</td></tr><tr><td>%guilds_members%</td><td>Total number of members</td></tr><tr><td>%guilds_online%</td><td>Number of members currently online</td></tr><tr><td>%guilds_invites%</td><td>Number of pending invites</td></tr><tr><td>%guilds_description%</td><td>The guild's description</td></tr><tr><td>%guilds_level%</td><td>The guild's level</td></tr><tr><td>%guilds_xp%</td><td>The guild's current experience</td></tr><tr><td>%guilds_multiplier%</td><td>The guild's multiplier</td></tr><tr><td>%guilds_maxmembers%</td><td>The guild's maximum member capacity</td></tr><tr><td>%guilds_id%</td><td>The guild's internal id</td></tr><tr><td>%guilds_created%</td><td>Creation timestamp (raw)</td></tr><tr><td>%guilds_created_formatted%</td><td>Creation date formatted with <code>date-format</code> from the config</td></tr><tr><td>%guilds_max_level%</td><td>The highest level a guild can reach</td></tr><tr><td>%guilds_xp_needed%</td><td>Experience still needed for the next level, <code>0</code> at the cap</td></tr><tr><td>%guilds_xp_progress%</td><td>How far through the current level the guild is, 0 to 100</td></tr></tbody></table>

## Leaderboards

These are about every guild rather than the reader's, so they resolve for a player with no guild too. They read the last snapshot rather than the database — see [relations.md](/products/ultimateguilds/relations.md) for how often it is rebuilt — and return an empty string for a position no guild holds.

<table><thead><tr><th width="420">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%guilds_top_&#x3C;board>_&#x3C;position>_name%</td><td>The name of the guild at that position</td></tr><tr><td>%guilds_top_&#x3C;board>_&#x3C;position>_value%</td><td>Its score on that board</td></tr></tbody></table>

`board` is `experience`, `level`, `members` or `kills`; `position` counts from 1. For example, `%guilds_top_experience_1_name%` is the name of the guild with the most experience.