# Minecraft API
> Live Minecraft data as an API. Query any Java or Bedrock server by address and get its live status — whether it is online, the current and maximum player count, the server version and protocol, the MOTD, the favicon, software and (when public) the player sample. Look up any player by name or UUID for their full profile: dashed and trimmed UUID, current skin and cape texture URLs, skin model (classic or slim), name history and account-creation date, plus ready-made avatar, head and body render URLs. Resolve usernames to UUIDs and back, fetch skin and render links on their own, and list every Minecraft version (releases and snapshots) with release dates. Perfect for server-list sites and status dashboards, player-stat and skin-viewer tools, Discord bots, launchers and fan sites. No accounts, no upstream key. Powered by mcsrvstat.us and Mojang.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/minecraft-api/..."
```

## Pricing
- **Free** (Free) — 3,600 calls/Mo, 2 req/s
- **Starter** ($5/Mo) — 45,500 calls/Mo, 5 req/s
- **Pro** ($14/Mo) — 220,000 calls/Mo, 15 req/s
- **Mega** ($39/Mo) — 1,095,000 calls/Mo, 40 req/s

## Endpoints

### Servers

#### `GET /v1/server` — Java/Bedrock server status

**Parameters:**
- `address` (query, required, string) — Server address Example: `hypixel.net`
- `type` (query, optional, string) — java|bedrock Example: `java`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/server?address=hypixel.net&type=java"
```

**Response:**
```json
{
    "data": {
        "ip": "172.65.197.160",
        "map": null,
        "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAt0UlEQVR4XnV7B3hc1bX12Oq9Te+9d400TV2yLFndkiXZlm1Z7r3gChibEhwgiQ1JSELCgzyaqYFQQggvCQ/SXx6QkBgMJCZAIGBiMMbdWv86d2Qbkvf7+/Z3PTOambvXWXvttc+9IzObAr/oGh47Om/VCrSNLMD6q67Dpj3XY8boIqT6hpHuH0GaR/H/i9E7B7G2bun4hef/j2icPYLGwamQ/j+KrrExjKxYgokNK7D8stVYtW0N1l6+FusuxjqsZ2wQccV6bLzy/x+X7dqALbs2Yuvujdi+ZwO2X73xYmzjc3tu3IW9+7+EG75+A3bfuBvX778BE5vWomds8VmHM/pbWcfA8Hs/fPrRczd8fR9PbAL1fTzJvjn8o61o6BtCbXsPoi2dCDe2I9QwA8H6NgTrWhFINSOQbpHCz/9LkWy6GL5k479EQyYSDfzbRgTTTQjViWhEuP7z0YBwHSNdj0i6ARG+ngnx/4bMc6kGRNONqOb7o4wwPz+czPy/ur6ZIY58zIg1tKC2qRW1LTMQSrWgiTntvvF6/PDpByf7Fiz8TNY9tnDyznv2o2fOMGy+JMz+JIy+BDw1TbAE0zAHUtJzpqkQr4mQHovjv4R56jN0DL34e3+Kf5sJC8Mq/Z/v9fJz3LUoUxqRlVWEabJ8Rh6m81iYVwWNwQWbtRpWYxgWYwgqlQ1ypRXllWYo1XYUlNggk8mmogQyhQN6fp7BHoPelYDOw+/3iGMCWreIuPR/JV9r75+Nfd/cjdXb1kLWPm8hKbcV/lg9KlROKNQWVKnMKC7XorzKgAq5ERUKIyoZVQyFwiRFuYKvXQy+prJArnWgVO9CudEDtyMCl7NaAtUokvUKgARoSWjsYRQVVSCXCWczgfIqJTRGG9QGK/RmF8JN7ZixZDlmTCxHPUumfnAuWhYsxsylK9G7Zh06lq/C4NqNWLRxC8Y3b8PImo0YXLYG3kQLqtRmflccRk8tAamGwVMDk7sGRld1ZpG4AIFkC/rHRjGxfjlkrcNj2Lz7SgRq61FUpoeqygJVhRmqSguUPKqlyDxnr7QhoPCgRuWHvtwAeakWhbnFKMovg7LSCk2VA3a5AzGlC8uNEYwZwqhT2VFUWIb84nLIcyuQN72Qq65FVlEZk7bD4g2jfs48tDO59mUrMZPJ9Wy8DF1rNqB53gRaFy1D26IVGNlzNVbt24e999yDZTfdhAPPPou3PvgAh9//B37y69/g0Sd/jNGlq+BlKeq5CMoSFUoK+J0lSihKVSgvVnIBTdC5YrCH0mic1YV0Zx9kLXPmU4C2wlfbKAGgkQAQyfNYboSNCWmZvLbCSnAcMMidBMCHWnUA
…(truncated, see openapi.json for full schema)
```

### Players

#### `GET /v1/player` — Player profile

**Parameters:**
- `username` (query, required, string) — Username or UUID Example: `Notch`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/player?username=Notch"
```

**Response:**
```json
{
    "data": {
        "player": {
            "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
            "renders": {
                "body": "https://mc-heads.net/body/069a79f444e94726a5befca90e38aaf5",
                "head": "https://mc-heads.net/head/069a79f444e94726a5befca90e38aaf5",
                "skin": "https://mc-heads.net/skin/069a79f444e94726a5befca90e38aaf5",
                "avatar": "https://mc-heads.net/avatar/069a79f444e94726a5befca90e38aaf5"
            },
            "cape_url": null,
            "skin_url": "https://textures.minecraft.net/texture/292009a4925b58f02c77dadc3ecef07ea4c7472f64e0fdc32ce5522489362680",
            "username": "Notch",
            "created_at": "2010-01-10",
            "skin_model": "classic",
            "custom_skin": true,
            "name_history": [
                {
                    "username": "Notch",
                    "changed_at": null
                }
            ],
            "uuid_trimmed": "069a79f444e94726a5befca90e38aaf5"
        }
    },
    "meta": {
        "timestamp": "2026-06-01T00:03:43.684Z",
        "request_id": "58757de6-2b13-4605-8a09-3b5f90db7404"
    },
    "status": "ok",
    "message": "Player retrieved",
    "success": true
}
```

#### `GET /v1/skin` — Skin & render URLs

**Parameters:**
- `username` (query, required, string) — Username or UUID Example: `Notch`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/skin?username=Notch"
```

**Response:**
```json
{
    "data": {
        "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
        "model": "classic",
        "renders": {
            "body": "https://mc-heads.net/body/069a79f444e94726a5befca90e38aaf5",
            "head": "https://mc-heads.net/head/069a79f444e94726a5befca90e38aaf5",
            "skin": "https://mc-heads.net/skin/069a79f444e94726a5befca90e38aaf5",
            "front": "https://mc-heads.net/body/069a79f444e94726a5befca90e38aaf5",
            "avatar": "https://mc-heads.net/avatar/069a79f444e94726a5befca90e38aaf5",
            "isometric_head": "https://mc-heads.net/head/069a79f444e94726a5befca90e38aaf5"
        },
        "username": "Notch",
        "cape_texture": null,
        "skin_texture": "https://textures.minecraft.net/texture/292009a4925b58f02c77dadc3ecef07ea4c7472f64e0fdc32ce5522489362680"
    },
    "meta": {
        "timestamp": "2026-06-01T00:03:43.984Z",
        "request_id": "41cf58f8-b629-448d-a482-c894b8fcefc0"
    },
    "status": "ok",
    "message": "Skin retrieved",
    "success": true
}
```

#### `GET /v1/uuid` — Resolve username <-> UUID

**Parameters:**
- `id` (query, required, string) — Username or UUID Example: `Notch`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/uuid?id=Notch"
```

**Response:**
```json
{
    "data": {
        "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
        "username": "Notch",
        "uuid_trimmed": "069a79f444e94726a5befca90e38aaf5"
    },
    "meta": {
        "timestamp": "2026-06-01T00:03:44.259Z",
        "request_id": "591df051-ca89-43f4-864d-dddb269362a1"
    },
    "status": "ok",
    "message": "UUID resolved",
    "success": true
}
```

### Reference

#### `GET /v1/versions` — Minecraft version list

**Parameters:**
- `type` (query, optional, string) — release|snapshot|old_beta|old_alpha Example: `release`
- `limit` (query, optional, string) — Max 1-300 Example: `50`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/versions?type=release&limit=50"
```

**Response:**
```json
{
    "data": {
        "count": 50,
        "total": 101,
        "latest": {
            "release": "26.1.2",
            "snapshot": "26.2-pre-2"
        },
        "versions": [
            {
                "id": "26.1.2",
                "type": "release",
                "release_time": "2026-04-09T10:12:23+00:00"
            },
            {
                "id": "26.1.1",
                "type": "release",
                "release_time": "2026-04-01T09:06:36+00:00"
            },
            {
                "id": "26.1",
                "type": "release",
                "release_time": "2026-03-24T12:11:04+00:00"
            },
            {
                "id": "1.21.11",
                "type": "release",
                "release_time": "2025-12-09T12:23:30+00:00"
            },
            {
                "id": "1.21.10",
                "type": "release",
                "release_time": "2025-10-07T09:17:23+00:00"
            },
            {
                "id": "1.21.9",
                "type": "release",
                "release_time": "2025-09-30T11:58:43+00:00"
            },
            {
                "id": "1.21.8",
                "type": "release",
                "release_time": "2025-07-17T12:04:02+00:00"
            },
            {
                "id": "1.21.7",
                "type": "release",
                "release_time": "2025-06-30T09:32:16+00:00"
            },
            {
                "id": "1.21.6",
                "type": 
…(truncated, see openapi.json for full schema)
```

### Meta

#### `GET /v1/meta` — Usage notes

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/minecraft-api/v1/meta"
```

**Response:**
```json
{
    "data": {
        "note": "Minecraft data. /v1/server?address=hypixel.net (&type=java|bedrock) = live server status (players online/max, version, MOTD, icon, software); /v1/player?username=Notch = full profile (UUID, skin & cape, name history, render URLs); /v1/uuid?id=Notch = resolve username↔UUID; /v1/skin?username=Notch = skin/cape textures + avatar/head/body render URLs; /v1/versions?type=release = the game's version list with release dates. Data from mcsrvstat.us and Mojang.",
        "source": "mcsrvstat.us + Mojang (via api.ashcon.app) + launchermeta.mojang.com",
        "endpoints": [
            "/v1/server",
            "/v1/player",
            "/v1/uuid",
            "/v1/skin",
            "/v1/versions",
            "/v1/meta"
        ]
    },
    "meta": {
        "timestamp": "2026-06-01T00:03:44.478Z",
        "request_id": "48b4d26c-7274-4e44-833c-52f92e7ede41"
    },
    "status": "ok",
    "message": "Meta retrieved",
    "success": true
}
```


---
Marketplace page: https://www.oanor.com/api/minecraft-api
OpenAPI spec: https://www.oanor.com/api/minecraft-api/openapi.json
