NoxAeApi
REST API for Minecraft Servers

Control your Minecraft server over HTTP

NoxAeApi exposes players, economy, permissions, worlds, plugins, chat, and administration as a clean, versioned REST API — readable by humans and AI agents alike.

Get StartedAPI Reference
  • Player Management
  • Economy
  • LuckPerms
  • Worlds
  • Plugins
  • Chat
  • Multi-Server Network
Your first request
curl https://mc.example.com/v1/ping \
  -H "key: YOUR_API_KEY"

# → "pong!"

One API for the entire server

Modular by design — endpoints activate automatically when their dependency plugin is installed.

Player Management

Ban, kick, teleport, change gamemode, and read live stats for online and offline players.

Economy

Read balances, deposit, debit, and pull leaderboards via any Vault-compatible economy plugin.

LuckPerms

Manage groups, inspect nodes, and resolve permissions with inheritance and wildcards.

Worlds

Inspect worlds, set time and weather, save on demand, and download world archives.

Plugins

List, install, enable, and disable plugins remotely from a single endpoint.

Chat

Broadcast server-wide announcements or whisper directly to a single player.

Multi-Server Network

Aggregate health, players, and status across an entire proxied server network.

Server Control

Run console commands, tail logs, manage whitelist and ops, restart the server.

Official NPM Module

Ship Faster with @wumx-labs/noxaeapi-sdk

Official TypeScript & Node.js client featuring 100% type-safety, structured typed errors, automatic retries with exponential backoff, and real-time WebSocket console streaming.

Zero Dependencies

Uses native Fetch & standard WebSockets

Real-time WS

Live server console & event stream

Explore NPM Modulenpmjs.com
Terminal
npm install @wumx-labs/noxaeapi-sdk
index.ts
import { NoxAeApiClient } from "@wumx-labs/noxaeapi-sdk";

const client = new NoxAeApiClient({
  baseUrl: "https://mc.example.com",
  apiKey: process.env.NOXAEAPI_KEY,
});

// Full TypeScript autocompletion & type validation
const players = await client.players.list();
const balance = await client.economy.getBalance(players[0].uuid);
await client.server.broadcast("Hello from the SDK!");
Built for AI agents

Machine-readable out of the box

Point ChatGPT, Claude, or any agent at /llms.txt for a hand-tuned reference, or at /openapi.json for a strict OpenAPI 3.0.3 spec. Agents get authentication rules, every endpoint, shared data models, and explicit guidance on destructive actions.

View llms.txtView openapi.json
llms.txt
# NoxAeApi — AI Reference Documentation

> A REST API for Minecraft servers. Lets
> agents read and control players, economy,
> permissions, worlds, plugins, and chat.

## Authentication
Every endpoint accepts an optional `key`
header (ApiKeyAuth, in: header).

## Guidance for AI agents
- Confirm before destructive endpoints
  (ban, kick, restart, /server/exec).
- 503 means an optional plugin isn't loaded.
- Player IDs are UUIDs, not usernames.

Ready to make your first call?

Install the plugin, set your API key, and hit GET /v1/ping.

Get StartedAPI Reference