Search an index

Searches a single index and returns matching search results (hits).

This method lets you retrieve up to 1,000 hits. If you need more, use the browse operation or increase the paginatedLimitedTo index setting.

Usage

Required ACL: search
1
2
3
4
5
6
7
8
9
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'myQuery', facetFilters: ['tags:algolia'] },
});
Did you find this page helpful?
JavaScript API clients v5