Getting Started


  1. In you project, open the “Package Manager Console” (Tools → Library Package Manager → Package Manager Console)
  2. Enter Install-Package Algolia.Search in the Package Manager Console

Init index - InitIndex

To initialize the client, you need your Application ID and API Key. You can find both of them on your Algolia account.


Quick Start

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:

// Load JSON file
StreamReader re = File.OpenText("contacts.json");
JsonTextReader reader = new JsonTextReader(re);
JArray batch = JArray.Load(reader);
// Add objects
Index index = client.InitIndex("contacts");
// Asynchronous
// await index.AddObjectsAsync(batch);

You can now search for contacts using firstname, lastname, company, etc. (even with typos):

// search by firstname
System.Diagnostics.Debug.WriteLine(index.Search(new Query("jimmie")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("jimmie")));
// search a firstname with typo
System.Diagnostics.Debug.WriteLine(index.Search(new Query("jimie")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("jimie")));
// search for a company
System.Diagnostics.Debug.WriteLine(index.Search(new Query("california paint")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("california paint")));
// search for a firstname & company
System.Diagnostics.Debug.WriteLine(index.Search(new Query("jimmie paint")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("jimmie paint")));

Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:

// Asynchronous
// await index.SetSettingsAsync(JObject.Parse(@"{""customRanking"":[""desc(followers)""]}"));

You can also configure the list of attributes you want to index by order of importance (first = most important):

index.SetSettings(JObject.Parse(@"{""searchableAttributes"":[""lastname"", ""firstname"",
                                                          ""company"", ""email"", ""city""]}"));
// Asynchronous
//await index.SetSettingsAsync(JObject.Parse(@"{""searchableAttributes"":[""lastname"", ""firstname"",
//                                                                     ""company"", ""email"", ""city""]}"));

Since the engine is designed to suggest results as you type, you’ll generally search by prefix. In this case the order of attributes is very important to decide which hit is the best:

System.Diagnostics.Debug.WriteLine(index.Search(new Query("or")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("or")));

System.Diagnostics.Debug.WriteLine(index.Search(new Query("jim")));
// Asynchronous
// System.Diagnostics.Debug.WriteLine(await index.SearchAsync(new Query("jim")));

Note: If you are building a web application, you may be more interested in using our JavaScript client to perform queries.

It brings two benefits:

  • Your users get a better response time by not going through your servers
  • It will offload unnecessary tasks from your servers
<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');

// perform query "jim"
index.search('jim', searchCallback);

// the last optional argument can be used to add search parameters
  'jim', {
    hitsPerPage: 5,
    facets: '*',
    maxValuesPerFacet: 10

function searchCallback(err, content) {
  if (err) {