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.48.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| algoliasearch-4.48.0.tar.gz | 502.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| algoliasearch-4.48.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.9 MB
Release files / algoliasearch-4.48.0.tar.gz
| Download URL | algoliasearch-4.48.0.tar.gz |
|---|---|
| Size | 502.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0dd4ed4cee8b72795d8eba1340df0bec4e35fcb73222a62d927359e6c4aaeaa6
|
|
BLAKE2b-256 checksum How to use checksums |
38e33424314baabea099a46b60fc0c5eb79e68a74fc7b3788cec1b732659ec0b
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency logRelease files / algoliasearch-4.48.0-py3-none-any.whl
| Download URL | algoliasearch-4.48.0-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b230d8b6d0a03b9cc222812bf06b5ecc517a24a89f4850b629bda55bf35d338e
|
|
BLAKE2b-256 checksum How to use checksums |
c4618337b2adac96d5936e7b0f1b92925ce5e62d5160a0c96a9168a388bd6762
|
| Upload date | |
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency log
