MinecraftAuth.me

API documentation

Contents: Membership checks

Membership checks

Is following#

GET /api/v2/following?minecraft={uuid}&platform={platform}

Whether the player follows the caller on platform. Supported platforms: twitch (follows your channel) and google (subscribed to your YouTube channel). The caller must have that platform linked.

curl -A "MyPlugin/1.0" -H "Authorization: Bearer $TOKEN" \
  "https://minecraftauth.me/api/v2/following?minecraft=069a79f4-44e9-4726-a5be-fca90e38aaf5&platform=twitch"
{ "result": true }

Is subscribed#

GET /api/v2/subscribed?minecraft={uuid}&platform={platform}[&data={requirement}]

Whether the player subscribes to or supports the caller on platform. The optional data narrows what counts:

platform Means data
discord has a role in a Discord server the MinecraftAuth bot is in a role ID (preferred), or a role name matched case-insensitively in the first server the bot shares with the player. Without data the result is always false
twitch subscribed to your channel minimum tier: 1, 2 or 3 (or 1000/2000/3000); default any tier
patreon an active patron of your campaign a tier title (case-insensitive); default any tier
google a member of your YouTube channel ignored

For every platform except discord, the caller must have that platform linked.

curl -A "MyPlugin/1.0" -H "Authorization: Bearer $TOKEN" \
  "https://minecraftauth.me/api/v2/subscribed?minecraft=069a79f4-44e9-4726-a5be-fca90e38aaf5&platform=twitch&data=2"
{ "result": false }

Is in a Discord server#

GET /api/v2/discord/present?minecraft={uuid}&server={guildId}

Whether the player's linked Discord account is a member of the given Discord server. The MinecraftAuth bot must be in that server, and the caller's linked Discord account must be its owner or have the Administrator or Manage Messages permission there.

curl -A "MyPlugin/1.0" -H "Authorization: Bearer $TOKEN" \
  "https://minecraftauth.me/api/v2/discord/present?minecraft=069a79f4-44e9-4726-a5be-fca90e38aaf5&server=123456789012345678"
{ "result": true }

Membership check statuses#

These apply to all three checks:

Status When
200 the check ran: {"result": true} or {"result": false}
400 missing or malformed minecraft, missing/unknown platform, a platform that doesn't support the check, a malformed data (e.g. a non-numeric Twitch tier) or server
401 no credentials
403 wrong credentials; the caller has no linked account on the platform; the caller isn't a member or moderator of the Discord server; or the application's owner has no identity
404 no identity is linked to that Minecraft UUID, or the player has no usable linked account on the platform (unlinked, or hidden without membership checks allowed)
409 the MinecraftAuth bot isn't in that Discord server
502 the platform couldn't be asked; try again later