<\/p>\n
**ServerAPI** is a high-performance **REST API plugin** that exposes real-time Minecraft server metrics, player statistics, and third-party plugin data through a secure, token-protected interface.<\/p>\n
<\/p>\n
It works by running an asynchronous HTTP server on a separate thread, using reflection to safely retrieve deep server information without impacting game performance or TPS.<\/p>\n
## Usage Guide
\n1.Installation & Build
\nPlace ServerAPI-1.0.jar into your **plugins\/folder**.
\nStart the server to generate the config.yml<\/p>\n
2. API Endpoints & Data Info <\/p>\n
Status (GET \/status)
\nProvides a general overview of the server:<\/p>\n
– online: Server accessibility status.
\n– version: Server software version.
\n– paper_version: Specific implementation version.
\n– players: Sub-object containing online and max counts.
\n– tps: Current Ticks Per Second (1-minute average).
\n– mspt: Milliseconds Per Tick (Average).
\n– uptime: Total server uptime in seconds.
\n– worlds: List of loaded world names.<\/p>\n
Performance (GET \/performance)
\n Detailed resource and health metrics:<\/p>\n
– tps: Precise 1m, 5m, and 15m averages.
\n– mspt: Average tick time (highly accurate).
\n– lag_warning: Boolean that flags true if TPS drops below 18.0.<\/p>\n
Player Info (GET \/player\/{name})
\nComprehensive data for online and offline players:<\/p>\n
– name, uuid, online status.
\n– lastSeen: Human-readable time (e.g., “2 hours ago”).
\n– playtime: Formatted total time in hours.
\n– kills \/ deaths: Secure stats (safely returns 0 if data isn’t loaded\/tracked yet).
\n– money: Formatted balance using Vault.
\n– alts: IP-matched alt accounts from EssentialsX.
\n– crates: List of specific crate types and how many virtual keys the player owns.<\/p>\n
Miscellaneous Endpoints<\/p>\n
– \/misc\/balancetop: Top 10 richest players (cached based on config).
\n– \/misc\/statistics: Global Top 10 for kills\/deaths (cached).
\n– \/misc\/warps: All available EssentialsX warps.
\n– \/misc\/crates: All registered ExcellentCrates IDs.
\n– \/misc\/projectkorra: All bending abilities grouped by element.<\/p>\n
Configuration (config.yml)<\/p>\n
– Security: All requests require Authorization: Bearer YOUR_TOKEN.
\n– Toggles: Every endpoint and sub-endpoint listed above can be individually disabled.
\n– Caching: Heavy lookups like BalTop and Global Stats have configurable cache durations (default 5 mins) to protect your server’s TPS.
\n– Asynchronous: The API runs on a separate thread pool to ensure zero impact on your Minecraft server performance.<\/p>\n
An image that gives an example of a use-case of the plugin:<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
ServerAPI is a REST api plugin that provides server info like deaths, kills, player balance, crate keys, tps, and much more on a HTTP server. It provides a secure bridge for external applications to fetch real-time server-info easily.<\/p>\n","protected":false},"featured_media":137522,"template":"","meta":{"_minecraft_slug":"serverapi","_minecraft_project_id":"p6NUQDF0","_minecraft_author":"serenestriker_","_minecraft_license":"MIT","_minecraft_downloads":21,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"serverapi.zip","_minecraft_size_bytes":23159,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T22:32:00.910540Z","_minecraft_date_created":"2026-02-23T04:24:49.852237Z","_minecraft_date_modified":"2026-02-20T03:33:22.624783Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/serverapi","_minecraft_icon_attachment_id":137522,"_minecraft_imported_at":"2026-06-08T03:07:24+00:00","_minecraft_import_hash":"c5580b73a67e0aca80d0140b96ebd541","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,127,128,129],"mod_loader":[130,132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-137521","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_loader-bukkit","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n