Frontend/documentation/player/username-to-uuid.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

46 lines
1.0 KiB
Markdown

---
title: Player Username to UUID
summary: Get a player's UUID from their username.
---
# Overview
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. |