List Badges

List badges owned by an address

Retrieves a list of badges owned by a specific address.

Endpoint: /game/badge/list Method: GET

Request Parameters

{
    nft: string;              // Badge contract address
    address: string;          // Address to list badges for
    page?: number;            // Optional page number (default: 1)
    limit?: number;           // Optional items per page (default: 20)
}

Success Response

{
    data: {
        items: {
            tokenId: string;          // Badge ID
            owner: string;            // Current owner address
            metadata: {               // Badge metadata
                name: string;
                description?: string;
                image?: string;
                attributes?: object[];
            };
            createdAt: string;        // Creation timestamp
            updatedAt: string;        // Last update timestamp
        }[];
        total: number;               // Total number of badges
        page: number;                // Current page
        limit: number;               // Items per page
    }
    status: string;
}

Error Response

{
  error: string;
  details?: any;
}

Example Usage

// Setup request parameters
const timestamp = Date.now().toString();
const params = {
    nft: '0x1234567890123456789012345678901234567890', // Badge contract address
    address: '0xabcdef1234567890abcdef1234567890abcdef', // Address to list badges for
    page: 1,
    limit: 20
};

// Generate HMAC signature
const hmac = generateHmacSignature(timestamp, params, secretKey);

// Make the API request
const response = await axios.get(apiEndpoint + '/game/badge/list', {
    params,
    headers: {
        apikey: apiKey,
        signature: hmac,
        timestamp: timestamp
    }
});

// Process the response
console.log('Total Badges:', response.data.data.total);
console.log('Badges:', response.data.data.items);