Python Aternos

An unofficial Aternos API written in Python.
It uses aternos' private API and html parsing.

WARNING !

Development has been resumed, but it's possible that the module contains functions/classes that don't work at the moment. However, you can still manage your server with peace of mind (start, too much, restart...).

Python Aternos supports:

• Logging in to account with password (plain or hashed) or ATERNOS_SESSION cookie value
• Saving session to the file and restoring
• Changing username, email and password
• Parsing Minecraft servers list
• Parsing server info by its ID
• Starting/stoping server, restarting, confirming/cancelling launch
• Updating server info in real-time (see WebSocket API) NOT IMPLEMENTED
• Changing server subdomain and MOTD (message-of-the-day)
• Managing files, settings, players (whitelist, operators, etc.)

Install

Common

$ pip install py-aternos

Note for Windows users

Install lxml package from here if you have problems with it, and then execute:
pip install --no-deps py-aternos

Development

$ git clone https://github.com/BOXERRMD/py-aternos.git
$ cd py-aternos
$ pip install -e .[dev]

Usage

To use Aternos API in your Python script, import it and login with your username and password or its MD5 hash.

Then request the servers list using list_servers().
You can start/stop your Aternos server, calling start() or stop().

Here is an example how to use the API:

# Import
from python_aternos import Client

# Create object
atclient = Client()

# Log in
# with username and password
atclient.login('example', 'test123')
# ----OR----
# with username and MD5 hashed password
atclient.login_hashed('example', 'cc03e747a6afbbcbf8be7668acfebee5')
# ----OR----
# with session cookie
atclient.login_with_session('ATERNOS_SESSION cookie value')

# Get AternosAccount object
aternos = atclient.account

# Get servers list
servs = aternos.list_servers()

# Get the first server
myserv = servs[0]

# Start
myserv.start()
# Stop
myserv.stop()

# You can also find server by IP
testserv = None
for serv in servs:
    if serv.address == 'test.aternos.org':
        testserv = serv

if testserv is not None:
    # Prints the server software and its version
    # (for example, "Vanilla 1.12.2")
    print(testserv.software, testserv.version)
    # Starts server
    testserv.start()

More examples

Documentation

How-To Guide

Changelog

Reversed API Specification

Private Aternos API requests were captured into this HAR file and were imported to a Postman Workspace.
You can use both resources to explore the API.
Any help with improving this library is welcome.

License

License Notice:

Copyright 2021-2022 All contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Thank to Darkcat09 for allowing me to continue maintaining this API