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

# PlaceholderAPI variables

**TheSearch** provides you some PlaceholderAPI variables you can use on other plugins.

| Placeholder                                         | Description                                                                                                                                                                                                                                                    |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `%thesearch_total_found_objects_<search>%`          | Total objects founds on a specific search.                                                                                                                                                                                                                     |
| `%thesearch_remaining_objects_<search>%`            | Total of remaining objects to found on a specific search.                                                                                                                                                                                                      |
| `%thesearch_has_completed_<search>%`                | Returns `true` if a player has completed a specific search or `false` if not.                                                                                                                                                                                  |
| `%thesearch_has_found_object_<search>_<id>%`        | Returns `true` if the player has found a certain object on a search or `false` if not.                                                                                                                                                                         |
| `%thesearch_total_objects_<search>%`                | Total objects on a specific search.                                                                                                                                                                                                                            |
| `%thesearch_total_players_with_completed_<search>%` | Amount of players that have completed a specific search.                                                                                                                                                                                                       |
| `%thesearch_total_completed_searches%`              | Total completed searches of the player.                                                                                                                                                                                                                        |
| `%thesearch_top_player_name_<search>:<pos>%`        | <p>Gets the top <code>\<pos></code> player's name associated with objects found on search <code>\<search></code>.<br><br>Replace <code>\<search></code> with <code>all</code> to get the top associated with total objects of all searches.</p>                |
| `%thesearch_top_player_total_<search>:<pos>%`       | <p>Gets the top <code>\<pos></code> player's total found objects associated with objects found on search <code>\<search></code>.<br><br>Replace <code>\<search></code> with <code>all</code> to get the top associated with total objects of all searches.</p> |
| `%thesearch_top_player_pos_<search>%`               | <p>Gets the current top position of the player on a certain search.<br><br>Replace <code>\<search></code> with <code>all</code> to get the top associated with total objects of all searches.</p>                                                              |
| `%thesearch_is_enabled_<search>%`                   | Returns `true` or `false` whether the search is enabled or not.                                                                                                                                                                                                |
