algoliasearch
Advanced tools
Package description
The algoliasearch npm package is a JavaScript client for Algolia, a hosted search API that provides a fast and accurate search experience for websites and mobile applications. The package allows developers to integrate Algolia's search capabilities into their JavaScript applications, enabling features such as full-text search, faceting, filtering, and geolocation queries.
Search
Perform a search query on an Algolia index and retrieve the results.
const algoliasearch = require('algoliasearch');
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
const index = client.initIndex('your_index_name');
index.search('query string').then(({ hits }) => {
console.log(hits);
});Indexing
Add or update a record in an Algolia index.
const algoliasearch = require('algoliasearch');
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
const index = client.initIndex('your_index_name');
index.saveObject({ objectID: '1', name: 'Foo' }).then(() => {
console.log('Object indexed');
});Configure Index Settings
Configure settings of an Algolia index to define ranking, attributes for faceting, etc.
const algoliasearch = require('algoliasearch');
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
const index = client.initIndex('your_index_name');
index.setSettings({
searchableAttributes: ['name', 'description'],
customRanking: ['desc(popularity)']
}).then(() => {
console.log('Settings updated');
});Manage Indices
List all indices in your Algolia application and manage them.
const algoliasearch = require('algoliasearch');
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
client.listIndices().then(({ items }) => {
console.log(items);
});Elasticsearch is a distributed, RESTful search and analytics engine capable of solving a growing number of use cases. The elasticsearch npm package is the official Elasticsearch client for Node.js. It provides similar search capabilities but is typically self-hosted, unlike Algolia which is a managed service.
Solr-node is a client library for interacting with Apache Solr, which is an open-source search platform. Similar to Algolia, it provides full-text search, but it requires self-hosting and manual scaling, whereas Algolia offers a fully managed service.
Typesense is an open-source, typo-tolerant search engine that provides a similar developer experience to Algolia. The typesense npm package allows you to integrate Typesense into your JavaScript applications. It is designed to be easy to use and deploy, offering an alternative to Algolia with a focus on simplicity and speed.
Readme
We recently (March 2015) released a new version (V3) of our JavaScript client, if you were using our previous version (V2), read the migration guide
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 easily use the Algolia Search API in a browser.
It is dedicated to web apps searching directly from the browser. To add, remove or delete your objects please consider using a backend API client.
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 method in the window object.
If you are using the V2 of our JavaScript client and want to upgrade, please read our migration guide.
Getting Started
Commands Reference
To setup your project, follow these steps:
npm install algoliasearch --save
We are browserifyable and webpack friendly.
bower install algoliasearch -S
jsDelivr is a global CDN delivery for JavaScript libraries.
You can always get the latest, backward compatible version by including:
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'Search-Only-API-Key');
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>
Have a look at our callback convention, read about our promises.
We provide a specific jQuery build that will use jQuery.ajax.
It can be used with callbacks or jQuery promises.
<script src="//cdn.jsdelivr.net/jquery/2.1.3/jquery.min.js"></script>
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.jquery.min.js"></script>
<script>
var client = $.algolia.Client('ApplicationID', 'Search-Only-API-Key');
var index = client.initIndex('indexName');
index.search('something', function searchDone(err, content) {
console.log(err, content)
});
</script>
We provide a specific AngularJS build that is using the $http service.
It can be used with callbacks or AngularJS promises.
<script src="//cdn.jsdelivr.net/angularjs/1.3.14/angular.min.js"></script>
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.angular.min.js"></script>
<script>
angular
.module('myapp', ['algoliasearch'])
.controller('SearchCtrl', ['$scope', 'algolia', function($scope, algolia) {
$scope.query = '';
$scope.hits = [];
var client = algolia.Client('ApplicationID', 'Search-Only-API-Key');
var index = client.initIndex('indexName');
index.search('something')
.then(function searchSuccess(content) {
console.log(content);
}, function searchFailure(err) {
console.log(err);
});
}]);
</script>
npm install algoliasearch --save
var algoliasearch = require('algoliasearch');
var client = algoliasearch('applicationID', 'Search-Only-API-Key');
var index = client.initIndex('indexName');
index.search('something', function searchDone(err, content) {
console.log(err, content);
});
We also provide runnable examples for you to try.
We have easy to run examples for you to try. First, setup the repository:
git clone https://github.com/algolia/algoliasearch-client-js.git
cd algoliasearch-client-js
npm install
npm run examples
Then open either:
To hack and use your own indexes and data, open one of the example file and replace:
var client = algoliasearch('ApplicationID', 'Search-Only-API-Key');
var index = client.initIndex(indexName);
All API calls will return the result in a callback that takes two arguments:
error.message.We follow the error-first callback.
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:
Queries will be stored in a cache inside your JavaScript Index and AlgoliaSearch objects to avoid performing the same API calls twice. It's particularly useful when your users are deleting characters or words from the current query but has a chance of ending up with outdated results if the page isn't refreshed for some time.
To address this issue, be sure to clear the cache every X minutes to ensure you have up to date results:
// clear the queries cache
index.clearCache();
// if you're performing multi-queries using the API client instead of the index
// you'll need to use the following code
client.clearCache();
Check our online documentation:
Check out our tutorials:
To perform a search, you only need to initialize the index and perform a call to the search function.
You can use the following optional arguments:
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 attributesToIndex settings are used to search.". For example, "search engine" will retrieve records having search next to engine only. Typo tolerance is disabled on phrase queries.- symbol. For example, search -engine will retrieve records containing search but not engine.page=9.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 and the precision for ranking with aroundPrecision. For example, if you set aroundPrecision=100, two objects that are a distance of less than 100 meters will be considered as identical for the "geo" ranking parameter).
At indexing, you should specify the geo location of an object with the _geoloc attribute in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}}.
aroundLatLngViaIP: Search for entries around a given latitude/longitude automatically computed from user IP address.
For example, aroundLatLng=47.316669,5.016670.
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 a distance of less than 100 meters will be considered as identical for the "geo" ranking parameter.
At indexing, you should specify the geo location 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 the geo location of an object with the _geoloc attribute in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}}.
"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.["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:attributeName:nbWords). Attributes are separated by commas (Example: attributesToSnippet=name:10,content:10). attributesToSnippet: ["name:10","content:10"]). By default, no snippet is computed.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 10,price:1000 to 2000)").
You can also use a string array encoding (for example numericFilters: ["price>100","price<1000"]).
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).{"_tags":["tag1","tag2"]}.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"]."category,author". You can also use JSON string array encoding. For example, ["category","author"]. Only the 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=10 will retrieve a maximum of 10 values per facet.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.
Note: This feature is disabled if the query string is empty and there aren't any tagFilters, facetFilters, nor numericFilters parameters.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 send multiple queries with a single API call using a batch of queries:
var client = algoliasearch('ApplicationID', 'Search-Only-API-Key');
// 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', // index name
'search in categories index', {
hitsPerPage: 3
}
);
client.addQueryInBatch(
'products',
'first search in products', {
hitsPerPage: 3,
tagFilters: 'promotion'
}
);
client.addQueryInBatch(
'products',
'another search in products', {
hitsPerPage: 10
}
);
client.sendQueriesBatch(searchMultiCallback);
function searchMultiCallback(err, content) {
if (err) {
console.error(err);
return;
}
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]);
}
}
You can easily retrieve an object using its objectID and optionally specify a comma separated list of attributes you want:
var client = algoliasearch('ApplicationID', 'Search-Only-API-Key');
var index = client.initIndex('indexName');
// Retrieves all attributes
index.getObject('myID', function searchDone(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content.objectID + ": ", content);
});
// Retrieves firstname and lastname attributes
index.getObject('myID', ['firstname', 'lastname'], function searchDone(err, content) {
if (err) {
console.error(err);
return;
}
console.log(content.objectID + ": ", content);
});
You can also retrieve a set of objects:
If you're using Per-User security keys, you need to set the associated tags:
var client = algoliasearch('ApplicationID', 'YourPublicSecuredAPIKey');
// must be the same than those used at generation-time
client.setSecurityTags('(public,user_42)');
// If you've specified a userToken while generating your secured API key, you must also specified it at query-time:
var client = algoliasearch('ApplicationID', 'YourPublicSecuredAPIKey');
// must be the same as the ones used at generation-time
client.setSecurityTags('(public,user_42)');
// must be the same as the one used at generation-time
client.setUserToken('user_42');
In some use cases, such as an HTML5 mobile application, it may be necessary to perform updates to the index directly in JavaScript.
Therefore, just like other languages, the JavaScript client is able to add, update, delete objects and modify index settings.
If you use the JavaScript client to update the index and if you are not on an https: website already, you must force the client to use https::
<script src="//cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'API-Key', {protocol: 'https:'});
</script>
FAQs
A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.
The npm package algoliasearch receives a total of 1,225,686 weekly downloads. As such, algoliasearch popularity was classified as popular.
We found that algoliasearch demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.