Configuration Generator

Endpoint description

Get information about the specified player

[Updated]
- This is now possible to find a player by UUID
- This endpoint now returns player IP address for admin keys

Endpoint route

Response type

Application/Json

Header parameters

Query Parameters

No parameters

Body parameters

No parameters

Access rights

Authentication type	Key type	Allowed
Open
Basic
Key-Basic
Key-Advanced	Public key
Key-Advanced	Protected key
Key-Advanced	Admin key

Success response

// - If the player is online

{
    "entityID": int,                // - For Admin keys only
    "firstPlayed": timestamp,
    "lastPlayed": timestamp,
    "uniqueID": string,             // - For Admin keys only
    "name": string,
    "ping": int,                    // - For Admin keys only
    "allowFlight": bool,            // - For Admin keys only
    "online": bool,
    "exhaustion": float,
    "exp": float,
    "foodLevel": float,
    "health": float,
    "level": int,
    "banned": bool,                 // - For Admin keys only
    "op": bool,                     // - For Admin keys only
    "whitelisted": bool,            // - For Admin keys only
    "World": string,                // - For Admin keys only
    "posX": int,                    // - For Admin keys only
    "posY": int,                    // - For Admin keys only
    "posZ": int,                    // - For Admin keys only
    "ip": string                    // - For Admin keys only
}

// - If the player is offline

{
    "firstPlayed": timestamp,   
    "lastPlayed": timestamp,
    "uniqueID": string,             // - For Admin keys only
    "name": string,
    "online": bool,
    "banned": bool,                 // - For Admin keys only
    "op": bool,
    "whitelisted": bool             // - For Admin keys only
}

Error response

{
    "success": bool,
    "code": int,
    "message": string
}

Return codes