ZooGames API Guide
Ask or search…
Comment on page

In-game NFTs (ERC721)

Custom NFT Tokens generated in-game
In-Game NFTs are ERC721 tokens that offer transparency in minting and transactions. They enable games to create virtual assets without the pain of deploying a smart contract. Developers can easily create In-Game NFTs using ZooGames API and control them securely.

Use Cases

  1. 1.
    Virtual Assets: Earn or purchase In-Game NFTs for in-game items, upgrades, or unlocking levels.
  2. 2.
    In-Game Economy: engage in player-driven economies within the game.
  3. 3.
    Reward System: Distribute NFTs as rewards for achievements, competitions, or milestones.
  4. 4.
    Social Interaction: Gift or trade NFTs, foster community engagement.
  5. 5.
    Airdrops and Promotions: Airdrop NFTs to players, attract new users or introduce special events.
  6. 6.
    Limited Edition Collectibles: Create rare NFTs for trading and collecting.
You can choose to send In-Game NFTs to either the Mirror wallet or the Primary wallet of users. Sending NFTs to the Primary wallet allows users to trade them on our official NFT store, OPENZOO.IO. Once your NFT collection is registered, you can add them to Openzoo and claim transaction royalties.

Initiating In-Game NFTs Creation

To create an In-Game NFTs token using the ZooGames API, you can follow these steps:
  1. 1.
    Send a request to the API endpoint, providing the desired Token name and symbol in the request payload.
  2. 2.
    The API will process your request and generate a new In-Game NFTs token with the specified Token name and symbol.
  3. 3.
    Upon successful creation, you will receive a response containing relevant information about the newly created token, such as its contract address and other necessary details.
  4. 4.
    You can now incorporate this In-Game NFTs token into your game environment, allowing players to interact with and own unique virtual assets.
Initialize ERC721 before using the token

Batch Mint

This function empowers game developers to generate new NFT tokens on-demand, granting them flexibility and control over the in-game economy. You have the ability to mint NFTs in batches using an array.
Mint Tokens by batch
Please ensure that only unique TokenIDs are used when minting NFTs, or if you are using a running number system, make sure to use the latest TokenIDs to maintain uniqueness.

Batch Burn

This function enables game developers to remove existing NFT tokens from circulation, granting them control over the in-game economy and token supply. You can burn NFTs in batches using an array, effectively eliminating them from the system and ensuring their scarcity and value.
Burn Tokens by amount from ZooGamesID
Please ensure that each minted NFT has a unique token ID and avoids reusing any duplicate IDs, regardless of whether the ID has been previously burned. This will ensure the uniqueness and integrity of the NFTs within the system.

Total Mint count

The Total Mint Count API retrieves the total number of operations in your collection. By making a request to this API, you can obtain the count of NFTs operations that have been minted for a specific collection, providing valuable information about the size and scale of your collection.
Token Minted Counter operation (Not NFT supply)

Get user In-Game NFTs

The Get In-Game NFTs API allows you to retrieve In-Game NFTs based on either the user's ZooGamesID or their Primary Address. You can use this API to obtain multiple NFT collections associated with a user, providing access to their owned NFTs within the game ecosystem.
/API_KEY/userInfo/nft/inGameNft/[ZooGamesID or Address]
Retrieve the list of In-Game items based on the ZooGamesID or Primary Address.
Currently, this API supports retrieving the list of NFTs based on the ZooGamesID and Primary Address or any other addresses associated with the user. However, it does not provide the functionality to fetch the list of linked Secondary addresses by the ZooGamesID.