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
        • List Badges
        • Get Badge Info
    • Misc
      • Get Session JWT Public Key
      • Verify JWT Locally
      • Activity Logs
      • Get Task Message Status
Powered by GitBook
On this page
  • Available Endpoints
  • Creation
  • Minting
  • Management
  • Queries
  • Authentication
  • Chain ID
  1. API REFERENCE
  2. Assets

Badge

Overview of Badge API endpoints

The Badge API provides endpoints for managing game badges (ERC-721 tokens) in the system. These endpoints allow you to create, mint, transfer, burn, and query badge information.

Available Endpoints

Creation

  • Create Badge - Create a new badge

  • Create Badge by Signature - Create a badge using a signature

Minting

  • Mint Badge - Mint a badge to a recipient

Management

  • Remove Badge - Remove a badge

  • Remove Badge by Signature - Remove a badge using a signature

  • Burn Badge - Burn a badge

  • Transfer Badge - Transfer a badge to another address

Queries

  • Get Badge Balance - Get badge balance for an address

  • List Badges - List badges owned by an address

  • Get Badge Info - Get detailed information about a badge

  • Get Badge Count - Get total count of badges

  • Get Badge by ID - Get badge information by ID

  • Get Badge Owner - Get the owner of a badge

  • Check Badge Burn Status - Check if a badge is burnt

Authentication

All endpoints require HMAC authentication using the hmacAuth('user') middleware. Make sure to include the following headers in your requests:

  • apikey: Your API key

  • signature: HMAC signature

  • timestamp: Current timestamp

Chain ID

Most endpoints require a chain ID to be specified. This can be done either in the request body or through the checkChainId middleware.

PreviousGet User Zoo ElixirsNextCreate Badge

Last updated 1 month ago