For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Basic User Info

Get basic user information endpoint

Retrieve basic user information. Can query by PLYR ID or primary wallet address.

Endpoint: /user/info/{identifier} Method: GET

{
    identifier: string; // PLYR ID or primary wallet address
}
{
    plyrId: string;
    username: string;
    walletAddress: string;
    avatarUrl: string;
}
{
    error: string;
}

Example Usage

const timestamp = Date.now().toString();
// Can use either PLYR ID or wallet address
const identifier = 'player123'; // or '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'

// Since this is a GET request with no body, pass null as the body for HMAC
const hmac = generateHmacSignature(timestamp, null, secretKey);

const response = await axios.get(apiEndpoint + `/user/info/${identifier}`, {
    headers: {
        apikey: apiKey,
        signature: hmac,
        timestamp: timestamp
    }
});

// Response will contain basic user information
const { plyrId, username, walletAddress, avatarUrl } = response.data;

The identifier can be either a PLYR ID or a wallet address. The API will automatically detect which type it is and return the corresponding user information.

Last updated