node package manager

algoliasearch

AlgoliaSearch API JavaScript client

Algolia Search API Client for JavaScript

Algolia Search is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

The JavaScript client lets you use the Algolia Search API on the frontend (browsers) or on the backend (Node.js) with the same API.

The backend (Node.js) API can be used to index your data using your Algolia admin API keys.

Our JavaScript library is UMD compatible, you can use it with any module loader.

When not using any module loader, it will export an algoliasearch function in the window object.

Getting Started

  1. Getting started
  1. Quick Start
  1. Client options
  2. Callback convention
  3. Promises
  4. Request strategy
  5. Cache
  6. Proxy support
  7. Keep-alive
  8. Debugging
  9. Guides & Tutorials
  10. Old JavaScript clients

Commands Reference

Getting started

  1. Install
  2. Init index

Search

  1. Search in an index
  2. Find by IDs

Indexing

  1. Add objects
  2. Update objects
  3. Partial update
  4. Delete objects

Settings

  1. Get settings
  2. Set settings

Manage Indices

  1. List indices
  2. Delete index
  3. Clear index
  4. Copy index
  5. Move index

Api Keys

  1. Generate key

Synonyms

  1. Save synonym
  2. Batch synonyms
  3. Editing Synonyms
  4. Delete Synonyms
  5. Clear all synonyms
  6. Get synonym
  7. Search synonyms

Advanced

  1. Custom batch
  2. Wait for operations
  3. Multiple queries
  4. Delete by query
  5. Backup / Export an index
  6. List api keys
  7. Add user key
  8. Update user key
  9. Delete user key
  10. Get key permissions
  11. Get Logs

Check our online guides:

Old JavaScript clients

In April 2015, we released the V3 of our JavaScript client (the one you are looking at) able to work in Node.js and the browser.

If you were using our browser version (V2), read the migration guide

If you were using our Node.js version (V1, npm algolia-search), read the migration guide

You can either use a package manager like npm or include a <script> tag.

We are browserifyable and webpack friendly.

npm install algoliasearch --save
bower install algoliasearch -S

jsDelivr is a global CDN delivery for JavaScript libraries.

To include the latest releases and all upcoming features and patches, use this:

<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>

We recommend using jsDelivr, but algoliasearch is also available at:

We have a lightweight build available that can only do searches. Use it when filesize is important to you or if you like to include only what you need.

Find it on jsDelivr:

<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearchLite.min.js"></script>

To initialize the client you need your ApplicationID and API-Key. You can find all of them on your Algolia account

// var algoliasearch = require('algoliasearch'); 
// var algoliasearch = require('algoliasearch/reactnative'); 
// var algoliasearch = require('algoliasearch/lite'); 
// or just use algoliasearch if you are using a <script> tag 
// if you are using AMD module loader, algoliasearch will not be defined in window, 
// but in the AMD modules of the page 
 
var client = algoliasearch('applicationID', 'apiKey');
var index = client.initIndex('indexName');
index.search('something', function searchDone(err, content) {
  console.log(err, content);
});

The JavaScript API client gives you access to low level methods to search and receive results. This is all you need for building your front-end but will require custom code on your side for displaying the results. Reading our guides will help you in that.

We've also released two JavaScript libraries to ease the building of the most common kind of UI:

autocomplete.js

autocomplete.js helps you build dropdown menus.

instantsearch.js

instantsearch.js is for full page search.

We strongly encourage you to have a look at those libraries because they are packaged with a lot of options that will cover most of your needs without requiring you to do all the plumbing.

To build your frontend search experience, also check out our guides.

<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
  var client = algoliasearch('ApplicationID', 'apiKey');
  var index = client.initIndex('indexName');
 
  index.search('an example', function searchDone(err, content) {
    console.log(err, content)
  });
 
  index.search('another example')
    .then(function searchSuccess(content) {
      console.log(content);
    })
    .catch(function searchFailure(err) {
      console.error(err);
    });
</script> 

You can see the full Vanilla JavaScript example here

We provide a specific jQuery build that will use jQuery.ajax.

It can be used with callbacks or jQuery promises.

<script src="https://cdn.jsdelivr.net/jquery/2.1.3/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.jquery.min.js"></script>
<script>
  var client = $.algolia.Client('ApplicationID', 'apiKey');
  var index = client.initIndex('indexName');
  index.search('something', function searchDone(err, content) {
    console.log(err, content)
  });
</script> 

You can see the full jQuery example here

We provide a specific AngularJS build that is using the $http service.

It can be used with callbacks or AngularJS promises.

Also see our AngularJS example on github.

<script src="https://cdn.jsdelivr.net/angularjs/1/angular.min.js"></script>
<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.angular.min.js"></script>
<script>
  angular
    .module('myapp', ['algoliasearch'])
    .controller('SearchCtrl', ['$scope', 'algolia', function($scope, algolia) {
      $scope.search = {
        query: '',
        hits: []
      };
      var client = algolia.Client('ApplicationID', 'apiKey');
      var index = client.initIndex('indexName');
 
      $scope.$watch('search.query', function() {
        index.search($scope.search.query)
          .then(function searchSuccess(content) {
            console.log(content);
            // add content of search results to scope for display in view 
            $scope.search.hits = content.hits;
          }, function searchFailure(err) {
            console.log(err);
        });
      });
    }]);
</script> 

You can see the full Angular example here

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:

var index = client.initIndex('contacts');
var contactsJSON = require('./contacts.json');
 
index.addObjects(contactsJSON, function(err, content) {
  if (err) {
    console.error(err);
  }
});

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

// firstname 
index.search('jimmie', function(err, content) {
  console.log(content.hits);
});
 
// firstname with typo 
index.search('jimie', function(err, content) {
  console.log(content.hits);
});
 
// a company 
index.search('california paint', function(err, content) {
  console.log(content.hits);
});
 
// a firstname & company 
index.search('jimmie paint', function(err, content) {
  console.log(content.hits);
});

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:

index.setSettings({
  'customRanking': ['desc(followers)']
}, function(err, content) {
  console.log(content);
});

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

index.setSettings({
  'attributesToIndex': [
    'lastname',
    'firstname',
    'company',
    'email',
    'city',
    'address'
  ]
}, function(err, content) {
  console.log(content);
});

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:

index.search('or', function(err, content) {
  console.log(content.hits);
});
 
index.search('jim', function(err, content) {
  console.log(content.hits);
});

In most situations, there is no need to tune the options. We provide this list to be transparent with our users.

  • timeout (Number) timeout for requests to our servers, in milliseconds
    • in Node.js this is an inactivity timeout. Defaults to 15s
    • in the browser, this is a global timeout. Defaults to 2s (incremental)
  • protocol (String) protocol to use when communicating with algolia
    • in the browser, we use the page protocol by default
    • in Node.js it's https by default
    • possible values: 'http:', 'https:'
  • hosts.read ([String]) array of read hosts to use to call Algolia servers, computed automatically
  • hosts.write ([String]) array of write hosts to use to call Algolia servers, computed automatically
  • httpAgent (HttpAgent) node-only Node.js httpAgent instance to use when communicating with Algolia servers.

To pass an option, use:

var client = algoliasearch(applicationId, apiKey, {
  timeout: 4000
})

Every API call takes a callback as last parameter. This callback will then be called with two arguments:

  1. error: null or an Error object. More info on the error can be find in error.message.
  2. content: the object containing the answer from the server, it's a JavaScript object

If you do not provide a callback, you will get a promise (but never both).

Promises are the native Promise implementation.

We use jakearchibald/es6-promise as a polyfill when needed.

The request strategy used by the JavaScript client includes:

Connections are always keep-alive.

Browser only

To avoid performing the same API calls twice search results will be stored in a cache that will be tied to your JavaScript client and index objects. Whenever a call for a specific query (and filters) is made, we store the results in a local cache. If you ever call the exact same query again, we read the results from the cache instead of doing an API call.

This is particularly useful when your users are deleting characters from their current query, to avoid useless API calls. Because it is stored as a simple JavaScript object in memory, the cache is automatically reset whenever you reload the page.

It is never automatically purged, nor can it be completely disabled. Instead, we provide the index.clearCache() (or client.clearCache() if you're doing multiple queries) method that you can call to reset it.

Node.js only

If you are behind a proxy, just set HTTP_PROXY or HTTPS_PROXY environment variables before starting your Node.js program.

HTTP_PROXY=http://someproxy.com:9320 node main.js

Node.js only

Keep-alive is activated by default.

Because of the nature of keepalive connections, your process will hang even if you do not do any more command using the client.

To fix this, we expose a client.destroy() method that will terminate all remaining alive connections.

You should call this method when you are finished working with the AlgoliaSearch API. So that your process will exit gently.

Note: keep-alive is still always activated in browsers, this is a native behavior of browsers.

The client will send you errors when a method call fails for some reasons.

You can get detailed debugging information:

index.search('something', function searchDone(err) {
  if (err) {
    console.log(err.message);
    console.log(err.debugData);
    return;
  }
});

err.debugData contains the array of requests parameters that were used to issue requests.

To perform a search, you only need to initialize the index and perform a call to the search function.

The search query allows only to retrieve 1000 hits, if you need to retrieve more than 1000 hits for seo, you can use Backup / Retrieve all index content

var client = algoliasearch('ApplicationID', 'Search-Only-API-Key');
var index = client.initIndex('indexName');
 
// only query string 
index.search('query string', function searchDone(err, content) {
  if (err) {
    console.error(err);
    return;
  }
 
  for (var h in content.hits) {
    console.log('Hit(' + content.hits[h].objectID + '): ' + content.hits[h].toString());
  }
});
 
// with params 
index.search('query string', {
  attributesToRetrieve: ['firstname', 'lastname'],
  hitsPerPage: 50
}, function searchDone(err, content) {
  if (err) {
    console.error(err);
    return;
  }
 
  for (var h in content.hits) {
    console.log('Hit(' + content.hits[h].objectID + '): ' + content.hits[h].toString());
  }
});

The server response will look like:

{
  "hits": [
    {
      "firstname": "Jimmie",
      "lastname": "Barninger",
      "objectID": "433",
      "_highlightResult": {
        "firstname": {
          "value": "<em>Jimmie</em>",
          "matchLevel": "partial"
        },
        "lastname": {
          "value": "Barninger",
          "matchLevel": "none"
        },
        "company": {
          "value": "California <em>Paint</em> & Wlpaper Str",
          "matchLevel": "partial"
        }
      }
    }
  ],
  "page": 0,
  "nbHits": 1,
  "nbPages": 1,
  "hitsPerPage": 20,
  "processingTimeMS": 1,
  "query": "jimmie paint",
  "params": "query=jimmie+paint&attributesToRetrieve=firstname,lastname&hitsPerPage=50"
}

You can use the following optional arguments:

Here is the list of parameters you can use with the search method (search scope): Parameters that can also be used in a setSettings also have the indexing scope

Search

Attributes

Filtering / Faceting

Highlighting / Snippeting

Pagination

Typos

Geo-Search

Query Strategy

Advanced

You can easily retrieve an object using its objectID and optionally specify a comma separated list of attributes you want:

// Retrieves all attributes 
index.getObject('myID', function(err, content) {
  console.log(content.objectID + "" + content.toString());
});
 
// Retrieves firstname and lastname attributes 
index.getObject('myID', ['firstname', 'lastname'], function(err, content) {
  console.log(content.objectID + "" + content.toString());
});

You can also retrieve a set of objects:

index.getObjects(['myObj1', 'myObj2'], function(err, content) {
  console.log(content);
});

Each entry in an index has a unique identifier called objectID. There are two ways to add an entry to the index:

  1. Using automatic objectID assignment. You will be able to access it in the answer.
  2. Supplying your own objectID.

You don't need to explicitly create an index, it will be automatically created the first time you add an object. Objects are schema less so you don't need any configuration to start indexing. If you wish to configure things, the settings section provides details about advanced settings.

Example with automatic objectID assignment:

index.addObject({
  firstname: 'Jimmie',
  lastname: 'Barninger'
}, function(err, content) {
  console.log('objectID=' + content.objectID);
});

Example with manual objectID assignment:

index.addObject({
  firstname: 'Jimmie',
  lastname: 'Barninger'
}, 'myID', function(err, content) {
  console.log('objectID=' + content.objectID);
});

You have three options when updating an existing object:

  1. Replace all its attributes.
  2. Replace only some attributes.
  3. Apply an operation to some attributes.

Example on how to replace all attributes of an existing object:

index.saveObject({
  firstname: 'Jimmie',
  lastname: 'Barninger',
  city: 'New York',
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

You have many ways to update an object's attributes:

  1. Set the attribute value
  2. Add a string or number element to an array
  3. Remove an element from an array
  4. Add a string or number element to an array if it doesn't exist
  5. Increment an attribute
  6. Decrement an attribute

Example to update only the city attribute of an existing object:

index.partialUpdateObject({
  city: 'San Francisco',
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Example to add a tag:

index.partialUpdateObject({
  _tags: {
    value: 'MyTag',
    _operation: 'Add'
  },
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Example to remove a tag:

index.partialUpdateObject({
  _tags: {
    value: 'MyTag',
    _operation:'Remove'
  },
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Example to add a tag if it doesn't exist:

index.partialUpdateObject({
  _tags: {
    value: 'MyTag',
    _operation: 'AddUnique'
  },
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Example to increment a numeric value:

index.partialUpdateObject({
  price: {
    value: 42,
    _operation: 'Increment'
  },
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Note: Here we are incrementing the value by 42. To increment just by one, put value:1.

Example to decrement a numeric value:

index.partialUpdateObject({
  price: {
    value: 42,
    _operation: 'Decrement'
  },
  objectID: 'myID'
}, function(err, content) {
  console.log(content);
});

Note: Here we are decrementing the value by 42. To decrement just by one, put value:1.

You can delete an object using its objectID:

index.deleteObject('myID', function(error) {
  if (!err) {
    console.log('success');
  }
});

You can delete all objects matching a single query with the following code. Internally, the API client performs the query, deletes all matching hits, and waits until the deletions have been applied.

Take your precautions when using this method. Calling it with an empty query will result in cleaning the index of all its records.

// no query parameters 
index.deleteByQuery('John', function(error) {
  if (!err) {
    console.log('success');
  }
});
 
// with query parameters 
index.deleteByQuery('John', {
  some: 'query',
  param: 'eters'
}, function(error) {
  if (!err) {
    console.log('success');
  }
});

All write operations in Algolia are asynchronous by design.

It means that when you add or update an object to your index, our servers will reply to your request with a taskID as soon as they understood the write operation.

The actual insert and indexing will be done after replying to your code.

You can wait for a task to complete using the waitTask method on the taskID returned by a write operation.

For example, to wait for indexing of a new object:

var object = {
  firstname: 'Jimmie',
  lastname: 'Barninger'
};
 
index.addObject(object, function(err, content) {
  index.waitTask(content.taskID, function(err) {
    if (!err) {
      console.log('object ' + content.objectID + ' indexed');
    }
  });
});

If you want to ensure multiple objects have been indexed, you only need to check the biggest taskID.

You can retrieve settings:

index.getSettings(function(err, content) {
  console.log(content);
});
index.setSettings({'customRanking': ['desc(followers)']}, function(err) {
  if (!err) {
    console.log('success');
  }
});

You can forward all settings updates to the slaves of an index by using the forwardToSlaves option:

index.setSettings({'customRanking': ['desc(followers)']}, {forwardToSlaves: true}, function(err) {
  if (!err) {
    console.log('success');
  }
});

Here is the list of parameters you can use with the set settings method (indexing scope)

Parameters that can be override at search time also have the indexing scope

Attributes

Ranking

Filtering / Faceting

Highlighting / Snippeting

Pagination

Typos

Query Strategy

Advanced

Each parameter in this page has a scope. Depending on the scope, you can use the parameter within the setSettings and/or the search method

They are three scopes:

  • settings: The setting can only be used in the setSettings method
  • search: The setting can only be used in the search method
  • settings search: The setting can be used in the setSettings method and be override in thesearch method

Search

Attributes

Ranking

Filtering / Faceting

Highlighting / Snippeting

Pagination

Typos

Geo-Search

Query Strategy

Advanced

  • scope: search
  • type: string
  • default: ""

The instant search query string, used to set the string you want to search in your index. If no query parameter is set, the textual search will match with all the objects.

  • scope: settings
  • type: array of strings
  • default: *

The list of attributes you want index (i.e. to make searchable).

If set to null, all textual and numerical attributes of your objects are indexed. Make sure you updated this setting to get optimal results.

This parameter has two important uses:

  • Limit the attributes to index.
    For example, if you store the URL of a picture, you want to store it and be able to retrieve it, but you probably don't want to search in the URL.
  • Control part of the ranking.
    Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. In one attribute, matching text at the beginning of the attribute will be considered more important than text after. You can disable this behavior if you add your attribute inside unordered(AttributeName). For example, attributesToIndex: ["title", "unordered(text)"]. You can decide to have the same priority for two attributes by passing them in the same string using a comma as a separator. For example title and alternative_title have the same priority in this example, which is different than text priority: attributesToIndex:["title,alternative_title", "text"]. To get a full description of how the Ranking works, you can have a look at our Ranking guide.
  • scope: settings
  • type: array of strings
  • default: null

The list of fields you want to use for faceting. All strings in the attribute selected for faceting are extracted and added as a facet. If set to null, no attribute is used for faceting.

  • scope: settings
  • type: array of strings
  • default: null

The list of attributes that cannot be retrieved at query time. This feature allows you to have attributes that are used for indexing and/or ranking but cannot be retrieved

Warning: for testing purposes, this setting is ignored when you're using the ADMIN API Key.

  • scope: settings, search
  • type: array of strings
  • default: *

A string that contains the list of attributes you want to retrieve in order to minimize the size of the JSON answer.

Attributes are separated with a comma (for example "name,address"). You can also use a string array encoding (for example ["name","address"] ). By default, all attributes are retrieved. You can also use * to retrieve all values when an attributesToRetrieve setting is specified for your index.

objectID is always retrieved even when not specified.

  • scope: search
  • type: array of strings
  • default: attributesToIndex

List of attributes you want to use for textual search (must be a subset of the attributesToIndex index setting). Attributes are separated with a comma such as "name,address". You can also use JSON string array encoding such as encodeURIComponent("[\"name\",\"address\"]"). By default, all attributes specified in the attributesToIndex settings are used to search.

  • scope: settings
  • type: array of strings
  • default: ['typo', 'geo', 'words', 'filters', 'proximity', 'attribute', 'exact', 'custom']

Controls the way results are sorted.

We have nine available criterion:

  • typo: Sort according to number of typos.
  • geo: Sort according to decreasing distance when performing a geo location based search.
  • words: Sort according to the number of query words matched by decreasing order. This parameter is useful when you use the optionalWords query parameter to have results with the most matched words first.
  • proximity: Sort according to the proximity of the query words in hits.
  • attribute: Sort according to the order of attributes defined by attributesToIndex.
  • exact:
    • If the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example, if you search for the TV show "V", you want to find it with the "V" query and avoid getting all popular TV shows starting by the letter V before it.
    • If the user query contains multiple words: sort according to the number of words that matched exactly (not as a prefix).
  • custom: Sort according to a user defined formula set in the customRanking attribute.
  • asc(attributeName): Sort according to a numeric attribute using ascending order. attributeName can be the name of any numeric attribute in your records (integer, double or boolean).
  • desc(attributeName): Sort according to a numeric attribute using descending order. attributeName can be the name of any numeric attribute in your records (integer, double or boolean).


To get a full description of how the Ranking works, you can have a look at our Ranking guide.

  • scope: settings
  • type: array of strings
  • default: []

Lets you specify part of the ranking.

The syntax of this condition is an array of strings containing attributes prefixed by the asc (ascending order) or desc (descending order) operator.

For example, "customRanking" => ["desc(population)", "asc(name)"].

To get a full description of how the Custom Ranking works, you can have a look at our Ranking guide.

  • scope: settings
  • type: array of strings
  • default: []

The list of indices on which you want to replicate all write operations.

In order to get response times in milliseconds, we pre-compute part of the ranking during indexing.

If you want to use different ranking configurations depending of the use case, you need to create one index per ranking configuration.

This option enables you to perform write operations only on this index and automatically update slave indices with the same operations.

  • scope: search
  • type: string
  • default: ""

Filter the query with numeric, facet or/and tag filters.

The syntax is a SQL like syntax, you can use the OR and AND keywords. The syntax for the underlying numeric, facet and tag filters is the same than in the other filters:

available=1 AND (category:Book OR NOT category:Ebook) AND _tags:public date: 1441745506 TO 1441755506 AND inStock > 0 AND author:"John Doe"

If no attribute name is specified, the filter applies to _tags.

For example: public OR user_42 will translate to _tags:public OR _tags:user_42.

The list of keywords is:

  • OR: create a disjunctive filter between two filters.
  • AND: create a conjunctive filter between two filters.
  • TO: used to specify a range for a numeric filter.
  • NOT: used to negate a filter. The syntax with the - isn’t allowed.

Note: To specify a value with spaces or with a value equal to a keyword, it's possible to add quotes.

Warning:

  • Like for the other filters (for performance reasons), it's not possible to have FILTER1 OR (FILTER2 AND FILTER3).
  • It's not possible to mix different categories of filters inside an OR like: num=3 OR tag1 OR facet:value
  • It's not possible to negate a group, it's only possible to negate a filter: NOT(FILTER1 OR (FILTER2) is not allowed.
  • scope: search
  • type: string
  • default: ""

You can use facets to retrieve only a part of your attributes declared in attributesForFaceting attributes. It will not filter your results, if you want to filter results you should use filters.

For each of the declared attributes, you'll be able to retrieve a list of the most relevant facet values, and their associated count for the current query.

** Example **

If you have defined in your attributesForFaceting:

['category', 'author', 'nb_views', 'nb_downloads']

But for the current search want to retrieve only facet values for category and author.

You can specify your attributes coma separated.

For this example: "category,author".

You can also use JSON string array encoding.

For this example: ["category","author"].

Warnings

  • When using facets in a search query, only attributes that have been added in attributesForFaceting index setting can be used in this parameter. You can also use * to perform faceting on all attributes specified in attributesForFaceting. If the number of results is important, the count can be approximate, the attribute exhaustiveFacetsCount in the response is true when the count is exact.
  • scope: settings, search
  • type: integer
  • default: ""

Limit the number of facet values returned for each facet.

For example, maxValuesPerFacet=10 will retrieve a maximum of 10 values per facet.

  • scope: settings, search
  • type: array of strings
  • default: null

Default list of attributes to highlight. If set to null, all indexed attributes are highlighted.

A string that contains the list of attributes you want to highlight according to the query. Attributes are separated by commas. You can also use a string array encoding (for example ["name","address"]). If an attribute has no match for the query, the raw value is returned. By default, all indexed attributes are highlighted (as long as they are strings). You can use * if you want to highlight all attributes.

A matchLevel is returned for each highlighted attribute and can contain:

  • full: If all the query terms were found in the attribute.
  • partial: If only some of the query terms were found.
  • none: If none of the query terms were found.
  • scope: settings, search
  • type: array of strings
  • default: null

Default list of attributes to snippet alongside the number of words to return (syntax is attributeName:nbWords). If set to null, no snippet is computed.

  • scope: settings, search
  • type: string
  • default: <em>

Specify the string that is inserted before the highlighted parts in the query result (defaults to <em>).

  • scope: settings, search
  • type: string
  • default: </em>

Specify the string that is inserted after the highlighted parts in the query result (defaults to </em>).

  • scope: settings, search
  • type: string
  • default:

String used as an ellipsis indicator when a snippet is truncated. Defaults to an empty string for all accounts created before 10/2/2016, and to … (UTF-8 U+2026) for accounts created after that date.

  • scope: settings, search
  • type: boolean
  • default: false

If set to true, restrict arrays in highlights and snippets to items that matched the query at least partially else return all array items in highlights and snippets.

  • scope: search
  • type: integer
  • default: 0

Pagination parameter used to select the page to retrieve.
Page is zero based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9.

  • scope: settings, search
  • type: integer
  • default: 20

Pagination parameter used to select the number of hits per page. Defaults to 20.

  • scope: settings, search
  • type: integer
  • default: 4

The minimum number of characters needed to accept one typo.

  • scope: settings, search
  • type: integer
  • default: 8

The minimum number of characters needed to accept two typos.

  • scope: settings, search
  • type: boolean
  • default: true

This option allows you to control the number of typos allowed in the result set:

  • true: The typo tolerance is enabled and all matching hits are retrieved (default behavior).
  • false: The typo tolerance is disabled. All results with typos will be hidden.
  • min: Only keep results with the minimum number of typos. For example, if one result matches without typos, then all results with typos will be hidden.
  • strict: Hits matching with 2 typos are not retrieved if there are some matching without typos.
  • scope: settings, search
  • type: boolean
  • default: true

If set to false, disables typo tolerance on numeric tokens (numbers).

  • scope: settings, search
  • type: boolean
  • default: false

If set to true, plural won't be considered as a typo. For example, car and cars, or foot and feet will be considered as equivalent. Defaults to false.

  • scope: settings, search
  • type: string
  • default: ""

List of attributes on which you want to disable typo tolerance (must be a subset of the attributesToIndex index setting).

Attributes are separated with a comma such as "name,address". You can also use JSON string array encoding such as encodeURIComponent("[\"name\",\"address\"]").

  • scope: settings
  • type: string
  • default: ""

Specify the separators (punctuation characters) to index.

By default, separators are not indexed.

Use +# to be able to search Google+ or C#.

  • scope: search
  • type: string
  • default: ``

Search for entries around a given latitude/longitude (specified as two floats separated by a comma).

For example, aroundLatLng=47.316669,5.016670.

  • By default the maximum distance is automatically guessed based on the density of the area but you can specify it manually in meters with the aroundRadius parameter. The precision for ranking can be set with aroundPrecision parameter.
  • If you set aroundPrecision=100, the distances will be considered by ranges of 100m.
  • For example all distances 0 and 100m will be considered as identical for the "geo" ranking parameter.

When aroundRadius is not set, the radius is computed automatically using the density of the area, you can retrieve the computed radius in the automaticRadius attribute of the answer, you can also use the minimumAroundRadius query parameter to specify a minimum radius in meters for the automatic computation of aroundRadius.

At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or "_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).

  • scope: search
  • type: string
  • default: false

Search for entries around a given latitude/longitude automatically computed from user IP address.

To enable it, use aroundLatLngViaIP=true.

You can specify the maximum distance in meters with the aroundRadius parameter and the precision for ranking with aroundPrecision.

For example:

  • if you set aroundPrecision=100, two objects that are in the range 0-99m will be considered as identical in the ranking for the "geo" ranking parameter (same for 100-199, 200-299, ... ranges).

When indexing, you should specify the geo location of an object with the _geoloc attribute in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}}.

  • scope: search
  • type: boolean
  • default: false

Search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng). For example:

  • insideBoundingBox=47.3165,4.9665,47.3424,5.0201

At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or "_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).

You can use several bounding boxes (OR) by passing more than 4 values. For example: instead of having 4 values you can pass 8 to search inside the UNION of two bounding boxes.

  • scope: search
  • type: string
  • default: ``

Search entries inside a given area defined by a set of points (defined by a minimum of 6 floats: p1Lat,p1Lng,p2Lat,p2Lng,p3Lat,p3Long).

For example: InsidePolygon=47.3165,4.9665,47.3424,5.0201,47.32,4.98).

At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or "_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).

  • scope: settings, search
  • type: enum
  • default: 'prefixLast'

Selects how the query words are interpreted. It can be one of the following values:

  • prefixAll: All query words are interpreted as prefixes. This option is not recommended.
  • prefixLast: Only the last word is interpreted as a prefix (default behavior).
  • prefixNone: No query word is interpreted as a prefix. This option is not recommended.
  • scope: settings, search
  • type: string
  • default: 'none'

This option is used to select a strategy in order to avoid having an empty result page. There are four different options:

  • lastWords: When a query does not return any results, the last word will be added as optional. The process is repeated with n-1 word, n-2 word, ... until there are results.
  • firstWords: When a query does not return any results, the first word will be added as optional. The process is repeated with second word, third word, ... until there are results.
  • allOptional: When a query does not return any results, a second trial will be made with all words as optional. This is equivalent to transforming the AND operand between query terms to an OR operand.
  • none: No specific processing is done when a query does not return any results (default behavior).
  • scope: settings, search
  • type: boolean
  • default: false

Enables the advanced query syntax.

This syntax allow to do two things:

  • Phrase query: A phrase query defines a particular sequence of terms. A phrase query is built by Algolia's query parser for words surrounded by ". For example, "search engine" will retrieve records having search next to engine only. Typo tolerance is disabled on phrase queries.
  • Prohibit operator: The prohibit operator excludes records that contain the term after the - symbol. For example, search -engine will retrieve records containing search but not engine.
  • scope: settings, search
  • type: array of strings
  • default: []

A string that contains the comma separated list of words that should be considered as optional when found in the query.

  • scope: settings, search
  • type: boolean, array of strings
  • default: false

Remove stop words from the query before executing it. It can be:

  • a boolean: enable or disable stop words for all 41 supported languages; or
  • a list of language ISO codes (as a comma-separated string) for which stop words should be enabled.

In most use-cases, we don’t recommend enabling this option.

List of 41 supported languages with their associated iso code: Arabic=ar, Armenian=hy, Basque=eu, Bengali=bn, Brazilian=pt-br, Bulgarian=bg, Catalan=ca, Chinese=zh, Czech=cs, Danish=da, Dutch=nl, English=en, Finnish=fi, French=fr, Galician=gl, German=de, Greek=el, Hindi=hi, Hungarian=hu, Indonesian=id, Irish=ga, Italian=it, Japanese=ja, Korean=ko, Kurdish=ku, Latvian=lv, Lithuanian=lt, Marathi=mr, Norwegian=no, Persian (Farsi)=fa, Polish=pl, Portugese=pt, Romanian=ro, Russian=ru, Slovak=sk, Spanish=es, Swedish=sv, Thai=th, Turkish=tr, Ukranian=uk, Urdu=ur.

Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType parameter:

  • queryType=prefixLast means the last query word is a prefix and it won’t be considered for stop words removal
  • queryType=prefixNone means no query word are prefix, stop words removal will be applied on all query words
  • queryType=prefixAll means all query terms are prefix, stop words won’t be removed

This parameter is useful when you have a query in natural language like “what is a record?”. In this case, before executing the query, we will remove “what”, “is” and “a” in order to just search for “record”. This removal will remove false positive because of stop words, especially when combined with optional words. For most use cases, it is better to not use this feature as people search by keywords on search engines.

  • scope: settings
  • type: array of strings
  • default: []

List of attributes on which you want to disable prefix matching (must be a subset of the attributesToIndex index setting).

This setting is useful on attributes that contain string that should not be matched as a prefix (for example a product SKU).

  • scope: settings, search
  • type: array of strings
  • default: []

List of attributes on which you want to disable the computation of exact criteria (must be a subset of the attributesToIndex index setting).

  • scope: settings, search
  • type: string
  • default: attribute

This parameter control how the exact ranking criterion is computed when the query contains one word. There is three different values:

  • none: no exact on single word query
  • word: exact set to 1 if the query word is found in the record. The query word needs to have at least 3 chars and not be part of our stop words dictionary
  • attribute (default): exact set to 1 if there is an attribute containing a string equals to the query
  • scope: settings, search
  • type: string
  • default: ['ignorePlurals', 'singleWordSynonym']

Specify the list of approximation that should be considered as an exact match in the ranking formula:

  • ignorePlurals: alternative words added by the ignorePlurals feature
  • singleWordSynonym: single-word synonym (For example "NY" = "NYC")
  • multiWordsSynonym: multiple-words synonym (For example "NY" = "New York")
  • scope: settings
  • type: string
  • default: null

The name of the attribute used for the Distinct feature.

This feature is similar to the SQL "distinct" keyword. When enabled in queries with the distinct=1 parameter, all hits containing a duplicate value for this attribute are removed from the results.

For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the first one is kept and the others are removed from the results.

To get a full understanding of how Distinct works, you can have a look at our guide on distinct.

  • scope: settings, search
  • type: integer
  • default: 0

If set to 1, enables the distinct feature, disabled by default, if the attributeForDistinct index setting is set.

This feature is similar to the SQL "distinct" keyword. When enabled in a query with the distinct=1 parameter, all hits containing a duplicate value for the attributeForDistinct attribute are removed from results.

For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and the others are removed.

To get a full understanding of how Distinct works, you can have a look at our guide on distinct.

  • scope: search
  • type: boolean
  • default: false

If set to true, the result hits will contain ranking information in the _rankingInfo attribute.

  • scope: settings
  • type: array of strings
  • default: ``

All numerical attributes are automatically indexed as numerical filters (allowing filtering operations like < and <=). If you don't need filtering on some of your numerical attributes, you can specify this list to speed up the indexing.
If you only need to filter on a numeric value with the operator '=', you can speed up the indexing by specifying the attribute with equalOnly(AttributeName). The other operators will be disabled.

  • scope: settings
  • type: boolean
  • default: false

Allows compression of big integer arrays.

In data-intensive use-cases, we recommended enabling this feature and then storing the list of user IDs or rights as an integer array. When enabled, the integer array is reordered to reach a better compression ratio.

  • scope: search
  • type: array of strings
  • default: []

This parameter is deprecated. Please use filters instead.

A string that contains the comma separated list of numeric filters you want to apply. The filter syntax is attributeName followed by operand followed by value. Supported operands are <, <=, =, > and >=.

You can easily perform range queries via the : operator. This is equivalent to combining a >= and <= operand.

For example, numericFilters=price:10 to 1000.

You can also mix OR and AND operators. The OR operator is defined with a parenthesis syntax.

For example, (code=1 AND (price:[0-100] OR price:[1000-2000])) translates to encodeURIComponent("code=1,(price:0 to 100,price:1000 to 2000)").

You can also use a string array encoding (for example numericFilters: ["price>100","price<1000"]).

  • scope: search
  • type: string
  • default: ""

This parameter is deprecated. Please use filters instead.

Filter the query by a set of tags.

You can AND tags by separating them with commas. To OR tags, you must add parentheses.

For example, tagFilters=tag1,(tag2,tag3) means tag1 AND (tag2 OR tag3).

You can also use a string array encoding.

For example, tagFilters: ["tag1",["tag2","tag3"]] means tag1 AND (tag2 OR tag3).

Negations are supported via the - operator, prefixing the value.

For example: tagFilters=tag1,-tag2.

At indexing, tags should be added in the _tags attribute of objects.

For example {"_tags":["tag1","tag2"]}.

  • scope: search
  • type: string
  • default: ""

This parameter is deprecated. Please use filters instead.

Filter the query with a list of facets. Facets are separated by commas and is encoded as attributeName:value. To OR facets, you must add parentheses.

For example: facetFilters=(category:Book,category:Movie),author:John%20Doe.

You can also use a string array encoding.

For example, [["category:Book","category:Movie"],"author:John%20Doe"].

  • scope: search
  • type: boolean
  • default: true

If set to false, this query will not be taken into account in the analytics feature.

  • scope: settings
  • type: hash of array of words
  • default: ``

This is an advanced use-case to define a token substitutable by a list of words without having the original token searchable.

It is defined by a hash associating placeholders to lists of substitutable words.

For example, "placeholders": { "<streetnumber>": ["1", "2", "3", ..., "9999"]} would allow it to be able to match all street numbers. We use the < > tag syntax to define placeholders in an attribute.

For example:

  • Push a record with the placeholder: { "name" : "Apple Store", "address" : "&lt;streetnumber&gt; Opera street, Paris" }.
  • Configure the placeholder in your index settings: "placeholders": { "<streetnumber>" : ["1", "2", "3", "4", "5", ... ], ... }.
  • scope: settings
  • type: array of objects
  • default: []

Specify alternative corrections that you want to consider.

Each alternative correction is described by an object containing three attributes:

  • word: The word to correct.
  • correction: The corrected word.
  • nbTypos The number of typos (1 or 2) that will be considered for the ranking algorithm (1 typo is better than 2 typos).

For example:

"altCorrections": [ { "word" : "foot", "correction": "feet", "nbTypos": 1 }, { "word": "feet", "correction": "foot", "nbTypos": 1 } ].

To create an index, you need to perform any indexing operation like:

  • set settings
  • add object

You can list all your indices along with their associated information (number of entries, disk size, etc.) with the listIndexes method:

client.listIndexes(function(err, content) {
  console.log(content);
});

You can delete an index using its name:

client.deleteIndex('contacts', function(error) {
  if (!err) {
    console.log('success');
  }
});

You can delete the index contents without removing settings and index specific API keys by using the clearIndex command:

index.clearIndex(function(err, content) {
  console.log(content);
});

You can easily copy or rename an existing index using the copy and move commands. Note: Move and copy commands overwrite the destination index.

// Rename MyIndex in MyIndexNewName 
client.moveIndex('MyIndex', 'MyIndexNewName', function(err, content) {
  console.log(content);
});
 
// Copy MyIndex in MyIndexCopy 
client.copyIndex('MyIndex', 'MyIndexCopy', function(err, content) {
  console.log(content);
});

The move command is particularly useful if you want to update a big index atomically from one version to another. For example, if you recreate your index MyIndex each night from a database by batch, you only need to:

  1. Import your database into a new index using batches. Let's call this new index MyNewIndex.
  2. Rename MyNewIndex to MyIndex using the move command. This will automatically override the old index and new queries will be served on the new one.
// Rename MyNewIndex in MyIndex (and overwrite it) 
client.moveIndex('MyNewIndex', 'My