Api/NFTERC721OrCompatibleApi

NFT (ERC-721 or compatible) API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->nFTERC721OrCompatible();

// TestNet API Call
$sdk->testnet()->api()->nFTERC721OrCompatible();

Methods

addNftMinter()

Example

#️⃣ Execute command in terminal

✨ php -f addNftMinter.php

Request

POST /v3/nft/mint/add

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->addNftMinter(
    \Tatum\Model\AddNftMinter $add_nft_minter,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Add a blockchain address as an NFT minter to an NFT smart contract

2 credits per API call

Allow a blockchain address (the minter parameter in the request body) to mint NFTs on your NFT smart contract (the contractAddress parameter in the request body).

NOTE: Use this API only when you are using NFT Express with your own smart contract. For more information, see “Use your own smart contract to mint NFTs” in Mint an NFT. Do not use this API in any other case.

This API is supported for the following blockchains:

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

Signing a transaction When allowing a blockchain address to mint NFTs, 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.

Back to top

addNftMinterKMS()

Example

#️⃣ Execute command in terminal

✨ php -f addNftMinterKMS.php

Request

POST /v3/nft/mint/add

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->addNftMinterKMS(
    \Tatum\Model\AddNftMinterKMS $add_nft_minter_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Add a blockchain address as an NFT minter to an NFT smart contract

Back to top

burnNft()

Example

#️⃣ Execute command in terminal

✨ php -f burnNft.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNft(
    \Tatum\Model\BurnNft $burn_nft,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

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

Destroy an NFT. Burning the NFT transfers it to an un-spendable blockchain address that no one can access.

This API is supported for the following blockchains:

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

Burning NFTs on Algorand You can burn only the NFTs that were minted with the address of the manager account specified in the manager parameter in the minting call (see the MintNftExpressAlgorand, MintNftAlgorand, and MintNftAlgorandKMS schemas of the request body).

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.

Back to top

burnNftAlgo()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftAlgo.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftAlgo(
    \Tatum\Model\BurnNftAlgo $burn_nft_algo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftCelo()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftCelo.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftCelo(
    \Tatum\Model\BurnNftCelo $burn_nft_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftFlowKMS()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftFlowKMS.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftFlowKMS(
    \Tatum\Model\BurnNftFlowKMS $burn_nft_flow_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftFlowMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftFlowMnemonic.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftFlowMnemonic(
    \Tatum\Model\BurnNftFlowMnemonic $burn_nft_flow_mnemonic,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftFlowPK()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftFlowPK.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftFlowPK(
    \Tatum\Model\BurnNftFlowPK $burn_nft_flow_pk,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftKMS()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftKMS.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftKMS(
    \Tatum\Model\BurnNftKMS $burn_nft_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftKMSCelo()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftKMSCelo.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftKMSCelo(
    \Tatum\Model\BurnNftKMSCelo $burn_nft_kms_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftKMSTron()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftKMSTron.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftKMSTron(
    \Tatum\Model\BurnNftKMSTron $burn_nft_kms_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

burnNftTron()

Example

#️⃣ Execute command in terminal

✨ php -f burnNftTron.php

Request

POST /v3/nft/burn

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->burnNftTron(
    \Tatum\Model\BurnNftTron $burn_nft_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Burn an NFT

Back to top

deployNft()

Example

#️⃣ Execute command in terminal

✨ php -f deployNft.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNft(
    \Tatum\Model\DeployNft $deploy_nft,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

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

This API is supported for the following blockchains:

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

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

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

• Cashback NFT smart contract is an NFT smart contract that forces on-chain royalties to be paid every time an NFT is transferred, and the royalties are defined as a fixed value. The royalties 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 NFT smart contract is an NFT smart contract that forces on-chain royalties to be paid every time an NFT is transferred, and the royalties are defined as a percentage of the NFT price. The royalties 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.

NFT smart contracts and NFT Express If you want to use NFT Express to mint NFTs on the deployed smart contract, deploy the smart contract as a general NFT smart contract (that is, deploy the contract with the cashback, provenance, and publicMint parameters either set to false or not set at all in the request body). After you have deployed the NFT smart contract, add the Tatum minter address as an NFT minter to your smart contract.

For the complete information about using NFT Express on your smart contract, see “Use your own smart contract to mint NFTs” in Mint an NFT.

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.

Back to top

deployNftCelo()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftCelo.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftCelo(
    \Tatum\Model\DeployNftCelo $deploy_nft_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftCeloKMS.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftCeloKMS(
    \Tatum\Model\DeployNftCeloKMS $deploy_nft_celo_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftFlowKMS()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftFlowKMS.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftFlowKMS(
    \Tatum\Model\DeployNftFlowKMS $deploy_nft_flow_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftFlowMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftFlowMnemonic.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftFlowMnemonic(
    \Tatum\Model\DeployNftFlowMnemonic $deploy_nft_flow_mnemonic,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftFlowPK()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftFlowPK.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftFlowPK(
    \Tatum\Model\DeployNftFlowPK $deploy_nft_flow_pk,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftKMS()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftKMS.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftKMS(
    \Tatum\Model\DeployNftKMS $deploy_nft_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftTron()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftTron.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftTron(
    \Tatum\Model\DeployNftTron $deploy_nft_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

deployNftTronKMS()

Example

#️⃣ Execute command in terminal

✨ php -f deployNftTronKMS.php

Request

POST /v3/nft/deploy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->deployNftTronKMS(
    \Tatum\Model\DeployNftTronKMS $deploy_nft_tron_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Deploy an NFT smart contract

Back to top

mintMultipleNft()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNft.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNft(
    \Tatum\Model\MintMultipleNft $mint_multiple_nft,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftCelo()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftCelo.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftCelo(
    \Tatum\Model\MintMultipleNftCelo $mint_multiple_nft_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftFlowKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftFlowKMS.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftFlowKMS(
    \Tatum\Model\MintMultipleNftFlowKMS $mint_multiple_nft_flow_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftFlowMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftFlowMnemonic.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftFlowMnemonic(
    \Tatum\Model\MintMultipleNftFlowMnemonic $mint_multiple_nft_flow_mnemonic,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftFlowPK()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftFlowPK.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftFlowPK(
    \Tatum\Model\MintMultipleNftFlowPK $mint_multiple_nft_flow_pk,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftKMS.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftKMS(
    \Tatum\Model\MintMultipleNftKMS $mint_multiple_nft_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftKMSCelo()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftKMSCelo.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftKMSCelo(
    \Tatum\Model\MintMultipleNftKMSCelo $mint_multiple_nft_kms_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftKMSTron()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftKMSTron.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftKMSTron(
    \Tatum\Model\MintMultipleNftKMSTron $mint_multiple_nft_kms_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintMultipleNftMinter()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftMinter.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftMinter(
    \Tatum\Model\MintMultipleNftMinter $mint_multiple_nft_minter,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

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 debited in form of credits. The credits are debited 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.

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

Back to top

mintMultipleNftTron()

Example

#️⃣ Execute command in terminal

✨ php -f mintMultipleNftTron.php

Request

POST /v3/nft/mint/batch

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintMultipleNftTron(
    \Tatum\Model\MintMultipleNftTron $mint_multiple_nft_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintMultipleNftMinter200Response

Parameters

Return type

\Tatum\Model\MintMultipleNftMinter200Response

Description

Mint multiple NFTs

Back to top

mintNft()

Example

#️⃣ Execute command in terminal

✨ php -f mintNft.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNft(
    \Tatum\Model\MintNft $mint_nft,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNft schema lets you mint NFTs natively on BNB Smart Chain, Ethereum, Harmony, Klaytn, KuCoin Community Chain, and Polygon and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftAlgorand()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftAlgorand.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftAlgorand(
    \Tatum\Model\MintNftAlgorand $mint_nft_algorand,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftAlgorand schema lets you mint NFTs natively on Algorand and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftAlgorandKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftAlgorandKMS.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftAlgorandKMS(
    \Tatum\Model\MintNftAlgorandKMS $mint_nft_algorand_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftAlgorandKMS schema lets you mint NFTs natively on Algorand and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftCelo()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftCelo.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftCelo(
    \Tatum\Model\MintNftCelo $mint_nft_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftCelo schema lets you mint NFTs natively on Celo and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftExpress()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftExpress.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftExpress(
    \Tatum\Model\MintNftExpress $mint_nft_express,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftExpress schema lets you mint NFTs on BNB Smart Chain, Celo, Ethereum, Harmony, Klaytn, and Polygon using NTF Express with the pre-built smart contract provided by Tatum. For more information, see “Use the pre-built smart contract provided by Tatum to mint NFTs” in Mint an NFT.

Back to top

mintNftExpressAlgorand()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftExpressAlgorand.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftExpressAlgorand(
    \Tatum\Model\MintNftExpressAlgorand $mint_nft_express_algorand,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftExpressAlgorand schema lets you mint NFTs on Algorand using NTF Express with the pre-built smart contract provided by Tatum. For more information, see “Use the pre-built smart contract provided by Tatum to mint NFTs” in Mint an NFT.

Back to top

mintNftExpressSolana()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftExpressSolana.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftExpressSolana(
    \Tatum\Model\MintNftExpressSolana $mint_nft_express_solana,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftExpressSolana schema lets you mint NFTs on Solana using NTF Express with the pre-built smart contract provided by Tatum. For more information, see “Use the pre-built smart contract provided by Tatum to mint NFTs” in Mint an NFT.

Back to top

mintNftFlowKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftFlowKMS.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftFlowKMS(
    \Tatum\Model\MintNftFlowKMS $mint_nft_flow_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftFlowKMS schema lets you mint NFTs natively on Flow and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftFlowMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftFlowMnemonic.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftFlowMnemonic(
    \Tatum\Model\MintNftFlowMnemonic $mint_nft_flow_mnemonic,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftFlowMnemonic schema lets you mint NFTs natively on Flow and sign the transaction with your wallet mnemonic. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftFlowPK()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftFlowPK.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftFlowPK(
    \Tatum\Model\MintNftFlowPK $mint_nft_flow_pk,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftFlowPK schema lets you mint NFTs natively on Flow and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftKMS.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftKMS(
    \Tatum\Model\MintNftKMS $mint_nft_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftKMS schema lets you mint NFTs natively on BNB Smart Chain, Ethereum, Harmony, Klaytn, KuCoin Community Chain, and Polygon and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftKMSCelo()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftKMSCelo.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftKMSCelo(
    \Tatum\Model\MintNftKMSCelo $mint_nft_kms_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftKMSCelo schema lets you mint NFTs natively on Celo and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftKMSTron()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftKMSTron.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftKMSTron(
    \Tatum\Model\MintNftKMSTron $mint_nft_kms_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftKMSTron schema lets you mint NFTs natively on TRON and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftMinter()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftMinter.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftMinter(
    \Tatum\Model\MintNftMinter $mint_nft_minter,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftMinter schema lets you mint NFTs on BNB Smart Chain, Celo, Ethereum, Harmony, Klaytn, and Polygon using the NTF minter, a special blockchain address provided by Tatum that will cover the minting fees. For more information, see “Use your own smart contract to mint NFTs” in Mint an NFT.

Back to top

mintNftSolana()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftSolana.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftSolana(
    \Tatum\Model\MintNftSolana $mint_nft_solana,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftSolana schema lets you mint NFTs natively on Solana and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftSolanaKMS()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftSolanaKMS.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftSolanaKMS(
    \Tatum\Model\MintNftSolanaKMS $mint_nft_solana_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftSolanaKMS schema lets you mint NFTs natively on Solana and sign the transaction with your signature ID. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

mintNftTron()

Example

#️⃣ Execute command in terminal

✨ php -f mintNftTron.php

Request

POST /v3/nft/mint

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->mintNftTron(
    \Tatum\Model\MintNftTron $mint_nft_tron,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\MintNftExpress200Response

Parameters

Return type

\Tatum\Model\MintNftExpress200Response

Description

Mint an NFT

The MintNftTron schema lets you mint NFTs natively on TRON and sign the transaction with your private key. For more information, see “Minting NFTs natively on a blockchain” in Mint an NFT.

Back to top

nftGetBalanceErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetBalanceErc721.php

Request

GET /v3/nft/balance/{chain}/{contractAddress}/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetBalanceErc721(
    string $chain,
    string $address,
    string $contract_address,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\NftGetBalanceErc721200Response

Parameters

Return type

\Tatum\Model\NftGetBalanceErc721200Response

Description

Get the NFTs from a specific smart contract that a blockchain address holds

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:

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

Back to top

nftGetMetadataErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetMetadataErc721.php

Request

GET /v3/nft/metadata/{chain}/{contractAddress}/{tokenId}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetMetadataErc721(
    string $chain,
    string $contract_address,
    string $token_id,
    [ string $account, ]
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\NftMetadataErc721

Parameters

Return type

\Tatum\Model\NftMetadataErc721

Description

Get NFT metadata

1 credit per API call

Get metadata of an NFT.

This API is supported for the following blockchains:

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

Back to top

nftGetProvenanceDataErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetProvenanceDataErc721.php

Request

GET /v3/nft/provenance/{chain}/{contractAddress}/{tokenId}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetProvenanceDataErc721(
    string $chain,
    string $contract_address,
    string $token_id,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\NftProvenanceDataErc721[]

Parameters

Return type

\Tatum\Model\NftProvenanceDataErc721[]

Description

Get NFT provenance information

1 credit per API call

Get provenance information for an NFT.

NOTE: This API works only for provenance NFT smart contracts.

This API is supported for the following blockchains:

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

Back to top

nftGetRoyaltyErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetRoyaltyErc721.php

Request

GET /v3/nft/royalty/{chain}/{contractAddress}/{tokenId}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetRoyaltyErc721(
    string $chain,
    string $contract_address,
    string $token_id,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\NftRoyaltyErc721

Parameters

Return type

\Tatum\Model\NftRoyaltyErc721

Description

Get NFT royalty information

1 credit per API call

Get information about royalties for an NFT.

This API is supported for the following blockchains:

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

Back to top

nftGetTokensByAddressErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetTokensByAddressErc721.php

Request

GET /v3/nft/address/balance/{chain}/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetTokensByAddressErc721(
    string $chain,
    string $address
): \Tatum\Model\NftTokenByAddressErc721[]

Parameters

Return type

\Tatum\Model\NftTokenByAddressErc721[]

Description

Get all NFTs that a blockchain address holds

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
• BNB Smart Chain - mainnet only
• 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.

Back to top

nftGetTokensByCollectionErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetTokensByCollectionErc721.php

Request

GET /v3/nft/collection/{chain}/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetTokensByCollectionErc721(
    string $chain,
    float $page_size,
    string $address,
    [ float $offset ]
): \Tatum\Model\NftTokenByCollectionErc721[]

Parameters

Return type

\Tatum\Model\NftTokenByCollectionErc721[]

Description

Get all NFTs from a collection

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

Get all NFTs from a collection (all the NFTs that were minted on the smart contract).

This API is supported for the following blockchains:

• Celo
• Ethereum
• Polygon

Back to top

nftGetTransactErc721()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetTransactErc721.php

Request

GET /v3/nft/transaction/{chain}/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetTransactErc721(
    string $chain,
    string $hash,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\NftGetTransactErc721200Response

Parameters

Return type

\Tatum\Model\NftGetTransactErc721200Response

Description

Get an NFT transaction by its hash

1 credit per API call

Get an NFT transaction by its hash.

This API is supported for the following blockchains:

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

Back to top

nftGetTransactionByAddress()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetTransactionByAddress.php

Request

GET /v3/nft/transaction/{chain}/{address}/{tokenAddress}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetTransactionByAddress(
    string $chain,
    string $address,
    string $token_address,
    float $page_size,
    [ float $offset, ]
    [ float $from, ]
    [ float $to ]
): \Tatum\Model\NftTx[]

Parameters

Return type

\Tatum\Model\NftTx[]

Description

Get NFT transactions on a blockchain address

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

Back to top

nftGetTransactionByToken()

Example

#️⃣ Execute command in terminal

✨ php -f nftGetTransactionByToken.php

Request

GET /v3/nft/transaction/tokenId/{chain}/{tokenAddress}/{tokenId}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->nftGetTransactionByToken(
    string $chain,
    string $token_id,
    string $token_address,
    float $page_size,
    [ float $offset, ]
    [ float $from, ]
    [ float $to ]
): \Tatum\Model\NftTx[]

Parameters

Return type

\Tatum\Model\NftTx[]

Description

Get NFT transactions for an NFT

1 credit per API call

Get incoming and outgoing transactions for an NFT.

This API is supported for the following blockchains:

• Celo
• Ethereum
• Polygon

Back to top

transferNft()

Example

#️⃣ Execute command in terminal

✨ php -f transferNft.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNft(
    \Tatum\Model\TransferNft $transfer_nft,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

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, use the transferNftSolana or transferNftSolanaKMS schema of the request body. In the request body:

• Set the from parameter to the address that you used in the to parameter in the request body of the minting call.
• Set the to parameter to the recipient’s address.
• Set the contractAddress parameter to the address from the nftAddress parameter returned in the response body of the minting call.
• Set the fromPrivateKey/signatureId parameter to the private key/signature ID of the blockchain address that you specified in the from parameter.

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

Back to top

transferNftAlgo()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftAlgo.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftAlgo(
    \Tatum\Model\TransferNftAlgo $transfer_nft_algo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftAlgoExpress()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftAlgoExpress.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftAlgoExpress(
    \Tatum\Model\TransferNftAlgoExpress $transfer_nft_algo_express,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftAlgoKMS()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftAlgoKMS.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftAlgoKMS(
    \Tatum\Model\TransferNftAlgoKMS $transfer_nft_algo_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftCelo()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftCelo.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftCelo(
    \Tatum\Model\TransferNftCelo $transfer_nft_celo,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftFlowKMS()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftFlowKMS.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftFlowKMS(
    \Tatum\Model\TransferNftFlowKMS $transfer_nft_flow_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftFlowMnemonic()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftFlowMnemonic.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftFlowMnemonic(
    \Tatum\Model\TransferNftFlowMnemonic $transfer_nft_flow_mnemonic,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Transfer an NFT

Back to top

transferNftFlowPK()

Example

#️⃣ Execute command in terminal

✨ php -f transferNftFlowPK.php

Request

POST /v3/nft/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->nFTERC721OrCompatible()->transferNftFlowPK(
    \Tatum\Model\TransferNftFlowPK $transfer_nft_flow_pk,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned