Difference between revisions of "Mojang API"
(added examples) |
m (Added POST verb for clarity) |
||
Line 43: | Line 43: | ||
== Playernames -> UUIDs == | == Playernames -> UUIDs == | ||
− | https://api.mojang.com/profiles/minecraft | + | POST https://api.mojang.com/profiles/minecraft |
Where 'minecraft' - agent name | Where 'minecraft' - agent name | ||
Line 77: | Line 77: | ||
* The <code>Content-Type</code> HTTP header must be <code>application/json</code> | * The <code>Content-Type</code> HTTP header must be <code>application/json</code> | ||
* You cannot request more than 100 names per request | * You cannot request more than 100 names per request | ||
− | |||
− | |||
== uuid -> Profile + Skin/Cape == | == uuid -> Profile + Skin/Cape == |
Revision as of 15:20, 28 July 2014
Contents
Notes
All public APIs are rate limited so you are expected to cache the results. This is currently set at 600 per 10 minutes but this may change For some parts of the API, demo account are sometimes included, sometimes not. Mojang keeps changing this.
Username -> Profile at time
GET https://api.mojang.com/users/profiles/minecraft/<username>?at=<timestamp>
This will return the uuid of the name at the timestamp provided.
- The timestamp is a unix timestamp
- When the
at
parameter is not sent, the current time is used
Response
{
"id": "7125ba8b1c864508b92bb5c042ccfe2b",
"name": "KrisJelbring"
}
name
is case-correctedlegacy
only appears when true (not migrated to mojang account)demo
only appears when true (account unpaid)
UUID -> Name history
https://api.mojang.com/user/profiles/<uuid>/names
Returns all the usernames this user has used in the past and the one they are using currently
Response
[
"KrisJelbring"
]
Playernames -> UUIDs
POST https://api.mojang.com/profiles/minecraft
Where 'minecraft' - agent name
This will return player UUIDS and some extras.
Payload
[
"maksimkurb",
"nonExistingPlayer" //Test for non-existing player
]
Response
[
{
"id": "0d252b7218b648bfb86c2ae476954d32",
"name": "maksimkurb",
"legacy": true,
"demo": true
}
]
- name is case-corrected
- legacy only appears when true (profile not migrated to mojang.com)
- demo only appears when true (account unpaid)
- IllegalArgumentException is returned when any of the usernames is null or ""
- The
Content-Type
HTTP header must beapplication/json
- You cannot request more than 100 names per request
uuid -> Profile + Skin/Cape
https://sessionserver.mojang.com/session/minecraft/profile/<uuid>
This will return the player's username plus any additional information about them (e.g. skins). Example: https://sessionserver.mojang.com/session/minecraft/profile/4566e69fc90748ee8d71d7ba5aa00d20
This has a much stricter rate limit: You can request the same profile once per minute.
Response
{
"id": "<profile identifier>",
"name": "<player name>",
"properties": [
{
"name": "textures",
"value": "<base64 string>",
"signature": "<base64 string; signed data using Yggdrasil's private key>" // Only provided if ?unsigned=false is appended to url
}
]
}
The "value" base64 string for the "textures" object decoded:
{
"timestamp": "<unix time in ms>",
"profileId": "<profile uuid>",
"profileName": "<player name>",
"isPublic": "<true or false>",
"textures": {
"SKIN": {
"url": "<player skin URL>"
},
"CAPE": {
"url": "<player cape URL>"
}
}
}
- timestamp sometimes in the past (probably due to cached results?)
Examples
Python | uuids or names to profiles
Python | names file to uuids+names file
PHP | uuids to names
PHP uuids to names, names to uuids