Realms API

Revision as of 20:38, 14 June 2013 by Shoghicp (talk | contribs) (Added Pocket Realms page)
Jump to navigation Jump to search

The Minecraft Realms API is the api endpoint used to control worlds hosted by Mojang's Minecraft Realms service.

The API endpoint for Desktop Edition is located at .

There is also an endpoint for Pocket Edition in development, located at It is being documentated on Pocket Realms


Session identification is stored in a pair of cookies sent with the header of every request. sid is the session ID of the currently logged in user (see Authentication) user is the case-correct? username of the current user. An example session is shown below:

GET /mco/available HTTP/1.1
Cookie: sid=-000000000000000000;user=Herobrine
Cache-Control: no-cache
Pragma: no-cache
User-Agent: Java/1.6.0_27
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive


GET /mco/available

Returns whether the user can access the Minecraft Realms service.

Parameters: none

Returns: plain text; only observed value is


GET /worlds

Return a list of servers that the user owns/is invited to? Returns: a JSON object with one array.


GET /worlds/locations

Returns a list of datacenters with server space available.

Returns: a JSON object with currently available locations.

{"locations":[{"locationId":"3","locationName":"London"},{"locationId":"6","locationName":"Los Angeles - California"}],"suggestion":{"locationId":"3","locationName":"London"}}

GET /worlds/$ID

Gets world info? For example, worlds/1 returns:

Not owner

GET /worlds/$ID/join

Joins a world?

World '1' not found!


Creates a world?