Search API client

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

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.

Indices

Algolia automatically creates a new index when you add records, rules, or synonyms, or when you change settings for an index that doesn’t yet exist. You don’t need to create indices explicitly.

Don’t include sensitive or personally identifiable information (PII) in your index names. They appear in network requests and are publicly visible.

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.

Search

Records

Indices

Synonyms

API keys

Rules

Dictionaries

Clusters

Vaults

Advanced