algoliasearch

Algolia Search API Client

npm install algoliasearch
34 downloads in the last day
51 downloads in the last week
74 downloads in the last month

Algolia Search API Client for JavaScript

This Javascript client let you easily use the Algolia Search API in a browser, it is compatible with most browsers:

  • Internet Explorer ≥ 8
  • Firefox ≥ 3.5
  • Google Chrome ≥ 3
  • Safari ≥ 4
  • Opera ≥ 12
  • Opera mobile ≥ 12
  • etc.

See this wikipedia page to have more details on supported browsers (we use XDomainRequest for IE8 and IE9).

Algolia Search is a search API that provides hosted full-text, numerical and faceted search. Algolia’s Search API makes it easy to deliver a great search experience in your apps & websites providing:

  • REST and JSON-based API
  • search among infinite attributes from a single searchbox
  • instant-search after each keystroke
  • relevance & popularity combination
  • typo-tolerance in any language
  • faceting
  • 99.99% SLA
  • first-class data security

Build Status NPM version

Table of Content

Get started

  1. Setup
  2. Quick Start
  3. General Principle
  4. Online documentation

Commands reference

  1. Search
  2. Multi-queries
  3. Security

Setup

To setup your project, follow these steps:

  1. Download the client and add a script include of algoliasearch.min.js
  2. Initialize the client with your ApplicationID and API-Key. You can find all of them on your Algolia account.
  3. When you use this API client for search on a website, we strongly recommand to use a key with an ACL restricted to "search". You can retrieve one with client.addUserKey(["search"]).
  <script src="algoliasearch.min.js"></script>
  <script>
    client = new AlgoliaSearch('ApplicationID', 'API-Key');
    ...

Using Algoliasearch with jsDelivr:

jsDelivr can offer a performance benefit by hosting algoliasearch on servers spread across the globe. This also offers an advantage that if the visitor to your webpage has already downloaded a copy of algoliasearch from jsDelivr, it won't have to be re-downloaded.

  <script src="//cdn.jsdelivr.net/algoliasearch/{VERSION}/algoliasearch.min.js"></script>

Quick Start

First, index some data. For example, you can use the command line client quick start to index the 500 contacts sample.

You can then update the example/autocomplete.html file with your ApplicationID, API-Key and index name to test the autocomplete feature.

You can also update the example/instantsearch.html file with your ApplicationID, API-Key and index name to test an instant-search example.

General Principle

All API calls will return the result in a callback that takes two arguments:

  1. success: a boolean that is set to false when an error was found.
  2. content: the object containing the answer (if an error was found, you can retrieve the error message in content.message)

Online Documentation

Check our online documentation:

Update the index

The javascript client is dedicated to web apps searching directly from the browser. In some use-cases, it can however be interesting to perform updates to the index directly in javascript, for example in an HTML5 mobile app. Therefore, just as for other languages, the javascript client is able to add, update or delete objects, or to modify index settings.

For more details about updating an index from javascript, have a look at the algoliasearch.js source file to see details about each function.

Note: If you use the javascript client to update the index, you need to specify https as the protocol in the client initialization:

  <script src="algoliasearch.min.js"></script>
  <script>
    client = new AlgoliaSearch('ApplicationID', 'API-Key', 'https');
    ...

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

You can use the following optional arguments:

Query parameters

Full Text Search parameters

  • query: (string) The instant-search query string, all words of the query are interpreted as prefixes (for example "John Mc" will match "John Mccamey" and "Johnathan Mccamey"). If no query parameter is set, retrieves all objects.
  • queryType: select how the query words are interpreted, it can be one of the following value:
    • prefixAll: all query words are interpreted as prefixes,
    • 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.
  • optionalWords: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated.
  • minWordSizefor1Typo: the minimum number of characters in a query word to accept one typo in this word.
    Defaults to 3.
  • minWordSizefor2Typos: the minimum number of characters in a query word to accept two typos in this word.
    Defaults to 7.
  • advancedSyntax: Enable the advanced query syntax. Defaults to 0 (false).
    • Phrase query: a phrase query defines a particular sequence of terms. A phrase query is build 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.

Pagination parameters

  • page: (integer) 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
  • hitsPerPage: (integer) Pagination parameter used to select the number of hits per page. Defaults to 20.

Geo-search parameters

  • aroundLatLng: search for entries around a given latitude/longitude (specified as two floats separated by a comma).
    For example aroundLatLng=47.316669,5.016670).
    You can specify the maximum distance in meters with the aroundRadius parameter (in meters) and the precision for ranking with aroundPrecision (for example if you set aroundPrecision=100, two objects that are distant of less than 100m will be considered as identical for "geo" ranking parameter).
    At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}})
  • insideBoundingBox: 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}})

Parameters to control results content

  • attributesToRetrieve: a string that contains the list of object attributes you want to retrieve (let you minimize the answer size).
    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.
  • attributesToHighlight: a string that contains the list of attributes you want to highlight according to the query. Attributes are separated by a comma. 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 text attributes are highlighted. You can use * if you want to highlight all textual attributes. Numerical attributes are not highlighted. 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.
  • attributesToSnippet: a string that contains the list of attributes to snippet alongside the number of words to return (syntax is attributeName:nbWords). Attributes are separated by a comma (Example: attributesToSnippet=name:10,content:10).
    You can also use a string array encoding (Example: attributesToSnippet: ["name:10","content:10"]). By default no snippet is computed.
  • getRankingInfo: if set to 1, the result hits will contain ranking information in _rankingInfo attribute.

Numeric search parameters

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

You can easily perform range queries via the : operator (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 in encodeURIComponent("code=1,(price:0 to 10,price:1000 to 2000)").

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

Category search parameters

  • tagFilters: filter the query by a set of tags. You can AND tags by separating them by commas. To OR tags, you must add parentheses. For example, tags=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).
    At indexing, tags should be added in the _tags attribute of objects (for example {"_tags":["tag1","tag2"]}).

Faceting parameters

  • facetFilters: filter the query by a list of facets. Facets are separated by commas and each facet 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"]).
  • facets: List of object attributes that you want to use for faceting.
    Attributes are separated with a comma (for example "category,author" ). You can also use a JSON string array encoding (for example ["category","author"] ). 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.
  • maxValuesPerFacet: Limit the number of facet values returned for each facet. For example: maxValuesPerFacet=10 will retrieve max 10 values per facet.

Distinct parameter

  • distinct: If set to 1, enable 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 others are removed.
index = client.initIndex('contacts');
index.search('query string', function(success, content) {
    for (var h in content.hits) {
        console.log('Hit(' + content.hits[h].objectID + '): ' + content.hits[h].toString());
    }
});

index.search('query string', function(success, content) {
    for (var h in content.hits) {
        console.log('Hit(' + content.hits[h].objectID + '): ' + content.hits[h].toString());
    }
}, {'attributesToRetrieve': 'firstname,lastname', 'hitsPerPage': 50});

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"
}

Multi-queries

You can send multiple queries with a single API call using a batch of queries:

// perform 3 queries in a single API call:
//  - 1st query targets index `categories`
//  - 2nd and 3rd queries target index `products`
client.startQueriesBatch();
client.addQueryInBatch('categories', $('#q').val(), { hitsPerPage: 3 });
client.addQueryInBatch('products', $('#q').val(), { hitsPerPage: 3, tagFilters: 'promotion' });
client.addQueryInBatch('products', $('#q').val(), { hitsPerPage: 10 });
client.sendQueriesBatch(searchMultiCallback);

function searchMultiCallback(success, content) {
  if (success) {
    var categories = content.results[0];
    for (var i = 0; i < categories.hits.length; ++i) {
      console.log(categories.hits[i]);
    }

    var products_promotion = content.results[1];
    for (var i = 0; i < products_promotion.hits.length; ++i) {
      console.log(products_promotion.hits[i]);
    }

    var products = content.results[2];
    for (var i = 0; i < products.hits.length; ++i) {
      console.log(products.hits[i]);
    }
  }
}

Security

If you're using a secured API key (see backend client documentation), you need to set the associated tags:

var algolia = new AlgoliaSearch('YourApplicationID', 'YourPublicSecuredAPIKey');
algolia.setSecurityTags('(public,user_42)'); // must be same than those used at generation-time

If you've specified a userToken while generating your secured API key, you must also specified it at query-time:

var algolia = new AlgoliaSearch('YourApplicationID', 'YourPublicSecuredAPIKey');
algolia.setSecurityTags('(public,user_42)'); // must be same than those used at generation-time
algolia.setUserToken('user_42')              // must be same than the one used at generation-time
npm loves you