AMP API Python

The project can be found on PyPi.

Key Features

  • Pythonic API wrapper using async and await.

  • Data is in dataclasses for easier management and interaction.

    • Optional parameter per function or global to disable formatting of data.

  • Parent classes ADSInstance and AMPInstance to group endpoints together and make handling of multiple Instances easier.

    • This will also limit Instance specific API endpoints (eg. Minecraft) to that Instance type only.

Installing

Note

Python 3.10 or higher is required

To install run the below command in a Terminal.

1# Linux/macOS/Windows
2pip install cc-ampapi

Basic Usage

  1. First you need to fill out the APIParams class with the required fields (url, user and password).

  2. Pass the APIParams class into the Bridge class parameter api_params.

    • You only need to make __ONE__ Bridge class; the rest of the API classes will get the same object and handle logging in for you.

  3. You can then use the Parent AMPADSInstance or the smaller class AMPInstance or any of the API classes as a stand alone.

API Classes:

AMP Instance Classes:

Types:

Docs: