# Spark Web API<\/p>\n
A small plugin that will host a Web API for Spark.<\/p>\n
This plugin is made for Paper. You are free to fork
\nthis on GitHub and port this to other mod loaders.<\/p>\n
This README is a simplified version of the Project’s GitHub README.<\/p>\n
## Installation
\nFirst, Install Spark to your Paper server.
\nEven though Paper servers for Minecraft 1.21 and up
\nhas Spark built-in, a standalone plugin version is
\nrequired for this plugin.<\/p>\n
Then, Install Spark Web API. You generally would download
\nthe JAR with -all at the end of the file name.<\/p>\n
When starting your server, Please remember to set the
\n`paper.preferSparkPlugin` system property to `true`<\/p>\n
Here’s an example on how to do so:
\n“`
\njava -Dpaper.preferSparkPlugin=true -jar paper-1.21-129.jar
\n“`<\/p>\n
## Configuration
\nWhen starting the server for the first time with the
\nplugin, The plugin will generate a config file.
\nThe config file allows you to change the port of the
\nserver, which routes are enabled, and add additional
\nheaders to responses.<\/p>\n
“`yaml
\nport: 3000
\nroutes:
\n tps: true
\n mspt: true
\n sys_cpu: false
\n proc_cpu: false
\n gc: false
\nheaders:
\n enabled: false
\n“`<\/p>\n
## API paths
\n### \/api\/tps
\nReturn the TPS of the past 10 seconds, 1 minute,
\n5 minutes, and 15 minutes.<\/p>\n
Example Response:
\n“`json
\n{
\n “tenSeconds”: 19.999926688268733,
\n “oneMinute”: 20.000035730063832,
\n “fiveMinutes”: 20.00000458740105,
\n “fifteenMinutes”: 19.94021043987079
\n}
\n“`<\/p>\n
This route will return 500 Internal Server Error if Spark
\ncannot get the TPS of the server.<\/p>\n
### \/api\/mspt
\nReturns the MSPT value for the past 10 seconds and
\n1 minute.<\/p>\n
Example Response:
\n“`json
\n{
\n “tenSeconds”: {
\n “min”: 6.523605,
\n “max”: 2692.747083,
\n “mean”: 66.92731750515465,
\n “median”: 23.108289
\n },
\n “oneMinute”: {
\n “min”: 6.523605,
\n “max”: 2692.747083,
\n “mean”: 66.92731750515465,
\n “median”: 23.108289
\n }
\n}
\n“`<\/p>\n
This route will return 500 Internal Server Error if Spark
\ncannot get the MSPT of the server.<\/p>\n
### \/api\/gc<\/p>\n
Returns the information about the Garbage Collector.<\/p>\n
Example Response:
\n“`json
\n{
\n “G1 Young Generation”: {
\n “name”: “G1 Young Generation”,
\n “frequency”: 22328,
\n “avgTime”: 81,
\n “totalCollections”: 3,
\n “totalTime”: 243
\n },
\n “G1 Old Generation”: {
\n “name”: “G1 Old Generation”,
\n “frequency”: 0,
\n “avgTime”: 0,
\n “totalCollections”: 0,
\n “totalTime”: 0
\n }
\n}
\n“`<\/p>\n
### \/api\/cpu\/sys<\/p>\n
Returns the system CPU usage in percentage.<\/p>\n
Example Response:
\n“`json
\n{
\n “tenSeconds”: 0.20461582280862525,
\n “oneMinute”: 0.31800215079510524,
\n “fifteenMinutes”: 0.39118254849183964
\n}
\n“`<\/p>\n
### \/api\/cpu\/proc<\/p>\n
Returns the Minecraft process CPU usage in percentage.<\/p>\n
Example Response:
\n“`json
\n{
\n “tenSeconds”: 0.025064927938294894,
\n “oneMinute”: 0.030417615615548597,
\n “fifteenMinutes”: 0.06684861042724896
\n}
\n“`<\/p>\n
## License
\nThis plugin is licensed under the MIT License.<\/p>\n","protected":false},"excerpt":{"rendered":"
A Web API for Spark<\/p>\n","protected":false},"featured_media":0,"template":"","meta":{"_minecraft_slug":"spark-web-api","_minecraft_project_id":"nQIOXgCN","_minecraft_author":"lines-of-codes","_minecraft_license":"MIT","_minecraft_downloads":1181,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"spark-web-api.zip","_minecraft_size_bytes":23538546,"_minecraft_version_count":6,"_minecraft_updated_at":"2026-05-16T08:05:09.023401Z","_minecraft_date_created":"2024-04-08T07:18:03.636430Z","_minecraft_date_modified":"2026-03-07T06:14:05.968788Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/spark-web-api","_minecraft_icon_attachment_id":0,"_minecraft_imported_at":"2026-06-08T17:58:40+00:00","_minecraft_import_hash":"2022987707bc6c20086581ac6aa7dd03","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[873,127,92],"mod_loader":[132],"minecraft_version":[94,62,37,41],"class_list":["post-146093","mod","type-mod","status-publish","hentry","mod_category-library","mod_category-paper","mod_category-utility","mod_loader-paper","minecraft_version-1-20-4","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-11"],"yoast_head":"\n