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

# API

## Methods

The main class for the API is `TheSearchAPI`. You can use this class whenever you want in your plugin.

```java
int total = TheSearchAPI.getTotalFoundObjects(Player player,String searchName);
int remaining = TheSearchAPI.getRemainingObjectsToFind(Player player,String searchName);
boolean isCompleted = TheSearchAPI.hasCompletedSearch(Player player,String searchName);
```

## Events

```java
// Event called when a player finds an object
@EventHandler
public void findObject(SearchFindEvent event){
    Player player = event.getPlayer();
    ObjectToFind object = event.getFoundObject();
    Search search = event.getSearch();
    boolean isLastBlock = event.isLast();
}
```