python_small_white Created with Sketch.

Getting Started

Install

Install AlgoliaSearch using pip:

pip install --upgrade algoliasearch

Miscellaneous

We implemented an asynchronous version of the client that may suit your need if you are using a framework such as aiohttp in your backend. This version can be found here.

Init Index

To begin, you will need to initialize the client. In order to do this you will need your Application ID and API Key. You can find both on your Algolia account.

from algoliasearch import algoliasearch

client = algoliasearch.Client("YourApplicationID", 'YourAPIKey')
index = client.init_index('your_index_name')

If you use this API Client with Google AppEngine (Thanks @apassant), it will use urlfetch instead of using the request module. Please be aware of urlfetch’s limits, and note that SSL certificates will not be verified for calls to domains other than algolia.net due to the lack of SNI support in urlfetch. To run unit tests on the AppEngine stub, please define an APPENGINE_RUNTIME enviroment variable.

You need to replace your_index_name by the name of the index you want to use. If you want to target an existing index you can find the name from the dashboard. If the index does not exist you can choose any name and it will be created when you perform an add objects or a set settings operation.

If an api key is displayed in the previous snippet it is your ADMIN API Key. To maintain security, never use your ADMIN API Key on your frontend or share it with anyone. In your frontend, use the SEARCH ONLY API Key or any other key that has search only rights.

Unreachable hosts

If you are seeing an error for Unreachable hosts when pushing data to Algolia, this is caused by PyOpenSSL and older versions of Python. You can see more information here.

To fix, either upgrade your Python version or your urllib3.