Python SDK (noxaeapi-sdk)

pip install noxaeapi-sdk

# with realtime console/event socket support:
pip install "noxaeapi-sdk[ws]"

from noxaeapi_sdk import NoxAeApiClient

client = NoxAeApiClient(base_url="http://localhost:8080", api_key="your-api-key")

# Access any of the 12 core modules
players = client.players.list()
balance = client.economy.get_balance(players[0]["uuid"])
client.server.broadcast("Hello from the Python SDK!")

from noxaeapi_sdk import NoxAeApiClient

# Reads NOXAEAPI_BASE_URL and NOXAEAPI_KEY from os.environ.
# If you keep those in a .env file, load it yourself first (e.g. with
# python-dotenv) — the SDK never reads .env files or os.environ implicitly
# outside this method.

# 1. Standard environment variable loading
client = NoxAeApiClient.from_env()

# 2. Or override individual fields while still falling back to env vars
client = NoxAeApiClient.from_env(timeout=15.0)

from noxaeapi_sdk import NoxAeApiClient

client = NoxAeApiClient.from_env()

# 1. Connect to live console output stream (authenticates via ?key= query parameter)
console_socket = client.connect(route="console")

console_socket.on("open", lambda _: print("Connected to console stream"))
console_socket.on("console", lambda line: print("[Minecraft Console]", line))
console_socket.on("error", lambda err: print("WebSocket error:", err))
console_socket.on("close", lambda _: print("Console connection closed"))

# 2. Connect to live game events (joins, quits, deaths, kicks, bans, chat)
events_socket = client.connect(route="events")

def on_event(evt):
    print("Live Event:", evt.get("event"), "Player:", (evt.get("player") or {}).get("name"))

events_socket.on("event", on_event)

# Sockets run on a background thread and include automatic reconnect
# with exponential backoff.

from noxaeapi_sdk import (
    NoxAeApiForbiddenError,
    NoxAeApiNotFoundError,
    NoxAeApiRateLimitError,
)

try:
    client.server.restart()
except NoxAeApiForbiddenError:
    print("This API key isn't allowed to restart the server.")
except NoxAeApiNotFoundError:
    print("The requested resource was not found.")
except NoxAeApiRateLimitError:
    print("Rate limit hit, consider lowering request frequency.")

from noxaeapi_sdk import NoxAeApiClient, RetryOptions

client = NoxAeApiClient(
    base_url="https://mc.example.com",
    api_key="...",
    timeout=10.0,               # per-request timeout in seconds, default 10
    retry=RetryOptions(
        attempts=3,              # total attempts including the first, default 3
        base_delay_ms=300,
        max_delay_ms=5000,
    ),
    # retry=False,               # disable retries entirely
    headers={"X-Extra": "..."},
)