Android search API client

Features

  • Gives API access to all Algolia functionality, settings, advanced features, and ML/AI products
  • Compatible with InstantSearch for Android
  • Works with Android Studio (recommended) or without
  • Background retry strategy to ensure uptime
  • Seamless batching via iterators to optimize number of network calls
  • Zero downtime reindexing feature

Version

  • Latest release
  • We recommend using our Kotlin API client, which is better suited for Android development

Related Integrations

  • InstantSearch for Android
  • Autocomplete

Key links


Get started

INSTALL

1// Gradle
2dependencies {
3    // [...]
4    implementation 'com.algolia:algoliasearch-android:3.+'
5    // This will automatically update to the latest v3 release when you build your project
6}

INDEX

1List<JSONObject> array = new ArrayList<JSONObject>();
2array.add(
3  new JSONObject()
4    .put("firstname", "Jimmie")
5    .put("lastname", "Barninger")
6    .put("objectID", "myID")
7);
8array.add(
9  new JSONObject()
10    .put("firstname", "Warren")
11    .put("lastname", "Speach")
12    .put("objectID", "myID2")
13);
14
15index.saveObjectsAsync(new JSONArray(array), null);

SEARCH

1Index index = client.getIndex("contacts");
2
3// Add settings
4Query query = new Query("query string")
5  .setAttributesToRetrieve("firstname", "lastname")
6  .setHitsPerPage(50);
7
8// Perform search
9index.searchAsync(query, new CompletionHandler() {
10  @Override
11  public void requestCompleted(JSONObject content, AlgoliaException error) {
12    // [...]
13  }
14});

Built with Algolia