Algolia Search is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke. The Algolia Search API Client for Android lets you easily use the Algolia Search REST API from your Android code.
Note: If you were using version 2.x of our Android client, read the migration guide to version 3.x.
You can browse the automatically generated reference documentation. (See also the offline-enabled version.)
This project is open-source under the MIT License.
Your contributions are welcome! Please use our formatting configuration to keep the coding style consistent.
You can find the full reference on Algolia's website.
Add the following dependency to your Gradle
build file:
dependencies {
// [...]
compile 'com.algolia:algoliasearch-android:3.10.1'
}
In 30 seconds, this quick start tutorial will show you how to index and search objects.
To begin, you will need to initialize the client. In order to do this you will need your Application ID and API Key. You can find both on your Algolia account.
Client client = new Client("YourApplicationID", "YourAPIKey");
Index index = client.getIndex("your_index_name");
Warning: If you are building a native app on mobile, be sure to not include the search API key directly in the source code. You should instead consider fetching the key from your servers during the app's startup.
Without any prior configuration, you can start indexing contacts in the contacts
index using the following code:
Index index = client.initIndex("contacts");
index.addObjectAsync(new JSONObject()
.put("firstname", "Jimmie")
.put("lastname", "Barninger")
.put("followers", 93)
.put("company", "California Paint"), null);
index.addObjectAsync(new JSONObject()
.put("firstname", "Warren")
.put("lastname", "Speach")
.put("followers", 42)
.put("company", "Norwalk Crmc"), null);
Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
JSONObject settings = new JSONObject().append("customRanking", "desc(followers)");
index.setSettingsAsync(settings, null);
You can also configure the list of attributes you want to index by order of importance (most important first).
Note: The Algolia engine is designed to suggest results as you type, which means you'll generally search by prefix. In this case, the order of attributes is very important to decide which hit is the best:
JSONObject settings = new JSONObject()
.append("searchableAttributes", "lastname")
.append("searchableAttributes", "firstname")
.append("searchableAttributes", "company");
index.setSettingsAsync(settings, null);
You can now search for contacts using firstname
, lastname
, company
, etc. (even with typos):
CompletionHandler completionHandler = new CompletionHandler() {
@Override
public void requestCompleted(JSONObject content, AlgoliaException error) {
// [...]
}
};
// search by firstname
index.searchAsync(new Query("jimmie"), completionHandler);
// search a firstname with typo
index.searchAsync(new Query("jimie"), completionHandler);
// search for a company
index.searchAsync(new Query("california paint"), completionHandler);
// search for a firstname & company
index.searchAsync(new Query("jimmie paint"), completionHandler);
Warning: If you are building a web application, you may be more interested in using one of our frontend search UI libraries
The following example shows how to build a front-end search quickly using InstantSearch.js
<!doctype html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.css">
</head>
<body>
<header>
<div>
<input id="search-input" placeholder="Search for products">
<!-- We use a specific placeholder in the input to guides users in their search. -->
</header>
<main>
</main>
<script type="text/html" id="hit-template">
<p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p>
</script>
<script src="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.js"></script>
<script src="app.js"></script>
</body>
var search = instantsearch({
// Replace with your own values
appId: 'YourApplicationID',
apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
indexName: 'contacts',
urlSync: true
});
search.addWidget(
instantsearch.widgets.searchBox({
container: '#search-input'
})
);
search.addWidget(
instantsearch.widgets.hits({
container: '#hits',
hitsPerPage: 10,
templates: {
item: document.getElementById('hit-template').innerHTML,
empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
}
})
);
search.start();
- Need help? Ask a question to the Algolia Community or on Stack Overflow.
- Found a bug? You can open a GitHub issue.