algoliasearch

⚡️ A fully-featured and blazing-fast JavaScript API client to interact with Algolia.

Showing:

Popularity

Downloads/wk

596K

GitHub Stars

1K

Maintenance

Last Commit

7d ago

Contributors

63

Package

Dependencies

14

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Reviews

Average Rating

4.7/57
Read All Reviews
yogeshkumar291
zek0faws
akshayknz

Top Feedback

3Performant
2Great Documentation
2Easy to Use
1Highly Customizable
1Bleeding Edge

Readme

Algolia for JavaScript

The perfect starting point to integrate Algolia within your JavaScript project

NPM version NPM downloads jsDelivr Downloads License

DocumentationInstantSearchCommunity ForumStack OverflowReport a bugFAQSupport

Migration note from v3.x to v4.x

In February 2020, we released v4 of our JavaScript client. If you are using version 3.x of the client, read the migration guide to version 4.x. Version 3.x will no longer be under active development.

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Works both on the browser and node.js
  • UMD compatible, you can use it with any module loader
  • Built with TypeScript

💡 Getting Started

First, install Algolia JavaScript API Client via the npm package manager:

npm install algoliasearch

Then, create objects on your index:

const algoliasearch = require("algoliasearch");

const client = algoliasearch("YourApplicationID", "YourAdminAPIKey");
const index = client.initIndex("your_index_name");

const objects = [
  {
    objectID: 1,
    name: "Foo"
  }
];

index
  .saveObjects(objects)
  .then(({ objectIDs }) => {
    console.log(objectIDs);
  })
  .catch(err => {
    console.log(err);
  });

Finally, let's actually search using the search method:

index
  .search("Fo")
  .then(({ hits }) => {
    console.log(hits);
  })
  .catch(err => {
    console.log(err);
  });

For full documentation, visit the online documentation.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client.

📄 License

Algolia JavaScript API Client is an open-sourced software licensed under the MIT license.

Rate & Review

Great Documentation2
Easy to Use2
Performant3
Highly Customizable1
Bleeding Edge1
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
YOGESH KUMAR26 Ratings206 Reviews
1 year ago

Algolia is a hosted, full-text, numerical, and faceted search engine. Algolia provides a powerful API and advanced result management toolset for any needs .


0
Christopher MAUGIS/France/Paris/Zek0Faws28 Ratings33 Reviews
I like new stuff.
September 16, 2020
Performant

Algolia is truly a leader in web research. Using their modules is incredibly easy. In native JS it's pretty easy to use, they even have ES6 modules that work very well


0
Akshay K NairKerala22 Ratings102 Reviews
Black Lives Matter = Terrorism #BLM
1 year ago
Performant

Great fully-featured and blazing-fast JavaScript API client to interact with Algolia. My motivation to use algolia was the excellent quality of the demo results.


0
Ryu Nishimura Tokyo, Japan4 Ratings1 Review
3 months ago
muhammedabdelhadi6 Ratings0 Reviews
9 months ago

Tutorials

No tutorials found
Add a tutorial