Download OpenAPI specification:Download
This is the official Hypixel API documentation. Hypixel Website - GitHub Repo - API Help Forum
API keys have a default rate limit of 120 requests per minute. If you require a higher limit please contact us via our support desk with an explanation for the increased limit and your current API key. Any abuse of the API or intentions to bypass this limit ( such as with multiple API keys) will lead to your API key being reset or banned.
ID | Type Name | Database Name | Clean Name |
---|---|---|---|
2 | QUAKECRAFT | Quake | Quake |
3 | WALLS | Walls | Walls |
4 | PAINTBALL | Paintball | Paintball |
5 | SURVIVAL_GAMES | HungerGames | Blitz Survival Games |
6 | TNTGAMES | TNTGames | TNT Games |
7 | VAMPIREZ | VampireZ | VampireZ |
13 | WALLS3 | Walls3 | Mega Walls |
14 | ARCADE | Arcade | Arcade |
17 | ARENA | Arena | Arena |
20 | UHC | UHC | UHC Champions |
21 | MCGO | MCGO | Cops and Crims |
23 | BATTLEGROUND | Battleground | Warlords |
24 | SUPER_SMASH | SuperSmash | Smash Heroes |
25 | GINGERBREAD | GingerBread | Turbo Kart Racers |
26 | HOUSING | Housing | Housing |
51 | SKYWARS | SkyWars | SkyWars |
52 | TRUE_COMBAT | TrueCombat | Crazy Walls |
54 | SPEED_UHC | SpeedUHC | Speed UHC |
55 | SKYCLASH | SkyClash | SkyClash |
56 | LEGACY | Legacy | Classic Games |
57 | PROTOTYPE | Prototype | Prototype |
58 | BEDWARS | Bedwars | Bed Wars |
59 | MURDER_MYSTERY | MurderMystery | Murder Mystery |
60 | BUILD_BATTLE | BuildBattle | Build Battle |
61 | DUELS | Duels | Duels |
63 | SKYBLOCK | SkyBlock | SkyBlock |
64 | PIT | Pit | Pit |
Games store their respective stats and data in a Player's stats
collection. The game's specific data is held within a JSON object named after it's Database Name
(seen above.)
Generally dates are stored as a Unix Epoch times in milliseconds.
Responses are served in JSON format.
All uuid parameters support both dashed and undashed versions.
Items and inventory data are stored as a base64 encoded string containing gzipped nbt data. If a method is missing important information about an item or inventory, you should try checking this!
Note: the base64 string may contain a unicode escape for non-alphabetical symbols (i.e.
=
will be displayed as=
), and some programming languages may have silent defects when interpreting the string.
{- "success": true,
- "record": {
- "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
- "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
- "limit": 120,
- "queriesInPastMin": 0,
- "totalQueries": 0
}
}
uuid required | string |
{- "success": true,
- "player": {
- "uuid": "3fa85f6457174562b3fc2c963f66afa6",
- "displayname": "string",
- "rank": "ADMIN",
- "packageRank": "MVP_PLUS",
- "newPackageRank": "MVP_PLUS",
- "monthlyPackageRank": "SUPERSTAR",
- "firstLogin": 0,
- "lastLogin": 0,
- "lastLogout": 0,
- "stats": { }
}
}
uuid required | string <uuid> |
{- "success": true,
- "uuid": "ad8fefaa8351454bb739a4eaa872173f",
- "records": [
- {
- "_id": "string",
- "uuidSender": "05405ce5-4afe-47b2-a579-0a40fdc00a8a",
- "uuidReceiver": "57cda48e-a417-4107-b2b4-74f65c7364a3",
- "started": 0
}
]
}
uuid required | string |
{- "success": true,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "games": [
- {
- "date": 0,
- "gameType": "string",
- "mode": "string",
- "map": "string",
- "ended": 0
}
]
}
uuid required | string |
{- "success": true,
- "uuid": "ad8fefaa8351454bb739a4eaa872173f",
- "session": {
- "online": true,
- "gameType": "string",
- "mode": "string",
- "map": "string"
}
}