mostly completed docs
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s

This commit is contained in:
Lee
2024-04-21 05:47:52 +01:00
parent 3b1872a9dc
commit e6a28ed268
18 changed files with 733 additions and 183 deletions

View File

@ -0,0 +1,41 @@
---
title: Server - Favicon
summary: Get the favicon of a Minecraft server.
---
# Server - Favicon
The server favicon endpoint allows you to get the favicon of a Minecraft server.
## Endpoint
```
GET /server/:query
```
## Platforms
This endpoint is only available for Java servers.
## Parameters
| Parameter | Description | Required |
|-----------|---------------------------------------------------------------------------|----------|
| query | The IP address or hostname of the server you want to get the favicon for. | Yes |
## Example
```bash
curl -X GET "https://api.mcutils.xyz/server/icon/hypixel.net" -H "accept: image/png"
```
## Response
![Server Icon](https://api.mcutils.xyz/server/icon/play.hypixel.net)
## Errors
| Status Code | Description |
|-------------|-----------------------------------------------|
| 400 | The server was not found. |
| 429 | The Mojang API rate limit has been exhausted. |