algoliasearch

The perfect starting point to integrate Algolia within your Python project

Documentation • Django • Community Forum • Stack Overflow • Report a bug • Support

✨ Features

Thin & minimal low-level HTTP client to interact with Algolia's API
Supports Python from 3.8

💡 Getting Started

First, install Algolia Python API Client via the pip package manager:

pip install --upgrade 'algoliasearch>=4.0,<5.0'

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

from algoliasearch.search.client import SearchClient

_client = SearchClient("YOUR_APP_ID", "YOUR_API_KEY")

# Add a new record to your Algolia index
response = await _client.save_object(
    index_name="<YOUR_INDEX_NAME>",
    body={
        "objectID": "id",
        "test": "val",
    },
)

# use the class directly
print(response)

# print the JSON response
print(response.to_json())

# Poll the task status to know when it has been indexed
await client.wait_for_task(index_name="<YOUR_INDEX_NAME>", task_id=response.task_id)

# Fetch search results, with typo tolerance
response = await _client.search(
    search_method_params={
        "requests": [
            {
                "indexName": "<YOUR_INDEX_NAME>",
                "query": "<YOUR_QUERY>",
                "hitsPerPage": 50,
            },
        ],
    },
)

# use the class directly
print(response)

# print the JSON response
print(response.to_json())

For full documentation, visit the Algolia Python 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

Contributing

This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.

📄 License

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

Release files for algoliasearch 4.47.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for algoliasearch 4.47.0
File	Size	Uploaded
algoliasearch-4.47.0.tar.gz	472.1 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for algoliasearch 4.47.0
File	Interpreter	ABI	Platform	Reset
algoliasearch-4.47.0-py3-none-any.whl 1.3 MB Sep 9, 2026	Python 3	none	any	Details

Total release size: 1.8 MB

Release files / algoliasearch-4.47.0.tar.gz

Download URL	algoliasearch-4.47.0.tar.gz
Size	472.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`d83a83aa120237236adb1e20746d53bdd96fcde5f6ae4a36542d4f17dced96e9`
BLAKE2b-256 checksum How to use checksums	`bdd094b4c0fa53ed1f619f05d05b1fcf55f0f7031db2276950b4f54aab676157`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/algolia/algoliasearch-client-python
Publishing commit: github.com/algolia/algoliasearch-client-python/tree/6dbbd56cabd1082e554b3d6973236c1447683a96

Workflow

Publishing configuration: github.com/algolia/algoliasearch-client-python/blob/6dbbd56cabd1082e554b3d6973236c1447683a96/.github/workflows/release.yml
Publishing logs: github.com/algolia/algoliasearch-client-python/actions/runs/34370071041/attempts/1

Artifact

Subject: algoliasearch-4.47.0.tar.gz
SHA-256 checksum: d83a83aa120237236adb1e20746d53bdd96fcde5f6ae4a36542d4f17dced96e9 Verifying attestations

Release files / algoliasearch-4.47.0-py3-none-any.whl

Download URL	algoliasearch-4.47.0-py3-none-any.whl
Size	1.3 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`afae7817de8fd63c56d93b94504ac0e417ef0edf3faea7b718036d00ff907e88`
BLAKE2b-256 checksum How to use checksums	`a7c82b23f2465743c63c1d086d204b1d2a78b16443ae0ee5eaf84f6561212ae7`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/algolia/algoliasearch-client-python
Publishing commit: github.com/algolia/algoliasearch-client-python/tree/6dbbd56cabd1082e554b3d6973236c1447683a96

Workflow

Publishing configuration: github.com/algolia/algoliasearch-client-python/blob/6dbbd56cabd1082e554b3d6973236c1447683a96/.github/workflows/release.yml
Publishing logs: github.com/algolia/algoliasearch-client-python/actions/runs/34370071041/attempts/1

Artifact

Subject: algoliasearch-4.47.0-py3-none-any.whl
SHA-256 checksum: afae7817de8fd63c56d93b94504ac0e417ef0edf3faea7b718036d00ff907e88 Verifying attestations