Modules & SDKs Catalog

Available Modules & Integrations

A unified catalog of all 13 modular subsystems available across NoxAeApi REST API, TypeScript SDK, and Python SDK. Manage players, economies, worlds, permissions, and networks effortlessly.

13 Modules13 Subsystems
70+ Methods70+ Methods
Fabric & PaperMCPaper & Fabric
Zero-Bloat SDKsTypeScript & PyPI

Official Client Libraries

Choose your preferred language or integrate directly via HTTP/REST and WebSockets:

v0.5.2

TypeScript / Node.js SDK

Promise-based asynchronous client with complete TypeScript type definitions and EventEmitter WebSocket event streams.

npm i @wumx-labs/noxaeapi-sdk
v0.4.1

Python SDK (noxaeapi-sdk)

Zero-dependency typed client built on standard library urllib with auto-retry exponential backoff and optional WebSocket engine.

pip install noxaeapi-sdk
v0.4.1

Rust SDK

Official Rust crate (noxaeapi-sdk) built on tokio and reqwest.

cargo add noxaeapi-sdk
v0.4.1

Go SDK

Official idiomatic Go module with context.Context & gorilla/websocket.

go get github.com/NoxlyDev/noxaeapi-sdk-go

Modules Catalog (13)

Browse and inspect capabilities across every subsystem:

Players Module

Core Module

/v1/players

14 methods

Manage online and offline players: listing, detailed attributes, inventory slots, moderation (kick, ban, unban), teleportation, gamemode switching, and stats.

Key Methods
list()get()kick()ban()unban()teleport()set_gamemode()

Vault Economy Module

Core Module

/v1/economy

6 methods

Vault-compatible economy management: query balances, deposit funds, debit accounts, execute peer transfers, and retrieve rich leaderboards.

Key Methods
get_balance()deposit()debit()transfer()leaderboard()

Server Administration

Core Module

/v1/server

10 methods

Core server administration: metrics, live console command execution, full console log streaming, reload/restart, and OP/whitelist management.

Key Methods
status()exec()broadcast()whitelist()op()restart()

Worlds & Weather

Core Module

/v1/worlds

7 methods

Dimension and world control: time of day, dynamic weather, synchronous saving, on-demand ZIP backup archives, and world gamerules.

Key Methods
list()set_time()set_weather()save()backup()

Runtime Plugins

Core Module

/v1/plugins

6 methods

Runtime plugin management: list loaded plugins, inspect versions/descriptions, download and install remote JARs, enable, and disable.

Key Methods
list()get()install()enable()disable()

Advancements & Trophies

Core Module

/v1/advancements

4 methods

Player advancements and achievements inspection: list granted milestones and track completion progress across world trees.

Key Methods
list()player_progress()grant()revoke()

PlaceholderAPI (PAPI)

Core Module

/v1/placeholders

2 methods

PlaceholderAPI (PAPI) integration: parse single or batch placeholder strings for context-aware player and server variable expansion.

Key Methods
parse()batch_parse()

LuckPerms RBAC Permissions

Optional Plugin

/v1/luckperms

7 methods

LuckPerms RBAC permissions: user/group node management, parent inheritance, context queries, and resolved permission checks.

Requires the LuckPerms plugin installed and enabled on the target server.
Key Methods
user_permission()set_user_permission()groups()check()

NoxAuth Offline Authentication

Optional Plugin

/v1/auth

5 methods

Built-in player authentication: registration, credentials verification, login sessions, and password management for offline-mode setups.

Requires noxauth.enabled: true in the server config.yml.
Key Methods
register()verify()sessions()reset_password()

Skills (mcMMO / AuraSkills)

Optional Plugin

/v1/skills

4 methods

RPG progression integration: inspect and manage mcMMO skill levels/XP and AuraSkills attributes.

Requires mcMMO and/or AuraSkills plugins loaded on the target server.
Key Methods
player_mcmmo()player_auraskills()set_skill_level()

Plugin Leaderboards

Core Module

/v1/leaderboards

3 methods

Generic leaderboard manager fetching sorted data from configurable external plugins (like mcMMO power level).

Key Methods
get()categories()top()

Multi-Server Proxy Network

Optional Plugin

/v1/network

6 methods

Multi-server proxy network management: query combined player lists, find which backend node a player is on, and broadcast globally.

Requires the NoxAeApi plugin to be installed on a BungeeCord or Velocity proxy with network aggregator enabled.
Key Methods
status()health()network_players()broadcast_network()

Realtime WebSocket Streams

Core Module

/v1/ws/console, /v1/ws/events

3 methods

Modular subsystem provided by NoxAeApi.

Key Methods
connect("console")connect("events")reconnect()