Errors
Errors use standard HTTP status codes and always share the same JSON shape.
Error format
Every error response has an error object with the HTTPstatus and a human readable message.
Status codes
| Status | Meaning |
|---|---|
200 | Success. |
201 | API key created. |
400 | Invalid request: unknown parameter, or a value out of range. |
401 | The X-API-Key header is missing, or the key is invalid or revoked. |
404 | The item or route does not exist, or no item matches the filters of /random. |
500 | Unexpected server error. |
Examples
Missing API key · 401
{
"error": {
"status": 401,
"message": "Missing API key. Send it in the X-API-Key header"
}
}Unknown parameter · 400
{
"error": {
"status": 400,
"message": "Invalid query parameter(s): elemnt. Allowed: name, rarity, element, weaponType, region, gender, bodyType, releaseVersion, localSpecialty, ascensionStat, material, limit, offset, sort"
}
}Invalid value · 400
{
"error": {
"status": 400,
"message": "\"limit\" must be an integer between 1 and 100"
}
}Item not found · 404
{
"error": {
"status": 404,
"message": "characters/paimon not found"
}
}