The perfect starting point to integrate Algolia within your Python project
Documentation • Django • Community Forum • Stack Overflow • Report a bug • Support
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports Python from
3.8
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.
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
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.
The Algolia Python API Client is an open-sourced software licensed under the MIT license.