Configuration Generator

Endpoint description

Get information about the specified player

Endpoint route

Response type

Application/Json

Header parameters

Query 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
{
    "exists": bool,
    "entityID": int,        // For key-advanced : only with admin-key
    "firstPlayed": long,
    "lastPlayed": long,
    "uniqueID": string,     // For key-advanced : only with admin-key
    "name": string,
    "ping": int,            // For key-advanced : only with admin-key
    "allowFlight": bool,    // For key-advanced : only with admin-key
    "online": bool,
    "exhaustion": float,
    "exp": float,
    "foodLevel": int,
    "health": float,
    "level": int,
    "banned": bool,         // For key-advanced : only with admin-key
    "op": bool,
    "whitelisted": bool,    // For key-advanced : only with admin-key
    "World": string,        // For key-advanced : only with admin-key
    "posX": int,            // For key-advanced : only with admin-key
    "posY": int,            // For key-advanced : only with admin-key
    "posZ": int             // For key-advanced : only with admin-key
}

// - If the player is offline
{
    "exists": bool,
    "firstPlayed": long,
    "lastPlayed": long,
    "uniqueID": string,     // For key-advanced : only with admin-key
    "name": string,
    "online": bool,
    "banned": bool,         // For key-advanced : only with admin-key
    "op": bool,
    "whitelisted": bool     // For key-advanced : only with admin-key
}

Error response

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

Return codes