The perfect starting point to integrate Algolia within your Java project

Documentation • Community Forum • Stack Overflow • Report a bug • FAQ • Support

✨ Features

• Support Java 8 and above
• Asynchronous and synchronous methods to interact with Algolia's API
• Thread-safe clients
• Typed requests and responses

💡 Getting Started

To get started, add the algoliasearch-client-java dependency to your project, either with Maven:

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.0.0-beta.36</version>
</dependency>

or Gradle:

dependencies {
  implementation 'com.algolia:algoliasearch:4.0.0-beta.36'
}

You can now import the Algolia API client in your project and play with it.

import com.algolia.api.SearchClient;
import com.algolia.model.search.*;

SearchClient client = new SearchClient("YOUR_APP_ID", "YOUR_API_KEY");

// Add a new record to your Algolia index
client.saveObject("<YOUR_INDEX_NAME>", Map.of("objectID", "id", "test", "val"));

// Poll the task status to know when it has been indexed
client.waitForTask("<YOUR_INDEX_NAME>", response.getTaskID());

// Fetch search results, with typo tolerance
client.search(
  new SearchMethodParams()
    .setRequests(List.of(new SearchForHits().setIndexName("<YOUR_INDEX_NAME>").setQuery("<YOUR_QUERY>").setHitsPerPage(50))),
  Hit.class
);

For full documentation, visit the Algolia Java API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue

Contributing

This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.

📄 License

The Algolia Java API Client is an open-sourced software licensed under the MIT license.