PLYR GAMING UNIVERSE
  • API Endpoint
  • API Quickstart
  • API REFERENCE
    • Users
      • Authentication
        • PLYR[ID]
          • Login
          • Login and Approve
          • Logout
        • InstantPlayPass
          • RegisterIPP
          • RevealClaimingCode
          • VerifyClaimingCode
        • PLYR[CONNECT]
      • Check Session JWT
      • Get Basic User Info
      • Get Avatar
    • Game room
      • Create Game Room
      • Join Game Room
      • Pay Game Room
      • Earn Game Room
      • Leave Game Room
      • End Game Room
      • Helpers
        • Is Joined Game Room
        • Join and Pay
        • Earn and Leave
        • Create, Join and Pay
        • Earn, Leave and End
    • Assets
      • Tokens ( ERC-20 )
        • Get PLYR L1 Token List
        • Get User Token Balance
        • Get User Token Allowance
        • Approve User Token Spending
        • Revoke User Token Allowance
        • In-Game Chips
          • Create Chip
          • Mint Chip
          • Burn Chip
          • Transfer Chip
          • Get Chip Balance
          • Get Chip Info
      • NFTs ( ERC-721 )
        • Create NFT
        • Mint NFT
        • Transfer NFT
        • Burn NFT
        • Get NFT Balance
        • List NFTs
        • Check NFT Holding
        • Get NFT Credit
        • Get NFT Info
        • Get Zoo Genes
        • Official PLYR NFTs
          • Get User Zoo Genes
          • Get User Zoo Boosters
          • Get User Zoo Elixirs
      • Badge
        • Create Badge
        • Mint Badge
        • Remove Badge
        • Burn Badge
        • Transfer Badge
        • Get Badge Balance
        • List Badges
        • Get Badge Info
        • Get Badge Count
        • Get Badge by ID
        • Get Badge Owner
        • Check Badge Burn Status
    • Misc
      • Get Session JWT Public Key
      • Verify JWT Locally
      • Activity Logs
      • Get Task Message Status
Powered by GitBook
On this page
  1. API REFERENCE
  2. Assets
  3. Badge

Create Badge

Create a new badge

Creates a new badge with specified metadata.

Endpoint: /game/badge/create Method: POST

{
    name: string;             // Name of the badge
    symbol: string;           // Symbol of the badge
    description?: string;     // Optional description of the badge
    image?: string;          // Optional image URL for the badge
    attributes?: object[];    // Optional array of attributes
    chainId?: string;        // Optional chain ID (defaults to configured chain ID)
}
{
    taskId: string;
    data: {
        contractAddress: string; // The address of the created badge contract
        transactionHash: string; // The hash of the creation transaction
    }
    status: string;
}
{
  error: string;
  details?: any;
}

Example Usage

// Setup request parameters
const timestamp = Date.now().toString();
const body = {
    name: 'Game Achievement Badge',
    symbol: 'GAB',
    description: 'Badge awarded for game achievements',
    image: 'https://example.com/badge.png',
    attributes: [
        { trait_type: 'Type', value: 'Achievement' },
        { trait_type: 'Version', value: '1.0' }
    ],
    chainId: '43114' // Avalanche C-Chain
};

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

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

// Process the response
console.log('Create Task ID:', response.data.taskId);
console.log('Contract Address:', response.data.data.contractAddress);
console.log('Transaction Hash:', response.data.data.transactionHash);
PreviousBadgeNextMint Badge

Last updated 11 days ago