mostly completed docs
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s
This commit is contained in:
68
documentation/player/player-lookup.md
Normal file
68
documentation/player/player-lookup.md
Normal file
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Player Lookup
|
||||
summary: Get information about a player.
|
||||
---
|
||||
|
||||
# Player Lookup
|
||||
|
||||
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
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.mcutils.xyz/player/imfascinated" -H "accept: application/json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
"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. |
|
47
documentation/player/skin-parts.md
Normal file
47
documentation/player/skin-parts.md
Normal file
@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Player - Skin Parts
|
||||
summary: Get a specific part of a player's skin.
|
||||
---
|
||||
|
||||
# Player - Skin Parts
|
||||
|
||||
The player skin parts endpoint allows you to get a specific part of a player's skin.
|
||||
|
||||
## Endpoint
|
||||
|
||||
```
|
||||
GET /player/:part/:query
|
||||
```
|
||||
|
||||
## Parts
|
||||
|
||||
| Part | Description |
|
||||
|------|-----------------------|
|
||||
| head | Get the player's head |
|
||||
| face | Get the player's face |
|
||||
| body | Get the player's body |
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Description | Required |
|
||||
|-----------|---------------------------------------------------------|----------|
|
||||
| part | The part of the skin you want to get. | Yes |
|
||||
| query | The username or uuid of the player you want to look up. | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.mcutils.xyz/player/head/imfascinated" -H "accept: image/png"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||

|
||||
|
||||
## Errors
|
||||
|
||||
| Status Code | Description |
|
||||
|-------------|-----------------------------------------------|
|
||||
| 400 | The username is invalid. |
|
||||
| 404 | The player was not found. |
|
||||
| 429 | The Mojang API rate limit has been exhausted. |
|
46
documentation/player/username-to-uuid.md
Normal file
46
documentation/player/username-to-uuid.md
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Player - Username to UUID
|
||||
summary: Get a player's UUID from their username.
|
||||
---
|
||||
|
||||
# Player - Username to UUID
|
||||
|
||||
The player username to UUID endpoint allows you to get a player's UUID from their username.
|
||||
|
||||
## Endpoint
|
||||
|
||||
```
|
||||
GET /player/uuid/:query
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Description | Required |
|
||||
|-----------|---------------------------------------------------------|----------|
|
||||
| query | The username of the player you want to look up. | Yes |
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.mcutils.xyz/player/uuid/imfascinated" -H "accept: application/json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
"cache": {
|
||||
"cached": false,
|
||||
"cachedTime": -1
|
||||
},
|
||||
"uniqueId": "eeab5f8a-18dd-4d58-af78-2b3c4543da48",
|
||||
"username": "ImFascinated"
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status Code | Description |
|
||||
|-------------|-----------------------------------------------|
|
||||
| 400 | The username is invalid. |
|
||||
| 429 | The Mojang API rate limit has been exhausted. |
|
Reference in New Issue
Block a user