Arkindex API Client

The python module arkindex-client provides an API client to interact easily with Arkindex instances.

Setup

You can install the latest stable version of the client by using our official Python package:

pip install arkindex-client

Usage

To know more about how to use this library, please read the Usage documentation.

API Reference

You can find the current Arkindex API reference on our main instance. Each of the endpoints described there is available through this API client.

If you own or use a private Arkindex instance, open the page at https://ARKINDEX_IP/api-docs/ to view your own API documentation, which can vary between versions of Arkindex.