NFT (ERC-721 or compatible)

100 credits per API call on Flow
2 credits per API call on the other blockchains

Deploy an NFT smart contract on the blockchain. In a deployed NFT smart contract, you can mint NFTs (one NFT at a time or multiple NFTs at once), burn, and transfer NFTs.
Smart contracts are standardized and audited.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

By default, an NFT smart contract is deployed as a general ERC-721 smart contract compatible with OpenSea royalties. This is a standard ERC-721 contract with AccessControl and Ownable, enhanced with NFT batch minting. NFTs minted in this smart contract are compatible with OpenSea and its royalty structure.

In addition to the general ERC-721 contract, you can also deploy the following types of NFT smart contracts for the supported blockchains except for Flow and TRON:

• Cashback ERC-721 smart contract is an ERC-721 smart contract that forces on-chain royalties to be paid every time an NFT is transferred. The royalties are defined as a fixed value and are not OpenSea-compatible.
  To deploy an NFT smart contract as a cashback contract, deploy the contract with the cashback parameter set to true in the request body.
• Provenance ERC-721 smart contract is an ERC-721 smart contract that forces on-chain royalties to be paid every time an NFT is transferred. The royalties are defined as a percentage of the NFT price and are not OpenSea-compatible.
  To deploy an NFT smart contract as a provenance contract, deploy the contract with the provenance parameter set to true in the request body.

You can enable public minting for cashback and provenance smart contracts. By default, public minting is disabled, which means that only the blockchain address whose private key was used to create the smart contract or the blockchain addresses added to the smart contract as NFT minters will be able to mint NFTs for the contract. To enable public minting and allow anyone to mint NFTs on top of the smart contract, deploy the contract with the publicMint parameter set to true in the request body.

You can review the code of a deployed NFT smart contract here (if the contract is deployed on Flow) or here (if the contract is deployed on any other supported blockchain).

Signing a transaction

When deploying an NFT smart contract, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

100 credits per API call on Flow
2 credits per API call on the other blockchains

You can mint NFTs using either of the following methods:

• Using NFT Express
• Natively on a blockchain

Minting NFTs using NFT Express

NFT Express is Tatum's feature that helps you mint NFTs easier than minting natively on a blockchain.

• You do not need to enter your private key or signature ID.
  NFT Express uses the private key provided by Tatum.
• You do not need to hold crypto or keep addresses topped up with crypto to pay for minting transactions.
  • To use NFT Express on the mainnet, you have to have a paid pricing plan.
    Tatum covers your transaction fees for NFT minting and pays for them from its own blockchain address. Then, the fee amount paid by Tatum is converted to the number of credits, and these credits are deducted from the monthly credit allowance of your paid pricing plan.
    The transaction fees and the corresponding numbers of credits deducted from your allowance vary depending on what blockchain you mint NFTs on.
  • On the testnet, no credits are deducted from the monthly credit allowance. You can mint NFTs with NFT Express regardless of your pricing plan.

With NFT Express, you can choose whether to mint NFTs on the pre-built NFT smart contract provided by Tatum or on your own smart contract.

Minting NFTs using the pre-built smart contract provided by Tatum

If you want to mint NFTs using the pre-built smart contract, you do not need to deploy your own NFT smart contract. You do not need to provide the address of the NFT smart contract and the token ID in the request body either. The address of the smart contract and the token ID are provided automatically by Tatum.
The token ID is autogenerated. It starts with 0 and is increased by 1 for each new NFT. The token ID is calculated separately for each supported blockchain and its mainnet and testnet.

You can mint NFTs on the pre-built smart contract provided by Tatum on the following blockchains:

• Algorand
• BNB Smart Chain
• Celo
• Ethereum
• Harmony
• Klaytn
• Polygon
• Solana

Depending on what blockchain you use, choose the request body schema to use in the API call.

• To mint NFTs on BNB Smart Chain, Celo, Ethereum, Harmony, Klaytn, or Polygon, use this API with the MintNftExpress schema of the request body.
• To mint NFTs on Algorand, use this API with the MintNftExpressAlgorand schema of the request body.
  An NFT minted on Algorand is automatically transferred to your blockchain address. After the NFT is minted, you have to transfer it to the recipient's address. The recipient has to agree in advance to receive your NFT because Algorand charges users for storing NFTs on their addresses, and an Algorand blockchain address by default does not receive NFTs unless explicitly agreed.
  This how it works:
  1. The recipient agrees to receive the NFT to their address.
  2. You transfer the NFT to the recipient's address (use the transferNftAlgoExpress schema of the request body).
     NOTE: On the mainnet, Tatum covers your transaction fees for the NFT transfer and pays for them from its own blockchain address. Then, the fee amount paid by Tatum is converted to the number of credits, and these credits are deducted from the monthly credit allowance of your paid pricing plan. On the testnet, no credits are deducted from the monthly credit allowance.
• To mint NFTs on Solana, use this API with the MintNftExpressSolana schema of the request body.
  Solana uses the Metaplex Protocol, a smart contract and metadata standard for creating and working with NFTs. When you mint an NFT on Solana with NFT Express, the pre-built smart contract based on the Metaplex Protocol is used.
  When an NFT is minted on Solana, a new blockchain address is created to receive the NFT under the recipient's account address (the one in the to parameter of the request body). This address is returned in the nftAccountAddress parameter in the response body, is owned by the recipient's address, and has the same private key.
  The response body also returns the address of the minted NFT itself, which is held in the nftAddress parameter.
  After the NFT is minted, you have to transfer it to the recipient's address (use the transferNftSolana or transferNftSolanaKMS schema of the request body). In the request body:
  • Set the contractAddress parameter to the address from the nftAddress parameter in the response body of the minting call.
  • Set both from and to parameters to the recipient's address from the to parameter in the response body of the minting call.

Minting NFTs with NFT Express using your own smart contract

If you want to mint NFTs using your own smart contract, you are going to use an NTF minter, a special blockchain address provided by Tatum that will cover the minting fees. The number of credits equivalent to the fees will be then deducted from the monthly credit allowance of your paid pricing plan.

You can mint NFTs on your own smart contract on the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Harmony
• Klaytn
• Polygon

To mint NFTs using your own smart contract, do the following:

1. In the table located under this section, find the blockchain address of the Tatum NFT minter for your blockchain and network (mainnet or testnet).
2. Add the minter address as an NFT minter to your smart contract.
3. Use this API with the MintNftMinter schema of the request body.
   In the request body, enter the following information:
   • chain is the blockchain that you use.
   • to is the blockchain address where to send the minted NFT to.
   • url is the URL of the NFT metadata.
   • minter is the address of the NFT minter that you found in Step 1.
   • contractAddress is the address of your NFT smart contract.
   • tokenId is the the token ID of the NFT.
     For example:

     {
       "chain": "CELO",
       "to": "0x8ce4e40889a13971681391aad29e88efaf91f784",
       "url": "ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj",
       "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
       "tokenId": "0123",
       "minter": "0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F"
     }
     

     When you make an API call with this request body, the private key of the NFT minter will be added to the request body automatically:

     {
       "chain": "CELO",
       "to": "0x8ce4e40889a13971681391aad29e88efaf91f784",
       "url": "ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj",
       "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
       "tokenId": "0123",
       "minter": "0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F",
       "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
     }
     

The following table lists the blockchain addresses of the Tatum NFT minters for the testnet and mainnet of the supported blockchains:

Blockchain	Minter address - testnet*	Minter address - mainnet
BNB Smart Chain	0xc16ae5e8c985b906935a0cadf4e24f0400531883	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94
Celo	0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94
Ethereum	0x53e8577C4347C365E4e0DA5B57A589cB6f2AB848	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94
Harmony	0x8906f62d40293ddca77fdf6714c3f63265deddf0	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94
Klaytn	0x80d8bac9a6901698b3749fe336bbd1385c1f98f2	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94
Polygon	0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5	0x49678AAB11E001eb3cB2cBD9aA96b36DC2461A94

*If a minter blockchain address on the testnet does not have sufficient funds to cover the transaction fee, add some amount to it using a crypto faucet of the blockchain.

Minting NFTs natively on a blockchain

When minting an NFT natively on a blockchain, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

You can mint NFTs natively on the following blockchains:

• Algorand
• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• Solana
• TRON

Depending on what blockchain you use, choose the request body schema to use in the API call.

• To mint NFTs natively on Algorand and:
  • To sign the transaction with your private key, use this API with the MintNftAlgorand schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftAlgorandKMS schema of the request body.
    NOTE: An NFT minted on Algorand is automatically transferred to your blockchain address. After the NFT is minted, you have to transfer it to the recipient's address. The recipient has to agree in advance to receive your NFT because Algorand charges users for storing NFTs on their addresses, and an Algorand blockchain address by default does not receive NFTs unless explicitly agreed. For more information about how it works, see the section about minting NFTs on Algorand using the pre-built NFT smart contract provided by Tatum.
• To mint NFTs natively on BNB Smart Chain, Ethereum, Harmony, Klaytn, KuCoin Community Chain, or Polygon, and:
  • To sign the transaction with your private key, use this API with the MintNft schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftKMS schema of the request body.
• To mint NFTs natively on Celo and:
  • To sign the transaction with your private key, use this API with the MintNftCelo schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftKMSCelo schema of the request body.
• To mint NFTs natively on Flow and:
  • To sign the transaction with your private key, use this API with the MintNftFlowPK schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftFlowMnemonic schema of the request body.
  • To sign the transaction with your wallet mnemonic, use this API the MintNftFlowKMS schema of the request body.
• To mint NFTs natively on Solana and:
  • To sign the transaction with your private key, use this API with the MintNftSolana schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftSolanaKMS schema of the request body.
    NOTE: When an NFT is minted on Solana, a new blockchain address is created to receive the NFT under the recipient's account address. After the NFT is minted, you have to transfer it to the recipient's address. For more information about how it works, see the section about minting NFTs on Solana using the pre-built NFT smart contract provided by Tatum.
• To mint NFTs natively on TRON and:
  • To sign the transaction with your private key, use this API with the MintNftTron schema of the request body.
  • To sign the transaction with your signature ID, use this API the MintNftKMSTron schema of the request body.

100 credits per API call on Flow
2 credits per API call on the other blockchains

Transfer an NFT from the smart contract (the contractAddress parameter in the request body) to the specified blockchain address (the to parameter in the request body).

In one API call, you can transfer only one NFT.

This API is supported for the following blockchains:

• Algorand
• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• Solana
• TRON

For Ethereum, Celo, and BNB Smart Chain, transferring NFTs invokes the safeTransfer() method.

Transferring NFTs on Algorand

• On Algorand, the recipient has to agree in advance to receive your NFT because Algorand charges users for storing NFTs on their addresses, and an Algorand blockchain address by default does not receive NFTs unless explicitly agreed. Before transferring an NFT, make sure that the recipient has agreed to receive the NFT to their address.
• If you want to transfer an NFT that was minted using NFT Express, use the transferNftAlgoExpress schema of the request body.
  NOTE: On the mainnet, Tatum covers your transaction fees for the NFT transfer and pays for them from its own blockchain address. Then, the fee amount paid by Tatum is converted to the number of credits, and these credits are deducted from the monthly credit allowance of your paid pricing plan. On the testnet, no credits are deducted from the monthly credit allowance.

Transferring NFTs on Solana

If you want to transfer an NFT that was minted using NFT Express, see the section about minting NFTs on Solana using the pre-built NFT smart contract provided by Tatum for the information about how to set up the parameters in the request body.

Signing a transaction

When transferring an NFT, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

NOTE: This does not apply to transferring NFTs that were minted on Algorand using NFT Express (see earlier in this section).

100 credits per API call on Flow
2 credits per API call on the other blockchains

Create multiple NFT Tokens and transfer them to destination account. Create and transfer any NFT tokens from smart contract defined in contractAddress.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

This operation works in two modes.

First mode works just like other NFT endpoints. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

Second mode enables you to mint on any custom NFT ERC-721 smart contract, on which specified minter address is approved as a minter. You don't specify private key or signatureId, only minter address, from which the NFT will be minted.
It means you perform mint multiple NFT request with following body:

{
   "to": ["0x80d8bac9a6901698b3749fe336bbd1385c1f98f2"],
   "url": ["ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj"],
   "tokenId": ["9876541124516"],
   "contractAddress":"0xcd2ada00c48a27faa5cc67f9a1ed55b89ddf7f77",
   "minter": "0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5",
   "chain": "MATIC"
}

The blockchain fee of the performed transaction is paid from the address connected with built-in private key and is debitted in form of credits. The credits are debitted only if NFT mint requests are performed with paid API key plan. We transform fee to the credits in accordance to the rates provided by the Tatum. If you want to batch mint on ERC-721 contract which is not deployed via Tatum API, your smart contract must contain this method:

mintMultiple(address[] to, uint256[] tokenId, string[] uri): boolean

You can use addresses specified in the bellow table to be used as a minter.

Chain	Testnet address	Mainnet Address
MATIC	0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5	0xcf9e127455d28e7362380aec1b92ddee8200b295
BSC	0xc16ae5e8c985b906935a0cadf4e24f0400531883	0xcf9e127455d28e7362380aec1b92ddee8200b295
ONE	0x8906f62d40293ddca77fdf6714c3f63265deddf0	0xcf9e127455d28e7362380aec1b92ddee8200b295
ETH	0x53e8577C4347C365E4e0DA5B57A589cB6f2AB848	0xcf9e127455d28e7362380aec1b92ddee8200b295
CELO	0xBC2eBA680EE50d685cc4Fe65f102AA70AfB27D3F	0xcf9e127455d28e7362380aec1b92ddee8200b295
KLAY	0x80d8bac9a6901698b3749fe336bbd1385c1f98f2	0xcf9e127455d28e7362380aec1b92ddee8200b295

If there are not enough coins on any testnet address, feel free to send coins there.

100 credits per API call on Flow
2 credits per API call on the other blockchains

Burn one NFT Token. This method destroys any NFT token from smart contract defined in contractAddress.

This API is supported for the following blockchains:

• Algorand
• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

Signing a transaction

When burning an NFT, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

2 credits per API call

Add new minter of NFT Tokens. This method adds minter permission to new minter address.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon

Signing a transaction

When adding an NFT minter, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

2 credits per API call

Verify an NFT in an NFT collection on Solana. Verifying an NFT sets the Verified parameter to true for the NFT, which means that the NFT is really a part of the collection. To know more about Solana collections and verification, refer to the Solana user documentation.

The collection must be a sized collection that was introduced in Version 1.3 of the Metaplex Token Metadata program. The NFT must have been minted in this collection.

This API is supported only for Solana.

Signing a transaction

When verifying an NFT, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

2 credits per API call

Update royalty cashback value for one NFT Token. This method updates the first royalty value of specific author for 1 token. If royalty value is set to 0, it will disable the royalty system for the token. Only from author's address of the royalty can change it's royalty value, not the owner of the token.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

Signing a transaction

When updating NFT royalty, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

1 credit per API call

Get incoming and outgoing NFT transactions on a blockchain address.

This API is supported for the following blockchains:

• Celo
• Ethereum
• Polygon

1 credit per API call

Get NFT transactions by token. This includes incoming and outgoing transactions for the token.

This API is supported for the following blockchains:

• Celo
• Ethereum
• Polygon

1 credit per API call

Get NFT transaction by transaction hash.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

1 credit per API call + 5 credits for each owned NFT

Get all NFTs that a blockchain address holds. The NFTs are returned grouped by the smart contracts they were minted on.

This API is supported for the following blockchains:

• Algorand
• Celo
• Ethereum
• Polygon
• Solana

On Solana and Algorand, if a blockchain address holds fewer than 50 NFTs, the API also returns each NFT's metadata. If the metadata is not returned, you can obtain it using the API for getting NFT metadata.

1 credit per API call + 5 credits for each listed NFT

Get all minted NFTs in the collection. Returns all NFTs this contract minted.

This API is supported for the following blockchains:

• Celo
• Ethereum
• Polygon

1 credit per API call

Get the NFTs minted on a specific smart contract (the contractAddress path parameter in the request endpoint URL) that a blockchain address holds.

NOTE: This API works only for the NFT smart contracts deployed using the Tatum smart contract API.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• Solana
• TRON
• Algorand

1 credit per API call

Get NFT token provenance data, valid only for provenance contract.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon

1 credit per API call

Get NFT token metadata.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

1 credit per API call

Get NFT token royalty.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON

This endpoint is deprecated. Do not use it.
Instead, use this API.

1 credit per API call

Get NFT contract address from deploy transaction.

This API is supported for the following blockchains:

• BNB Smart Chain
• Celo
• Ethereum
• Flow
• Harmony
• Klaytn
• KuCoin Community Chain
• Polygon
• TRON