Compatibility
Minecraft: Java Edition
Platforms
Creators
Details
WEB-API Plugin
WEB-API is a high-performance data bridge plugin for Minecraft servers (Paper/Bukkit).
It exposes in-game player data—such as economy, points, and permission groups—via a built-in web server (Web API), making it easy for websites, front-end pages, or third-party services to automatically fetch and integrate server data.
Key Features
-
Embedded Web Server
Starts an HTTP server (customizable port, default12232
) when the plugin loads, providing a data endpoint. Any web page or application can access this port to retrieve server data, with no need for an external web server. -
Real-Time Data Fetching & Scheduled Updates
Periodically (interval configurable) fetches data for all players, including economy (e.g., xconomy), points (e.g., PlayerPoints), and permission groups (LuckPerms). Fully supports customizable PlaceholderAPI (PAPI) variables, allowing flexible integration with various plugins and data types. -
Standardized Data Format
All data is output in structured JSON format, including each player’s name, economy, points, permission group, and more—making it easy for front-end or third-party systems to parse and use. -
Highly Configurable
- Configure each data field in
config.yml
: enable/disable, PAPI expression, data provider plugin, default value for empty data, etc. - Customize the web server port, web path, data refresh interval, and more.
- Set a default value for each data field when the value is empty (e.g.,
0
for money/points, empty string for permission group).
- Configure each data field in
-
Data Persistence
Writes the latest fetched data todata.yml
. The web server reads directly from this file, ensuring data consistency and high availability. -
Strong Compatibility
- Native support for PlaceholderAPI, compatible with most mainstream economy, points, and permission plugins.
- Uses soft-dependency to automatically adapt to PlaceholderAPI, ensuring proper load order.
Typical Use Cases
- Automatically display real-time server data on websites, leaderboards, or player dashboards.
- Allow third-party services, bots, or analytics platforms to fetch server data automatically.
- Provide real-time player economy/permission data for server control panels or admin backends.
Summary
WEB-API seamlessly connects your Minecraft server data to the outside world, greatly enhancing data openness and automation.
It is the ideal choice for data visualization, automated operations, and cross-platform integration for Minecraft servers!