arcticzeroo / mineplexapi

Documentation for the Mineplex Public API

Mineplex Public API

Welcome to the Mineplex Public API! We provide PC and PE oriented endpoints for gathering information on players, network status, and more.

General

All API endpoints utilize the HTTP GET method. Authorization & rate-limiting are handled via an API key.

The base URL for our API is https://api.mineplex.com.

PC/PE APIs are avaiable under the base at /pc and /pe respectively.

Documentation

All documentation is written following the OpenAPI 2.0 Specification.

Contributing: Make changes to our docs here by submitting a pull request containing changes to the underlying data files. Not the markdown files themself!

For convenience you may also view the swagger-ui documentation for PC and PE. (Provides an interface to interact with our API instead of just reading boring docs)

PC API

The PC API is hosted at https://api.mineplex.com/pc, and corresponds to the Mineplex Network on Minecraft PC/Mac Edition. (us.mineplex.com/eu.mineplex.com)

Authorization

We use API keys, similar to the majority of RESTful APIs, when authorizing your request.

Obtaining a key:
Each one of these keys is bound to a Minecraft account. As of now, you must be apart of the early access program to obtain a key; once we're out of that phase you'll be able to grab these in-game via /api.

Using your key:
API keys are passed in through the query string apiKey. (we'll also be adding support for a request header to hold your key as well shortly)

Note: Please do not share your key with anyone. You will be held responsible for anything that happens from your key, so keep it in check!

Caching

We implement server & client side caching for specific high traffic endpoints. Take note of the Cache-Control header for client sided caching.

Rate Limiting

All keys have a starting limit of 3000 requests per hour (almost one request per second). We use the following HTTP headers to specify rate data in each request:

HTTP Header	Meaning
X-RateLimit-Limit	Your total requests allowed per hour
X-RateLimit-Remaining	The amount of requests you have remaining in this time period
X-RateLimit-Reset	The time at which your current rate limit period resets (in UTC epoch seconds)

If you have exceeded your rate limit, the API will respond with HTTP 429 Too Many Requests.

Maybe what you're building makes a bit more requests than what we allow normally? Send an email our way including a brief explanation of what requires a slack on the rate-limiting.

PE API

Soon™