Skip to content

algolia/algoliasearch-client-javascript

Folders and files

NameName
Last commit message
Last commit date
Feb 24, 2025
Mar 3, 2025
Mar 19, 2025
Nov 20, 2024
Aug 28, 2024
Oct 24, 2023
Mar 21, 2022
Mar 3, 2025
Mar 3, 2025
Mar 11, 2025
Aug 28, 2024
Mar 11, 2025
Dec 16, 2024
Oct 8, 2024
Oct 8, 2024
Mar 17, 2025
Oct 23, 2024
Mar 17, 2025

Repository files navigation

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

✨ Features

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

💡 Getting Started

To get started, you first need to install algoliasearch (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments.

With a package manager

yarn add [email protected]
# or
npm install [email protected]
# or
pnpm add [email protected]

Without a package manager

Add the following JavaScript snippet to the of your website:

// for the full client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/algoliasearch.umd.js"></script>

// for the lite client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lite/builds/browser.umd.js"></script>

Usage

You can now import the Algolia API client in your project and play with it.

import { algoliasearch } from 'algoliasearch';

const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY');

// or with the lite client
import { liteClient } from 'algoliasearch/lite';

const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');

For full documentation, visit the Algolia JavaScript API Client.

❓ 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. You can also open a GitHub issue

📄 License

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