The Search API client is part of the algoliasearch package. You can install this package with pip:

1
pip install 'algoliasearch>=4,<5'

To use the Search client, add this import to your files:

1
from algoliasearch.search.client import SearchClientSync

To create an instance of the client:

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

Async code

To use the Search client in async environments, add these imports instead:

1
2
import asyncio
from algoliasearch.search.client import SearchClient

The client supports the async with statement to automatically close open connections.

1
2
3
async def run():
    async with SearchClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

List of methods

Each method makes one request to the Search API. The Search API client also includes helper methods that wrap one or more of these methods. For more information, see Helper methods.

Records

Indices

Synonyms

API keys

Rules

Dictionaries

Clusters

Vaults

Advanced

Did you find this page helpful?
Python API clients v4