Minecraft:Mojang API

This page provides documentation for API endpoints provided by Mojang Studios which allows user to query player data and make changes programmatically.

Most of the API has a per-IP ratelimit of 200 requests per 2 minutes. For IPv6, the ratelimits are bucketed by /56 subnet. Some endpoints have different ratelimits.

Request and response

For requests with a payload, the following restrictions apply:

• Request must include the Content-Type header, which must be application/json. Otherwise, the server returns HTTP 415.
• Payload must be a valid json. Otherwise, the server returns HTTP 400.

If the request is successful, the server:

• Returns a successful response code (HTTP 2XX)
• Returns an empty payload (with HTTP 204) or a valid json

Otherwise, if the request fails, the server returns a non-2XX HTTP status code with this payload:

• Template:Nbt: Root tag.
  • Template:Nbt: Error identifier
  • Template:Nbt: Description of the error
  • Template:Nbt: Description of the cause of the error

These are some common causes:

HTTP status code	Template:Cd	Template:Cd	Explanation
400	IllegalArgumentException	Depends on the endpoint	Incorrect or invalid argument in the request.
	MismatchedInputException		JSON payload does not meet the required schema or payload is not an invalid JSON.
	JsonParseException
401	(empty payload)	(empty payload)	Endpoint requires authentication, but request header does not have an Authorization header or the token is invalid.
	Unauthorized	The request requires user authentication	Endpoint requires authentication, but request header does not have an Authorization header.
403	ForbiddenOperationException	Forbidden	Invalid auth token.
	Template:Tc	Your account has been suspended. Please contact customer service.	Account has been banned/suspended state by triggering a high volume of erroneous requests. See #Account suspensions.
404	Not Found	The server has not found anything matching the request URI	Endpoint does not exist.
405	Method Not Allowed	The method specified in the request is not allowed for the resource identified by the request URI	Request method is not supported.
415	Unsupported Media Type	The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method	Template:Cd request header does not match the type the endpoint allows.

Account suspensions

A Minecraft account can be entered into a banned/suspended state by triggering a high volume of erroneous requests, such as a high volume of 429s while uploading a skin.

These suspensions appear to be temporary, although this is speculation and the exact functionality of this automatic suspension system is unknown.

POST https://api.minecraftservices.com/authentication/login_with_xbox

Returns 403 with the following JSON data <syntaxhighlight lang="json"> { "path": "/authentication/login_with_xbox", "details": { "reason": "ACCOUNT_SUSPENDED" }, "errorMessage": "Your account has been suspended. Please contact customer service." } </syntaxhighlight>

Other services will report that the account is banned, such as servers serving the otherwise unused message You are banned from playing online.

These suspensions typically clear within 24 hours but may require contacting Minecraft support if they don't.

Query player information

These endpoints do not need an access token, and some endpoints can query registered account that do not own the game.

Query player's username

Input

Player's name (case insensitive).

Request (GET)

• https://api.mojang.com/users/profiles/minecraft/<player name>
  • This will occasionally return random 403 errors due to a misconfiguration<ref>https://bugs.mojang.com/browse/WEB-7591?focusedId=1375404&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-1375404</ref> by Mojang.
• https://api.minecraftservices.com/minecraft/profile/lookup/name/<player name>
• https://api.mojang.com/minecraft/profile/lookup/name/<player name>

Response

• Template:Nbt Root tag
  • Template:Nbt: Minecraft:UUID of the player.
  • Template:Nbt: Name of the player, case sensitive.
  • Template:Nbt: Included in response if the account has not migrated to Mojang account.
  • Template:Nbt: Included in response if the account does not own the game.

Example

https://api.mojang.com/users/profiles/minecraft/jeb_
Player jeb_'s UUID.

<syntaxhighlight lang="json"> {

   "name": "jeb_",
   "id": "853c80ef3c3749fdaa49938b674adae6"

} </syntaxhighlight>

Error

• HTTP 404 is returned if no player with such name exists.

Query player's UUID

Input

Player's UUID.

Request (GET)

https://api.minecraftservices.com/minecraft/profile/lookup/<UUID>

Response

The same as #Query player's username.

Query player UUIDs in batch

Payload

A JSON array with no more than 10 player names (case insensitive).

Request (POST)

• https://api.mojang.com/profiles/minecraft
• https://api.minecraftservices.com/minecraft/profile/lookup/bulk/byname
• https://api.mojang.com/minecraft/profile/lookup/bulk/byname

Response

• Template:Nbt The UUID list for all the players. For players that does not exist, no result is returned.
  • Template:Nbt Player name.
    • Template:Nbt: Minecraft:UUID of the player.
    • Template:Nbt: Name of the player, case sensitive.
    • Template:Nbt: Included in response if the account has not migrated to Mojang account.
    • Template:Nbt: Included in response if the account does not own the game.

Example

Request with payload ["jeb_","notch"]. <syntaxhighlight lang="json"> [

   {
       "id": "853c80ef3c3749fdaa49938b674adae6",
       "name": "jeb_"
   },
   {
       "id": "069a79f444e94726a5befca90e38aaf5",
       "name": "Notch"
   }

] </syntaxhighlight>

HTTP status code	Template:Cd	Template:Cd	Explanation
400	CONSTRAINT_VIOLATION	size must be between 1 and 10	RequestPayload is an empty array.
			RequestPayload is has more than 10 elements.
		Invalid profile name	RequestPayload includes an empty string.

Query player's skin and cape

Input

Player UUID and whether the request is signed.

Request (GET)

• https://sessionserver.mojang.com/session/minecraft/profile/<UUID>
  • Ratelimited at about 400 requests per 10 seconds.
• https://sessionserver.mojang.com/session/minecraft/profile/<UUID>?unsigned=false

Response

• Template:Nbt Root tag
  • Template:Nbt: Player's Minecraft:UUID.
  • Template:Nbt: Player name, case sensitive.
  • Template:Nbt: Included in response if the account has not migrated to Mojang account.
  • Template:Nbt: A list of player properties.
    • Template:Nbt: Name of the property. For now, the only property that exists is textures.
    • Template:Nbt: Signature signed with Yggdrasil private key as Base64 string, only exists when unsigned=false.
    • Template:Nbt: Base64 string with all player textures (skin and cape). The decoded string includes:
      • Template:Nbt Texture object.
        • Template:Nbt: Unix time in milliseconds the texture is accessed.
        • Template:Nbt: Player's UUID without dashes.
        • Template:Nbt: Player name.
        • Template:Nbt: Only exists when unsigned=false.
        • Template:Nbt: Texture.
          • Template:Nbt: Skin texture. This does not exist if the player does not have a custom skin.
            • Template:Nbt: URL to the skin texture.
            • Template:Nbt: Optional. Metadata for the skin.
              • Template:Nbt: slim. Only exists when skin model is Alex. When skin model is Steve, this metadata does not exist.
          • Template:Nbt: Cape texture. If the player does not have a cape, this does not exist.
            • Template:Nbt: URL to the cape texture.

Example

https://sessionserver.mojang.com/session/minecraft/profile/853c80ef3c3749fdaa49938b674adae6
Returns: <syntaxhighlight lang="json"> {

   "id": "853c80ef3c3749fdaa49938b674adae6",
   "name": "jeb_",
   "properties": [
       {
           "name": "textures",
           "value": "ewogICJ0aW1lc3R..."
       }
   ]

} </syntaxhighlight> Content in Template:Nbt after Base64 decoded: <syntaxhighlight lang="json"> {

   "timestamp": 1653838459263,
   "profileId": "853c80ef3c3749fdaa49938b674adae6",
   "profileName": "jeb_",
   "textures": {
       "SKIN": {
           "url": "http://textures.minecraft.net/texture/7fd9ba42a7c81eeea22f1524271ae85a8e045ce0af5a6ae16c6406ae917e68b5"
       },
       "CAPE": {
           "url": "http://textures.minecraft.net/texture/9e507afc56359978a3eb3e32367042b853cddd0995d17d0da995662913fb00f7"
       }
   }

} </syntaxhighlight>

Error

HTTP status code	Template:Cd	Template:Cd	Explanation
204	(empty payload)	(empty payload)	This UUID does not have an associated player
400	(empty)	Not a valid UUID: <inputted argument>	UUID is invalid.

Microsoft authentication

Authentication for Microsoft accounts. Before using Microsoft auth, an Microsoft Azure Application must be created to obtain OAuth 2.0 client ID and token, which can then be used to obtain a Microsoft token. When obtaining the token, the Template:Cd parameter should include Template:Samp to obtain an Xbox Live token.

Obtain an Xbox Live token with Microsoft token

Payload

• Template:Nbt Root tag
  • Template:Nbt: Authentication properties
    • Template:Nbt: Login method. This should be RPS.
    • Template:Nbt: Website name. This should be user.auth.xboxlive.com.
    • Template:Nbt: Ticket used for logging in. Value should be d=<Microsoft access token>.
  • Template:Nbt: Replying party. This should be http://auth.xboxlive.com.
  • Template:Nbt: Type of the access token. This should be JWT.

Request (POST)

https://user.auth.xboxlive.com/user/authenticate

SSL renegotiation required in SSL implementation.

Response

• Template:Nbt Root tag
  • Template:Nbt: Time when obtaining the Xbox Live token.
  • Template:Nbt: Time the Xbox Live token is expired.
  • Template:Nbt: Xbox Live access token.
  • Template:Nbt: Unknown.
    • Template:Nbt: Unknown.
      • Template:Nbt
        • Template:Nbt: User hashcode.

Obtain an XSTS token with Xbox Live token

Payload

• Template:Nbt Root tag
  • Template:Nbt: Auth properties.
    • Template:Nbt: Sandbox ID. This should be RETAIL.
    • Template:Nbt: User's Xbox Live token.
      • Template:Nbt: User's Xbox Live token obtained in the previous step.
  • Template:Nbt: Replying party. This should be rp://api.minecraftservices.com/.
  • Template:Nbt: Type of the access token. This should be JWT.

Request (POST)

https://xsts.auth.xboxlive.com/xsts/authorize

SSL renegotiation required in SSL implementation.

Response

• Template:Nbt Root tag
  • Template:Nbt: Time when obtaining the XSTS token.
  • Template:Nbt: Time the XSTS token is expired.
  • Template:Nbt: XSTS access token.
  • Template:Nbt: Unknown.
    • Template:Nbt: Unknown.
      • Template:Nbt
        • Template:Nbt: User hashcode.

Error

HTTP 401 is returned if an error occurs in obtaining the XSTS token.

Obtain Minecraft access token with XSTS token

Payload

• Template:Nbt Root tag
  • Template:Nbt: Identity token. The value should be XBL3.0 x=<User hashcode>;<XSTS access token>.

Request (POST)

https://api.minecraftservices.com/authentication/login_with_xbox

Response

• Template:Nbt Root tag
  • Template:Nbt: UUID (not the UUID for the player)
  • Template:Nbt: Unknown, empty.
  • Template:Nbt: Minecraft access token.
  • Template:Nbt: Token type. This is always Bearer.
  • Template:Nbt: Time period until the token expires in seconds.

Check if the account owns Minecraft

Request header

Authorization should be Bearer <Minecraft access token>.

Request (GET)

https://api.minecraftservices.com/entitlements/license?requestId=<v4 UUID>

Response

If the account owns Minecraft, returns:

• Template:Nbt Root tag
  • Template:Nbt: Products licensed to use.
    • Template:Nbt: Data name, either product_minecraft, game_minecraft, product_minecraft_bedrock or game_minecraft_bedrock.
  • Template:Nbt: JWT signature.
  • Template:Nbt: Unknown.

If the account does not own Minecraft or is playing with Xbox Game Pass, empty payload is returned.

Player config

These endpoints are at https://api.minecraftservices.com, and all requires the Authorization header in request with value Bearer <Minecraft access token>. HTTP 401 is returned if token is missing or invalid.

Query player profile

Request (GET)

/minecraft/profile

Response

• Template:Nbt Root tag
  • Template:Nbt: Player's UUID.
  • Template:Nbt: Player name.
  • Template:Nbt: A list of info of all the skins the player owns.
    • Template:Nbt: A skin.
      • Template:Nbt: Skin's UUID.
      • Template:Nbt: Usage status for the skin. ACTIVE when the skin is the player's current skin, and INACTIVE when the skin was previously used.
      • Template:Nbt: URL to the skin.
      • Template:Nbt: Skin variant. CLASSIC for the Steve model and SLIM for the Alex model.
  • Template:Nbt: A list of info of all the capes the player owns.
    • Template:Nbt: A cape.
      • Template:Nbt: Cape's UUID.
      • Template:Nbt: Usage status for the cape. ACTIVE when the cape is the player's current cape, and INACTIVE when the cape is owned but not displayed in-game.
      • Template:Nbt: URL to the cape.
      • Template:Nbt: Alias for the cape.

Query player attributes

Request (GET)

/player/attributes

Response

• Template:Nbt Root tag
  • Template:Nbt: Player's privileges
    • Template:Nbt: Privilege of accepting chat messages
      • Template:Nbt
    • Template:Nbt: Privilege of joining servers.
      • Template:Nbt
    • Template:Nbt: Privilege of joining Realms.
      • Template:Nbt
    • Template:Nbt: Privilege of sending telemetry.
      • Template:Nbt
    • Template:Nbt: Privilege of sending optional telemetry.
      • Template:Nbt
  • Template:Nbt: Profanity filter settings.
    • Template:Nbt: If Realms profanity filter is on.
  • Template:Nbt: Player's ban status
    • Template:Nbt: Scope in which the player is banned.
      • Template:Nbt: Ban scope. If the player is not banned, these objects do not exist. Only MULTIPLAYER exists.
        • Template:Nbt: UUID of the ban.
        • Template:Nbt: When the ban expires. This does not exist if the player is permanently banned.
        • Template:Nbt: Reason for the ban.
        • Template:Nbt: Ban message displayed.

Modify player attributes

Payload

• Template:Nbt Root tag
  • Template:Nbt: Realms profanity filter options.
    • Template:Nbt: If filter is on.

Request (POST)

/player/attributes

Response

The same as #Query player attributes.

Get list of blocked users

Request (GET)

/privacy/blocklist

Response

• Template:Nbt Root tag
  • Template:Nbt: A list of blocked players whose chat messages and Realms invitations are ignored.
    • Template:Nbt: UUID for the blocked player.

Get keypair for signature

Request (POST)

/player/certificates

Response

• Template:Nbt Root tag
  • Template:Nbt: Keypair used for signature.
    • Template:Nbt: Private key. Starts with Template:Cd and ends with Template:Cd.
    • Template:Nbt: Public key. Starts withTemplate:Cd and ends with Template:Cd.
  • Template:Nbt: Deprecated, see below.
  • Template:Nbt: Public key signature.
  • Template:Nbt: When the keypair expires.
  • Template:Nbt: When the keypair should be refreshed.

Query player's name change information

Request (GET)

/minecraft/profile/namechange

Response

• Template:Nbt Root tag
  • Template:Nbt: The last time the name has been changed.
  • Template:Nbt: The time the player profile is created.
  • Template:Nbt: If the player can change name.

Check gift code validity

Request (GET)

/productvoucher/giftcode

Response

Returns HTTP 200 or 204 if the gift code is valid. Otherwise returns HTTP 404.

Check name availability

Request (GET)

/minecraft/profile/name/<name to be checked>/available

• This endpoint has a per-account ratelimit of 20 requests per 5 minutes.

Response

• Template:Nbt Root tag
  • Template:Nbt: Status of the name. DUPLICATE means the name is taken. AVAILABLE means the name is available.NOT_ALLOWED means the name does not meet requirements.

Change name

Input

Name to change to

Request (PUT)

/minecraft/profile/name/<name to change to>

Response

• Template:Nbt Root tag
  • Template:Nbt: Player's UUID.
  • Template:Nbt: Player name.
  • Template:Nbt: A list of info of all the skins the player owns.
    • Template:Nbt: A skin.
      • Template:Nbt: Cape's UUID.
      • Template:Nbt: Usage status for the cape.
      • Template:Nbt: URL to the skin.
      • Template:Nbt: Skin variant. CLASSIC for the Steve model and SLIM for the Alex model.
  • Template:Nbt: A list of info of all the capes the player owns.
    • Template:Nbt: A cape.
      • Template:Nbt: Cape's UUID.
      • Template:Nbt: Usage status for the cape.
      • Template:Nbt: URL to the cape.
      • Template:Nbt: Alias for the cape.

Error

HTTP status code	Template:Cd	Template:Cd	Explanation
400	CONSTRAINT_VIOLATION	changeProfileName.profileName: Invalid profile name	Name does not meet requirement. The name must have less than or equal to 16 characters and must consist of alphanumericals and underscores.
403	(empty)	Could not change name for profile	Cannot change name. If detail.status is DUPLICATE, the name has already been taken.
429	-	-	Too many rename requests sent.

Change skin

Payload

• Template:Nbt Root tag
  • Template:Nbt: Skin variant. classic for the Steve model and slim for the Alex model.
  • Template:Nbt: URL to the skin.

Request (POST)

/minecraft/profile/skins

Response

Returns the profile if operation succeeds.

Upload skin

Payload

Payload is made up of two parts:

• Template:Cd: Skin variant. classic for the Steve model and slim for the Alex model.
• Template:Cd: Image data for the new skin. See example below.

Request (POST)

/minecraft/profile/skins

Example

<syntaxhighlight lang="bash"> curl -X POST -H "Authorization: Bearer <access token>" -F variant=classic -F file="@steeevee.png;type=image/png" https://api.minecraftservices.com/minecraft/profile/skins </syntaxhighlight>

Response

Returns the profile if operation succeeds.

Reset skin

Input

Player's UUID.

Request (DELETE)

/minecraft/profile/skins/active

Response

Returns the profile if operation succeeds.

Hide cape

Request (DELETE)

/minecraft/profile/capes/active

Response

Returns the profile if operation succeeds.

Show cape

Payload

• Template:Nbt Root tag
  • Template:Nbt: UUID for the cape to activate

Request (PUT)

/minecraft/profile/capes/active

Response

Returns the profile if operation succeeds.

Error

HTTP status code	Template:Cd	Template:Cd	Explanation
400	(empty)	profile does not own cape	The player does not own the cape.

Server

Query blocked server list

Request (GET)

https://sessionserver.mojang.com/blockedservers

Response

A text file where every line is the SHA-1 hash of a blocked server.

Verify login session on client

Payload

• Template:Nbt Root tag
  • Template:Nbt: Minecraft access token.
  • Template:Nbt: Player UUID without dashes.
  • Template:Nbt: Server ID. See below.

Server ID is obtained from the following algorithm:

<syntaxhighlight lang="java"> public static String generateServerId(String baseServerId, // Base server ID, usually an empty string""

                                     PublicKey publicKey,   // Server's RSA public key
                                     SecretKey secretKey    // The symmetric AES secret key used between server and client
                                    ) throws Exception { 
   MessageDigest messageDigest = MessageDigest.getInstance("SHA-1");
   messageDigest.update(baseServerId.getBytes("ISO_8859_1"));
   messageDigest.update(secretKey.getEncoded());
   messageDigest.update(publicKey.getEncoded());
   byte[] digestData = messageDigest.digest();
   return new BigInteger(digestData).toString(16);

} </syntaxhighlight>

Request (POST)

https://sessionserver.mojang.com/session/minecraft/join

• This endpoint has a per-account ratelimit of 6 joins per 30 seconds.

Response

Returns HTTP 204 if authentication passes.

Verify login session on server

Input

Case insensitive player name, server ID obtained by the above algorithm and the client IP (optional).

Request (GET)

https://sessionserver.mojang.com/session/minecraft/hasJoined?username=<player name>&serverId=<Server ID>&ip=<Client IP>

Response

Returns this payload if verification passes.

Get Mojang public keys

Request (GET)

https://api.minecraftservices.com/publickeys

Response

• Template:Nbt Root tag
  • Template:Nbt: A list of public keys used for verifying player properties (such as skin and cape textures), from e.g. https://sessionserver.mojang.com/session/minecraft/profile/<UUID>?unsigned=false. A player property is considered valid by the client iff signed by any of these keys.
    • Template:Nbt: Base64-encoded DER public key.
  • Template:Nbt: A list of public keys used for verifying player public keys, e.g. from https://api.minecraftservices.com/player/certificates. A player certificate is considered valid by the client iff signed by any of these keys.
    • Template:Nbt: Base64-encoded DER public key.

References

This article is partially adapted from Mojang API on wiki.vg.

Examples

• C# - Full API wrapper
• C# - Full API wrapper with Mojang/Microsoft Authentication
• Dart - Almost full API wrapper with Mojang Authentication
• Go - Full API wrapper
• Go - UUIDs or names to profiles with skins, capes and name histories
• Python - Full API Wrapper. Also supports authentication & parts of the Minecraft website
• Python - Pymojang is a full wrapper around de Mojang API and Mojang Authentication API. Also support RCON, Query and Server List Ping
• Python - Full API wrapper (not updated since 2018)
• Python - UUIDs or names to profiles (not updated since 2018)
• PHP - Complete Mojang's API wrapper
• PHP - Almost full API wrapper with Mojang Authentication. Also support head rendering
• PHP - UUIDs or names to profiles with skins, heads and name histories
• PHP - UUIDs to names
• PHP - UUIDs to names, names to uuids
• Java - Almost full API Wrapper
• Java - Almost full API Wrapper with auth
• Java - Almost full API with Mojang Authentication and can also work as a console Application.
• JavaScript - UUIDs or names to profiles with skins, capes and name histories
• JavaScript/TypeScript - Almost full API wrapper

Navigation

de:Mojang API lzh:魔贊卯口 zh:Mojang API