Frontend/documentation/player/player-lookup.md
Liam 9e17145e90
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m30s
change docs and docs page
2024-04-22 20:07:53 +01:00

2.5 KiB

title summary
Player Lookup Get information about a player.

Overview

The player lookup endpoint allows you to get information about a player. This includes their UUID, username, and any other information that is available.

Endpoint

GET /player/:query

Parameters

Parameter Description Required
query The username or uuid of the player you want to look up. Yes

Example

curl -X GET "https://api.mcutils.xyz/player/imfascinated" -H "accept: application/json"

Response

{
  "cache": {
    "cached": false,
    "cachedTime": -1
  },
  "uniqueId": "eeab5f8a-18dd-4d58-af78-2b3c4543da48",
  "trimmedUniqueId": "eeab5f8a18dd4d58af782b3c4543da48",
  "username": "ImFascinated",
  "skin": {
    "url": "http://textures.minecraft.net/texture/ba1e0c9e21983c06e45614642316cd7029a297bc246bc6d236a41388c3ff9a09",
    "model": "SLIM",
    "legacy": false,
    "parts": {
      "head": "https://api.mcutils.xyz/player/head/eeab5f8a-18dd-4d58-af78-2b3c4543da48",
      "face": "https://api.mcutils.xyz/player/face/eeab5f8a-18dd-4d58-af78-2b3c4543da48",
      "body": "https://api.mcutils.xyz/player/body/eeab5f8a-18dd-4d58-af78-2b3c4543da48"
    }
  },
  "cape": {
    "url": "http://textures.minecraft.net/texture/2340c0e03dd24a11b15a8b33c2a7e9e32abb2051b2481d0ba7defd635ca7a933"
  },
  "rawProperties": [
    {
      "name": "textures",
      "value": "ewogICJ0aW1lc3RhbXAiIDogMTcxMzY3MDc4MTM0NSwKICAicHJvZmlsZUlkIiA6ICJlZWFiNWY4YTE4ZGQ0ZDU4YWY3ODJiM2M0NTQzZGE0OCIsCiAgInByb2ZpbGVOYW1lIiA6ICJJbUZhc2NpbmF0ZWQiLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYmExZTBjOWUyMTk4M2MwNmU0NTYxNDY0MjMxNmNkNzAyOWEyOTdiYzI0NmJjNmQyMzZhNDEzODhjM2ZmOWEwOSIsCiAgICAgICJtZXRhZGF0YSIgOiB7CiAgICAgICAgIm1vZGVsIiA6ICJzbGltIgogICAgICB9CiAgICB9LAogICAgIkNBUEUiIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlLzIzNDBjMGUwM2RkMjRhMTFiMTVhOGIzM2MyYTdlOWUzMmFiYjIwNTFiMjQ4MWQwYmE3ZGVmZDYzNWNhN2E5MzMiCiAgICB9CiAgfQp9",
      "signed": false
    }
  ]
}

Errors

Status Code Description
400 The username is invalid.
404 The player was not found.
429 The Mojang API rate limit has been exhausted.