You're viewing an archived version of our docs. Check out our current documentation →

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
from algoliasearch.search.client import SearchClientSync
from json import loads

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.search_single_index(
    index_name="ALGOLIA_INDEX_NAME",
)
Python API clients v4