MinecraftAuth.me API
MinecraftAuth.me links a player's Minecraft account to their Discord, Twitch, Patreon and YouTube accounts. The public API lets Minecraft servers, bots, plugins and other integrations:
- look up a player's linked accounts, and
- check membership: whether a player follows, subscribes to or supports you (a creator) on a platform, or is in your Discord server.
Coming from the original API? See Migrating to the v2 API.
Getting started#
- Sign in at minecraftauth.me and link the accounts you'll check against, such as your Twitch channel or Discord account.
- Open the Developers page to get your server token or create an application. Authentication explains which one you need.
- Make your first request:
curl -A "MyPlugin/1.0" https://minecraftauth.me/api/v2/lookup/minecraft/069a79f4-44e9-4726-a5be-fca90e38aaf5val client = HttpClient.newHttpClient()
val request = HttpRequest.newBuilder(
URI("https://minecraftauth.me/api/v2/lookup/minecraft/069a79f4-44e9-4726-a5be-fca90e38aaf5")
)
.header("User-Agent", "MyPlugin/1.0")
.build()
val response = client.send(request, HttpResponse.BodyHandlers.ofString())
println(response.body())const response = await fetch(
"https://minecraftauth.me/api/v2/lookup/minecraft/069a79f4-44e9-4726-a5be-fca90e38aaf5",
{headers: {"User-Agent": "MyPlugin/1.0"}},
);
console.log(await response.json());req, err := http.NewRequest("GET",
"https://minecraftauth.me/api/v2/lookup/minecraft/069a79f4-44e9-4726-a5be-fca90e38aaf5", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("User-Agent", "MyPlugin/1.0")
resp, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))Basics#
| Base URL | https://minecraftauth.me/api/v2 |
| Format | Responses are JSON (Content-Type: application/json). Endpoints are GET, except starting an access request, which is a POST with a JSON body. |
| User agent | Every request must send a non-empty User-Agent header, or it's rejected with 403. Name your integration, e.g. User-Agent: MyPlugin/1.4. |
| Platform ids | minecraft, discord, twitch, patreon, google (YouTube). Case-insensitive. Anything else returns 400. |
Identifiers are always returned as strings:
| Platform | Identifier | Example |
|---|---|---|
minecraft |
Minecraft UUID. Requests accept it with or without dashes. | 069a79f4-44e9-4726-a5be-fca90e38aaf5 |
discord |
Discord user ID (snowflake) | 111111111111111111 |
twitch |
Twitch user ID | 12345 |
patreon |
Patreon user ID | 67890 |
google |
YouTube channel ID | UCxxxxxxxxxxxxxxxxxxxxxx |
Chapters#
| Authentication | server tokens, application credentials, and which you need |
| Privacy | what players can hide, and what you can see |
| Access requests | asking players for access to their private accounts, with or without a website |
| Look up linked accounts | GET /lookup/{platform}/{identifier} |
| Membership checks | GET /following, /subscribed, /discord/present |
| Errors and versioning | status codes, error bodies, and how versions change |
| Migrating to the v2 API | moving an integration from the original API |