NoxAeApi

Releases & Versioning

Changelog

Track the latest feature additions, optimizations, bug fixes, and breaking changes for both the NoxAeApi Server Plugin and the TypeScript SDK.

Plugin / REST API

Minecraft Java (Paper / Fabric)

v1.4.0

Server-side REST engine and realtime WebSocket bridge. Supports Minecraft 1.20 - 1.21.x.

Installation Guidev1

Python SDK

noxaeapi-sdk (PyPI)

v0.4.1

Official Python client package with synchronous REST operations and async WebSocket streaming.

PyPI DocumentationPyPI

TypeScript SDK

@wumx-labs/noxaeapi-sdk

v0.5.2

Typed client library with 10 core modules, automatic backoff retries, and WebSocket manager.

SDK Documentationnpm

Velocity Network Hub

NoxAeApi-Velocity

v1.3.0

Standalone push-based proxy plugin aggregating multi-server network status and players.

Hub DocumentationProxy
Filter Type:

Plugin & REST API

Changelog for the core NoxAeApi Minecraft server plugin, REST API engine, and realtime WebSocket bridges.

Latest: v1.4.0
v1.4.0Latest Release
2026-08-20

Multi-server network proxy clustering, AuraSkills offline support, realtime WebSocket channels, and world archive downloads.

Added
Multi-Server Network proxy aggregation endpoints (/v1/network/*) for Velocity and BungeeCord networks.
  • GET /v1/network/status — Network-wide node cluster status
  • GET /v1/network/health — Aggregate TPS and memory across all backend nodes
  • GET /v1/network/players — Network-wide online player count and list
  • GET /v1/network/players/{uuid} — Locate specific player target node
  • POST /v1/network/broadcast — Synchronous network-wide announcement
Added
AuraSkills support under /v1/skills/auraskills/player/{uuid} with offline player stat query support.
Added
Realtime WebSocket channels for console log streaming (/v1/ws/console) and gameplay event hooks (/v1/ws/events).
Added
World ZIP archive backup download endpoint (GET /v1/worlds/download) with non-blocking streaming compression.
Added
Native compatibility with Paper 1.21.x and Java 21 LTS virtual threads.
Changed
Optimized server performance monitor with smoothed 1m, 5m, and 15m rolling TPS metrics.
Fixed
Prevented thread deadlock during synchronous world saves during high chunk generation.
Fixed
Resolved floating-point precision issues in Vault currency balance operations.
v1.3.0
2026-06-15

mcMMO skill integration, PlaceholderAPI resolution engine, IP ban management, and richest player leaderboard.

Added
mcMMO skill levels inspection endpoint (GET /v1/skills/mcmmo/player/{uuid}).
Added
PlaceholderAPI dynamic expression resolution endpoint (POST /v1/placeholders/replace).
Added
IP ban administration endpoint (POST /v1/server/ban-ip) and whitelist CRUD management (GET/POST/DELETE /v1/server/whitelist).
Added
Top richest player balance leaderboard (GET /v1/economy/top).
Changed
Standardized authorization header to strict `key: <API_KEY>` format across all endpoints.
Fixed
Fixed LuckPerms node expiration timestamp calculation.
v1.2.0
2026-04-10

LuckPerms permission verification, scoreboard inspection, and runtime plugin toggling.

Added
LuckPerms permission checker (POST /v1/luckperms/player/{uuid}/check-permission) with recursive wildcard support.
Added
Scoreboard objectives and entry inspections (GET /v1/scoreboard).
Added
Dynamic runtime plugin enable/disable endpoints (/v1/plugins/{name}/enable, /v1/plugins/{name}/disable).
Fixed
Fixed memory retention in console buffer streams on client disconnects.
v1.1.0
2026-02-05

Vault economy balance & transactions, player teleportation, gamemode switching, and console command execution.

Added
Vault economy balance, deposit (pay), and debit endpoints.
Added
Player teleportation (/v1/players/{uuid}/teleport) and gamemode modification (/v1/players/{uuid}/gamemode).
Added
Arbitrary console command execution (POST /v1/server/exec) with timeout parameter.
v1.0.0
2025-12-01

Initial release of NoxAeApi REST server engine for Paper, Purpur, Spigot, Bukkit, and Fabric.

Added
Core player inspection, moderation (kick, ban, unban), and online player enumeration.
Added
Server health metrics, ping endpoint, and header-based authentication.

TypeScript SDK

Changelog for the official typed JavaScript/TypeScript SDK package published on npm.

npm Latest: v0.5.2
v0.5.2Latest Release
2026-09-18

Added deterministic cross-server network identity module (client.identity).

Added
New `client.identity.get(name)` method for deterministic cross-server network UUID resolution (`identityUuid`) and checking if player has ever joined this server before (`hasPlayedBefore`, `localUuid`).
v0.5.1
2026-09-12

Added pluggable unified leaderboards, ExcellentEconomy multi-currency methods, and LuckPerms context enhancements.

Added
Pluggable unified leaderboards under `client.leaderboards`: `list()`, `getTop(id, limit)`, `getPlayerProfile(uuid)`, and `getPlayerProfiles(opts)`.
Added
Multi-currency support in `client.economy`: `listCurrencies()`, `getCurrencyBalance()`, `payCurrency()`, `debitCurrency()`, `setCurrencyBalance()`, and `getCurrencyTop()`.
Added
Full LuckPerms context support (`server`, `world`, `expiry`, `priority`) across permission, meta, and track methods.
Changed
Standardized `client.players.resolve(name)` to return `Promise<PlayerResolveResult>` with `{ name, uuid }`.
v0.4.1
2026-09-05

Added player profile resolution methods resolve(), getPlayerProfile(), and getPlayerProfiles() under client.players.

Added
Player profile resolution methods under client.players: `resolve(player)`, `getPlayerProfile(player)`, and `getPlayerProfiles(players)`.
v0.4.0
2026-09-01

Added support for the new push-based NoxAeApi-Velocity network hub via NoxAeApiNetworkHubClient.

Added
Introduced `NoxAeApiNetworkHubClient` to interact with the new standalone Velocity hub.
Added
New methods under `NoxAeApiNetworkHubClient.network`: `statusAll`, `statusById`, `players`, `findPlayer`, `broadcast`, `forward`.
v0.3.0
2026-08-28

Added client.network and client.leaderboards modules, plus full multi-currency economy support.

Added
`client.network` module: `statusAll`, `statusById`, `players`, `findPlayer`, `health`, `broadcast` — wrappers for /v1/network/* proxy cluster endpoints.
Added
`client.leaderboards` module: `list`, `getTop` — generic leaderboard sources.
Added
Multi-currency economy support: `listCurrencies`, `getCurrencyBalance`, `payCurrency`, `debitCurrency`, `setCurrencyBalance`, `getCurrencyTop`.
Added
`client.economy.info()` and `client.economy.getTopBalance()`.
Breaking
`client.economy.deposit` / `client.economy.withdraw` replaced by `client.economy.pay` / `client.economy.debit`.
v0.2.0
2026-08-22

Complete implementation of all 10 modules, exponential backoff retries, typed error classes, and realtime WebSocket manager.

Added
Full coverage across all 10 core client modules: players, economy, server, worlds, plugins, advancements, placeholders, luckperms, noxauth, and skills (>40 typed public methods).
Added
Automatic exponential backoff retry mechanism with configurable `retry` options (attempts, baseDelayMs, maxDelayMs).
Added
Static factory constructor `NoxAeApiClient.fromEnv()` reading `NOXAEAPI_BASE_URL` and `NOXAEAPI_KEY` from process environment.
Added
Realtime WebSocket connection manager (`client.connect({ route: "console" | "events" })`) with auto-reconnect and event listeners.
Added
Comprehensive typed error classes: NoxAeApiUnauthorizedError, NoxAeApiForbiddenError, NoxAeApiNotFoundError, NoxAeApiRateLimitError, NoxAeApiServerError, and NoxAeApiNetworkError.
Changed
Intelligent request encoding: automatically dispatches form-urlencoded or JSON based on target endpoint expectations.
Fixed
Corrected TypeScript return types for player inventory and economy transaction objects.
v0.1.5
2026-07-02

LuckPerms permission checking, player moderation methods, and per-request timeout support.

Added
Added LuckPerms permission checking (client.luckperms.checkPermission) and group listing.
Added
Added player moderation methods (client.players.kick, client.players.ban, client.players.unban).
Added
Added per-request timeout configuration via `timeoutMs`.
Fixed
Fixed header merging when custom options are provided.
v0.1.0
2026-05-18

Initial public release of @wumx-labs/noxaeapi-sdk on npm with zero runtime dependencies.

Added
Zero runtime dependencies architecture leveraging native fetch and native WebSocket.
Added
Initial module wrappers: client.players.list, client.economy.getBalance, client.server.ping, and client.server.broadcast.

Python SDK

Changelog for the official Python client library published on PyPI (noxaeapi-sdk) with synchronous REST modules and async WebSocket streaming.

PyPI Latest: v0.4.1
v0.4.1Latest Release
2026-09-05

Added player profile resolution methods resolve(), get_player_profile(), and get_player_profiles() under client.players.

Added
Player profile resolution methods: `client.players.resolve(player)`, `client.players.get_player_profile(player)`, and `client.players.get_player_profiles(players)`.
v0.4.0
2026-09-01

Added support for Velocity standalone network hub via NoxAeApiNetworkHubClient.

Added
Introduced `NoxAeApiNetworkHubClient` for Velocity proxy network hub interactions.
Added
Methods under `NoxAeApiNetworkHubClient.network`: `status_all`, `status_by_id`, `players`, `find_player`, `broadcast`, `forward`.
v0.3.0
2026-08-28

Added client.network module, leaderboards module, and multi-currency economy operations.

Added
`client.network` proxy aggregator methods: `status_all`, `status_by_id`, `players`, `find_player`, `health`, `broadcast`.
Added
Multi-currency economy support: `list_currencies`, `get_currency_balance`, `pay_currency`, `debit_currency`, `set_currency_balance`, `get_currency_top`.
v0.2.0
2026-08-22

Full coverage across all 10 core client modules with automatic exponential backoff retries and typed exception hierarchy.

Added
Full coverage across all 10 core client modules: players, economy, server, worlds, plugins, advancements, placeholders, luckperms, noxauth, and skills.
Added
Exponential backoff retry mechanism with configurable `RetryConfig`.
v0.1.0
2026-05-18

Initial public release of noxaeapi-sdk on PyPI with urllib zero-dependency HTTP modules.

Added
Complete client implementation with modules: `client.server`, `client.players`, `client.worlds`, `client.economy`, `client.luckperms`.
Added
Factory constructor `NoxAeApiClient.from_env()` automatically reading `NOXAEAPI_BASE_URL` and `NOXAEAPI_KEY`.
Added
Typed exception hierarchy and optional async WebSocket streaming support via `noxaeapi-sdk[ws]`.

Rust SDK

Changelog for the official async Rust SDK package published on crates.io (noxaeapi-sdk).

Latest: v0.4.1
v0.4.1Latest Release
2026-09-05

Official release of the async Rust SDK with complete module coverage, tokio async support, and player profile resolution.

Added
Full tokio async client with 13 modules, exponential backoff retries, typed errors, and reqwest/tokio-tungstenite WebSocket integration.
Added
Player profile resolution methods: `resolve()`, `get_player_profile()`, and `get_player_profiles()` under `client.players()`.
Added
`NoxAeApiNetworkHubClient` for Velocity proxy network hub interactions.

Go SDK

Changelog for the official idiomatic Go SDK package (github.com/NoxlyDev/noxaeapi-sdk-go).

Latest: v0.4.1
v0.4.1Latest Release
2026-09-05

Official release of the idiomatic Go SDK with context support, complete module coverage, and player profile resolution.

Added
Full idiomatic Go client with `context.Context` support across all 13 modules, auto-retries, typed errors, and gorilla/websocket support.
Added
Player profile resolution methods: `Resolve()`, `GetPlayerProfile()`, and `GetPlayerProfiles()` under `client.Players`.
Added
`NoxAeApiNetworkHubClient` for Velocity proxy network hub interactions.

Velocity Network Hub

Changelog for the standalone NoxAeApi-Velocity plugin that acts as a proxy-wide REST and WebSocket network hub.

Latest: v1.3.0
v1.3.0Latest Release
2026-09-01

Initial release of the new push-based network hub architecture.

Added
Push-based network hub allowing backend nodes to register via WebSocket heartbeat.
Added
Proxy-wide player aggregation (`/v1/network/players`) directly from the Velocity proxy.
Added
Proxy-wide broadcasting (`/v1/network/broadcast`).
Added
Wildcard endpoint forwarding (`/v1/network/{id}/*`) to proxy requests to backend nodes.

Interactive CLI

Changelog for the official interactive terminal REPL and one-shot command-line client (@wumx-labs/noxaeapi-cli).

Latest: v2.0.5
v2.0.5Latest Release
2026-09-18

Square pixel matrix branding update and LuckPerms player group autocomplete optimization for large databases.

Changed
Updated terminal splash banner with horizontal `noxGradient` (Cyan `#38bdf8` -> Violet `#a78bfa` -> White `#ffffff`) and square pixel block matrix styling.
Changed
Optimized `luckperms` action arguments in the interactive REPL: removed live player UUID dropdown auto-suggestions to eliminate query latency and memory pressure on servers with large player databases (prompt now accepts direct UUID or username input).
Fixed
Enhanced `/use <name>` profile switching state retention and `/json` raw output stream pipeline handling.
v2.0.2
2026-09-08

Multi-currency support, offline skill metrics, and Velocity proxy network commands.

Added
Interactive multi-currency commands under `noxae economy`: `listCurrencies`, `getCurrencyBalance`, `payCurrency`.
Added
Proxy network hub administration commands under `noxae network` and backend node targeting syntax (`noxae @<nodeId> <cmd>`).
v2.0.0
2026-08-25

Complete CLI rewrite with full interactive REPL, live slash `/` autocomplete menu, and multi-profile configuration management.

Added
Interactive REPL environment with real-time command suggestions and slash menu (`/connect`, `/profiles`, `/use`, `/edit`, `/json`).
Added
Multi-profile configuration storage with automatic base URL and API key switching.

Upgrade & Compatibility Notes

Essential recommendations when upgrading your server plugin or TypeScript SDK.

SDK v0.2.0 Upgrade

SDK v0.2.0 now exposes all 10 core modules directly on the client instance (e.g. client.players, client.economy, client.worlds) with built-in exponential retry backoff.

Python SDK Availability

The official noxaeapi-sdk package is now available on PyPI. Install via pip install noxaeapi-sdk or with async WebSocket support via pip install "noxaeapi-sdk[ws]".

REST API Compatibility

Server Plugin v1.4.0 is fully compatible with SDK v0.2.0. For multi-server proxy network endpoints, use native fetch/HTTP requests until the dedicated SDK wrapper is introduced.