Skip to main content

Algolia for Python

The perfect starting point to integrate Algolia within your Python project

PyPI Python versions License

DocumentationDjangoCommunity ForumStack OverflowReport a bugSupport

✨ 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

algoliasearch-4.45.0.tar.gz (469.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algoliasearch-4.45.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file algoliasearch-4.45.0.tar.gz.

File metadata

  • Download URL: algoliasearch-4.45.0.tar.gz
  • Upload date:
  • Size: 469.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for algoliasearch-4.45.0.tar.gz
Algorithm Hash digest
SHA256 01c70e59b21b1cd3e9e255cca928c7563babde95f71de175fd540ef806847d36
MD5 fc0a40f44eac20d892a2c5b507a9e9a6
BLAKE2b-256 1b1693f98d70e587af46dbd715be116eeab4e5e2be3df1391e177269c589b7b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for algoliasearch-4.45.0.tar.gz:

Publisher: release.yml on algolia/algoliasearch-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file algoliasearch-4.45.0-py3-none-any.whl.

File metadata

  • Download URL: algoliasearch-4.45.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for algoliasearch-4.45.0-py3-none-any.whl
Algorithm Hash digest
SHA256 adb407fd7dccf30de7be356f86bd60fb3cf96381341e7df53e1993e941809b79
MD5 0c9b97b91bc660d5b7284d0c3e10987a
BLAKE2b-256 7efda5fc99681de45fe8f812b56b59c6594ba5d7c2f10eac49c3b05f4aa716a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for algoliasearch-4.45.0-py3-none-any.whl:

Publisher: release.yml on algolia/algoliasearch-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.45.0 This release

2 files

4.44.4

2 files

4.44.3

2 files

4.44.1

2 files

4.44.0

2 files

4.43.0

2 files

4.42.0

2 files

4.41.1

2 files

4.40.1

2 files

4.40.0

2 files

4.39.0

2 files

4.38.1

2 files

4.38.0

2 files

4.37.1

2 files

4.37.0

2 files

4.36.1

2 files

4.36.0

2 files

4.35.4

2 files

4.35.3

2 files

4.35.2

2 files

4.35.0

2 files

4.34.0

2 files

4.33.0

2 files

4.32.0

2 files

4.31.0

2 files

4.30.0

2 files

4.29.0

2 files

4.28.0

2 files

4.27.0

2 files

4.26.0

2 files

4.25.0

2 files

4.24.0

2 files

4.23.1

2 files

4.23.0

2 files

4.22.1

2 files

4.22.0

2 files

4.21.0

2 files

4.20.0

2 files

4.19.0

2 files

4.18.0

2 files

4.17.0

2 files

4.16.5

2 files

4.16.4

2 files

4.16.3

2 files

4.16.2

2 files

4.16.1

2 files

4.16.0

2 files

4.15.0

2 files

4.14.0

2 files

4.13.3

2 files

4.13.2

2 files

4.13.1

2 files

4.13.0

2 files

4.12.0

2 files

4.11.2

2 files

4.11.1

2 files

4.11.0

2 files

4.10.0

2 files

4.9.2

2 files

4.9.1

2 files

4.9.0

2 files

4.8.1

2 files

4.8.0

2 files

4.7.0

2 files

4.6.5

2 files

4.6.4

2 files

4.6.3

2 files

4.6.2

2 files

4.6.1

2 files

4.6.0

2 files

4.5.0

2 files

4.4.6

2 files

4.4.5

2 files

4.4.4

2 files

4.4.3

2 files

4.4.2

2 files

4.4.1

2 files

4.4.0

2 files

4.3.0

2 files

4.2.4

2 files

4.2.3

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.1

2 files

4.1.0

2 files

4.0.2

2 files

4.0.0

2 files

3.0.0

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.0

2 files

2.4.0

2 files

2.3.1

2 files

2.3.0

2 files

2.2.0

2 files

2.1.0

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.20.0

2 files

1.19.1

2 files

1.19.0

2 files

1.18.1

2 files

1.18.0

2 files

1.17.0

2 files

1.16.0

2 files

1.15.3

2 files

1.15.2

2 files

1.15.0

2 files

1.14.1

2 files

1.14.0

2 files

1.13.0

2 files

1.12.0

2 files

1.11.3

2 files

1.11.2

2 files

1.11.0

2 files

1.10.0

2 files

1.9.2

2 files

1.9.1

2 files

1.9.0

2 files

1.8.0

2 files

1.7.1

1 file

1.7.0

1 file

1.6.8

1 file

1.6.7

1 file

1.6.6

2 files

1.6.5

1 file

1.6.4

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

1.5.9

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.3.11

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.14

2 files

1.2.13

2 files

1.2.12

2 files

1.2.11

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page