API

From RetroMC
Revision as of 20:58, 4 September 2026 by Skull6 (talk | contribs) (separate into more subpages)
Jump to navigation Jump to search


The RetroMC API provides developers and the broader community with programmatic access to server data and functionalities, and as such, this API is primarily designed to support the creation of tools and applications by developers.

Access to the RetroMC API is intended for everyone who wish to create applications or services that utilize RetroMC server data.
Users are encouraged to use the API responsibly, adhering to any usage limits or guidelines established by staff members to ensure smooth operations.

Please note that while the API aims to be stable and reliable, the availability and stability of various endpoints may vary, and users should design their applications to handle potential data inconsistencies or API changes.

The following sections of this page documents the available endpoints, request formats, and the types of data that can be accessed, with detailed information on each endpoint, including required parameters, response formats, and example requests and responses.

Developers are encouraged to join the RetroMC Discord community to seek support, share their projects, and stay updated on API developments and server news; further assistance, questions regarding the API, and/or issue reporting can be done through a ticket.

For GET endpoints, request variables are encoded as URL options (e.g. getVillage?uuid=UUID), while POST requests use the request field as JSON for those.

Endpoints