Skip to content

Public API documentation for MC Championship.

Notifications You must be signed in to change notification settings

Noxcrew/mcchampionship-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 

Repository files navigation

MC Championship Event API



Introduction

MC Championship is a competitive Minecraft event for Java Edition created by Noxcrew. From the start of MCC Season 2, we have provided our audience with a way of tracking statistics in real-time in the form of MCC Live and we are opening up this data to the public in the form of our first public REST API.

It is worth emphasising that this is only a small fragment of what the team want to make accessible; a second iteration will come in the future with more data being accessible.


The API

Full documentation is now available via the API directly, including information about the data available and the schema of responses.

Please note that, in the interests of safety, the API is rate limited to 40 requests per minute per IP. Therefore, we recommend caching responses on your own database. This also enables you to look back at past event cycles until we add the capability to do this directly in the API in the future.


Looking ahead

As mentioned, this is an early iteration of the final API for which we are striving. Although this second iteration will have significant differences, we are aiming to allow for interoperability between the two. At present we are unable to provide concrete details on this and how it will behave with the full release of MCC Island but will continue to update this repository with further information when we are ready to share it.

Furthermore, as a REST API this current version lacks the ability to listen to changes directly via technologies like Web Sockets. We may enable this in the future but are unable to confirm with certainty at this stage.


Issues and feedback

Should you encounter any issues while using the API, please create an issue and we will get back to you as soon as possible. For questions and feedback, please use the discussions tab.

We will not be accepting Pull Requests in this repository.