# Requests – A REST API for Minecraft Servers<\/p>\n
Requests is a PaperMC plugin that provides a RESTful API for Minecraft servers. With Requests, server admins can easily query and interact with their servers using simple REST semantics.<\/p>\n
## Features<\/p>\n
– RESTful API for Minecraft servers
\n– Query server information such as player count and server status
\n– Send commands to the server
\n– Authenticate requests using API keys
\n– Easy to use and integrate
\n## Usage<\/p>\n
Requests exposes a RESTful API that can be accessed using HTTP requests. The base URL for the API is `http:\/\/localhost:5000` and can be configured in `config.toml`.<\/p>\n
“`toml [database] [api] ### Authentication<\/p>\n Requests uses API keys to authenticate requests. To generate an master API key, use the following command in the server console:<\/p>\n “`bash The ` To generate an player API key, use the following command in game:<\/p>\n “`bash To authenticate a request, include the API key in the `Authorization` header of the HTTP request:<\/p>\n “`bash ### API Endpoints<\/p>\n Requests provides the following API endpoints:<\/p>\n #### GET `\/server`<\/p>\n Returns the status of the Minecraft server.<\/p>\n #### GET `\/players`<\/p>\n Returns a list of online players on the Minecraft server.<\/p>\n #### GET `\/player\/ Returns the information of a player.<\/p>\n #### POST `\/command`<\/p>\n Sends a command to the Minecraft server. This route can be used by admin token only, and is disabled by default.<\/p>\n ### Example Requests<\/p>\n #### Get server status<\/p>\n “`bash #### Get player profile<\/p>\n “`bash #### Send command<\/p>\n “`bash {“command”:”say Hello, World!”} ## Build<\/p>\n To build Requests from source, follow these steps:<\/p>\n 1. Clone the repository: `git clone https:\/\/github.com\/theMackabu\/requests.git` ## License<\/p>\n Requests is licensed under the GPL-3 License.<\/p>\n","protected":false},"excerpt":{"rendered":" API for your minecraft server<\/p>\n","protected":false},"featured_media":132357,"template":"","meta":{"_minecraft_slug":"requests","_minecraft_project_id":"Ex0KqI5C","_minecraft_author":"theMackabu","_minecraft_license":"GPL-3.0-only","_minecraft_downloads":202,"_minecraft_follows":8,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"requests.zip","_minecraft_size_bytes":17852044,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T12:40:18.203707Z","_minecraft_date_created":"2023-05-11T01:59:32.020972Z","_minecraft_date_modified":"2023-05-10T01:17:22.435029Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/requests","_minecraft_icon_attachment_id":132357,"_minecraft_imported_at":"2026-06-07T19:23:06+00:00","_minecraft_import_hash":"eff84aca004bd62b53806f8e412c1f4c","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,127,92],"mod_loader":[132],"minecraft_version":[54,55,56,57,58],"class_list":["post-132356","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-paper","mod_category-utility","mod_loader-paper","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4"],"yoast_head":"\n
\n[plugin]
\nsalt = “change this”
\nprefix = “
\ntokens = “tokens.db”
\nplayers = “players.db”<\/p>\n
\nport = 5000
\nvault = false
\nluckperms = false
\n“`<\/p>\n
\n\/api generate-key
\n“`<\/p>\n
\n\/api token new
\n“`<\/p>\n
\nAuthorization: Bearer
\n“`<\/p>\n
\nGET \/server HTTP\/.1
\nAuthorization: Bearer
\nUser-Agent: Example Agent\/0.0.1
\n“`<\/p>\n
\nGET \/player\/
\nAuthorization: Bearer
\nUser-Agent: Example Agent\/0.0.1
\n“`<\/p>\n
\nPOST \/command HTTP\/1.1
\nAuthorization: Bearer
\nContent-Type: application\/json; charset=utf-8
\nUser-Agent: Example Agent\/0.0.1
\nContent-Length: 31<\/p>\n
\n“`<\/p>\n
\n2. Navigate to the cloned repository: `cd requests`
\n3. Build the plugin using Gradle: `.\/gradlew shadowJar`
\n4. The built JAR file will be located at `build\/libs\/requests-