Auralink

Minecraft API

Java/Bedrock server status, player UUID, username history, and skin/cape profiles.

Guide

Overview

Query Minecraft Java and Bedrock server status, player UUIDs, username history, and skin/cape profiles from one API key.

Offline servers return { online: false } instead of an error, so status commands can show a clean "offline" state.

Server status

EditionDefault portEndpoint
Java25565GET /api/minecraft/java/:host
Bedrock19132GET /api/minecraft/bedrock/:host

Each query times out after 10 seconds. Override the port with ?port= when needed.

Use the sections below for server status details and player lookup endpoints.

Endpoint: GET /api/minecraft/java/:host?port=25565

Returns online, and when online: host, port, version, motd, players (online/max/list), and latency.

Use for Java server list commands and uptime monitors.

Endpoint: GET /api/minecraft/bedrock/:host?port=19132

Returns online, and when online: host, port, version, motd, gamemode, players (online/max), and latency.

Use for Bedrock and console server status commands.

Combined: GET /api/minecraft/player/:username returns UUID, current username, and decoded skin/cape URLs in one call.

Individual routes

  • GET /api/minecraft/uuid/:username for UUID only
  • GET /api/minecraft/history/:uuid for past usernames
  • GET /api/minecraft/profile/:uuid for skin and cape URLs

Usernames are 1–16 characters. UUIDs may include or omit dashes.

Use cases

  • Server status commands for Minecraft bots
  • Player UUID and username history lookup
  • Minecraft profile (skin/cape) retrieval
  • One-call player lookup with decoded skin and cape URLs

Limits

API key requiredYes (Auralink API key)
Host lengthMax 253 characters
Port range1-65535 (Java default 25565, Bedrock default 19132)
Timeout10 seconds per server query
Offline serversReturn { online: false } instead of throwing
Rate limitStrict tier: 30 req/min

Endpoints

GET/api/minecraft/java/:host

Java server status

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:host - server hostname or IP
Query stringport (optional) - defaults to 25565
GET/api/minecraft/bedrock/:host

Bedrock server status

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:host - server hostname or IP
Query stringport (optional) - defaults to 19132
GET/api/minecraft/player/:username

Combined player lookup: UUID, username, and decoded skin/cape URLs

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:username - Minecraft username (1-16 chars)
Query stringNo query parameters
GET/api/minecraft/uuid/:username

UUID lookup

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:username - Minecraft username (1-16 chars)
Query stringNo query parameters
GET/api/minecraft/history/:uuid

Username history

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:uuid - Minecraft player UUID (with or without dashes)
Query stringNo query parameters
GET/api/minecraft/profile/:uuid

Profile lookup

AuthHeader: Authorization: Bearer YOUR_API_KEY
URL path:uuid - Minecraft player UUID (with or without dashes)
Query stringNo query parameters

Example request

Request
{
  "method": "GET",
  "path": "https://api.auralink.dev/api/minecraft/java/hypixel.net",
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY"
  }
}