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
  • Available Endpoints
  • Creation
  • Minting
  • Management
  • Queries
  • Authentication
  • Chain ID
  1. API REFERENCE
  2. Assets

Badge

Overview of Badge API endpoints

PreviousGet User Zoo ElixirsNextCreate Badge

Last updated 11 days ago

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 a new badge

  • - Create a badge using a signature

Minting

  • - Mint a badge to a recipient

Management

  • - Remove a badge

  • - Remove a badge using a signature

  • - Burn a badge

  • - Transfer a badge to another address

Queries

  • - Get badge balance for an address

  • - List badges owned by an address

  • - Get detailed information about a badge

  • - Get total count of badges

  • - Get badge information by ID

  • - Get the owner of a badge

  • - 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.

Create Badge
Create Badge by Signature
Mint Badge
Remove Badge
Remove Badge by Signature
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