Api/AuctionApi

Auction API Reference

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

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

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

Methods

approveNftSpending()

Example

#️⃣ Execute command in terminal

✨ php -f approveNftSpending.php

Request

POST /v3/blockchain/auction/approve

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->approveNftSpending(
    \Tatum\Model\ApproveNftSpending $approve_nft_spending
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Allow the NFT auction or marketplace to transfer an asset

2 credits per API call

Allow the NFT auction/marketplace smart contract to transfer the asset (NFT or Multi Token) that is listed for selling. The auction/marketplace smart contract will transfer the asset to the buyer after the asset is purchased.

This API is supported for the following blockchains:

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

Signing a transaction When allowing the NFT auction/marketplace smart contract to transfer the asset, 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

approveNftSpendingCelo()

Example

#️⃣ Execute command in terminal

✨ php -f approveNftSpendingCelo.php

Request

POST /v3/blockchain/auction/approve

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->approveNftSpendingCelo(
    \Tatum\Model\ApproveNftSpendingCelo $approve_nft_spending_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Allow the NFT auction or marketplace to transfer an asset

Back to top

approveNftSpendingCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f approveNftSpendingCeloKMS.php

Request

POST /v3/blockchain/auction/approve

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->approveNftSpendingCeloKMS(
    \Tatum\Model\ApproveNftSpendingCeloKMS $approve_nft_spending_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Allow the NFT auction or marketplace to transfer an asset

Back to top

approveNftSpendingKMS()

Example

#️⃣ Execute command in terminal

✨ php -f approveNftSpendingKMS.php

Request

POST /v3/blockchain/auction/approve

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->approveNftSpendingKMS(
    \Tatum\Model\ApproveNftSpendingKMS $approve_nft_spending_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Allow the NFT auction or marketplace to transfer an asset

Back to top

bidOnAuction()

Example

#️⃣ Execute command in terminal

✨ php -f bidOnAuction.php

Request

POST /v3/blockchain/auction/bid

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bidOnAuction(
    \Tatum\Model\BidOnAuction $bid_on_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Bid for an asset at the NFT auction

2 credits per API call

Bid for an asset listed on the NFT auction.

You can buy the asset either for the native blockchain assets (for example, ETH, BSC, and so on) or for the fungible tokens of the blockchain.

• If you want to pay for the asset with the native assets, send the required amount of the assets with the API call.
• If you want to pay with the fungible tokens, allow the auction smart contract to access your tokens before bidding for the asset. When you make the API call, the auction smart contract will deduct the required amount of the tokens from the smart contract where you hold the tokens.

After you have purchased the asset, it is in a pending state until the auction is settled. Settling the auction means that the asset is transferred to the buyer, the amount is transferred to the seller, and the fee is transferred to the fee recipient of the auction.

For the complete information about how the bidding/purchase process at an auction works, see the API for creating an NFT auction.

This API is supported for the following blockchains:

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

The “execution reverted” message When making this API call, you may get the following message:Although one or more Error Occurred [execution reverted] Contract Execution Completed This message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.

Signing a transaction When bidding for an asset at the NFT auction, 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

bidOnAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f bidOnAuctionCelo.php

Request

POST /v3/blockchain/auction/bid

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bidOnAuctionCelo(
    \Tatum\Model\BidOnAuctionCelo $bid_on_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Bid for an asset at the NFT auction

Back to top

bidOnAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f bidOnAuctionCeloKMS.php

Request

POST /v3/blockchain/auction/bid

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bidOnAuctionCeloKMS(
    \Tatum\Model\BidOnAuctionCeloKMS $bid_on_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Bid for an asset at the NFT auction

Back to top

bidOnAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f bidOnAuctionKMS.php

Request

POST /v3/blockchain/auction/bid

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bidOnAuctionKMS(
    \Tatum\Model\BidOnAuctionKMS $bid_on_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Bid for an asset at the NFT auction

Back to top

bloAucUpdateFeeRecipient()

Example

#️⃣ Execute command in terminal

✨ php -f bloAucUpdateFeeRecipient.php

Request

PUT /v3/blockchain/auction/recipient

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bloAucUpdateFeeRecipient(
    \Tatum\Model\UpdateFeeRecipient $update_fee_recipient
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the recipient of the NFT auction fee

2 credits per API call

Update the recipient of the NFT auction fee.

This API is supported for the following blockchains:

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

Signing a transaction When updating the recipient of the NFT auction, 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

bloAucUpdateFeeRecipientCelo()

Example

#️⃣ Execute command in terminal

✨ php -f bloAucUpdateFeeRecipientCelo.php

Request

PUT /v3/blockchain/auction/recipient

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bloAucUpdateFeeRecipientCelo(
    \Tatum\Model\UpdateFeeRecipientCelo $update_fee_recipient_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the recipient of the NFT auction fee

Back to top

bloAucUpdateFeeRecipientCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f bloAucUpdateFeeRecipientCeloKMS.php

Request

PUT /v3/blockchain/auction/recipient

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bloAucUpdateFeeRecipientCeloKMS(
    \Tatum\Model\UpdateFeeRecipientCeloKMS $update_fee_recipient_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the recipient of the NFT auction fee

Back to top

bloAucUpdateFeeRecipientKMS()

Example

#️⃣ Execute command in terminal

✨ php -f bloAucUpdateFeeRecipientKMS.php

Request

PUT /v3/blockchain/auction/recipient

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->bloAucUpdateFeeRecipientKMS(
    \Tatum\Model\UpdateFeeRecipientKMS $update_fee_recipient_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the recipient of the NFT auction fee

Back to top

cancelAuction()

Example

#️⃣ Execute command in terminal

✨ php -f cancelAuction.php

Request

POST /v3/blockchain/auction/cancel

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->cancelAuction(
    \Tatum\Model\CancelAuction $cancel_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Cancel the selling of an asset at the NFT auction

2 credits per API call

Cancel the selling of an asset at the NFT auction.

You can cancel the selling only if you are the seller of the asset or the auction operator. Once the selling is canceled, the asset is returned to the seller.

You cannot cancel the selling if the asset has already been purchased.

This API is supported for the following blockchains:

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

The “execution reverted” message When making this API call, you may get the following message:Although one or more Error Occurred [execution reverted] Contract Execution Completed This message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.

Signing a transaction When cancelling the selling of an asset at the NFT auction, 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

cancelAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f cancelAuctionCelo.php

Request

POST /v3/blockchain/auction/cancel

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->cancelAuctionCelo(
    \Tatum\Model\CancelAuctionCelo $cancel_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Cancel the selling of an asset at the NFT auction

Back to top

cancelAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f cancelAuctionCeloKMS.php

Request

POST /v3/blockchain/auction/cancel

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->cancelAuctionCeloKMS(
    \Tatum\Model\CancelAuctionCeloKMS $cancel_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Cancel the selling of an asset at the NFT auction

Back to top

cancelAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f cancelAuctionKMS.php

Request

POST /v3/blockchain/auction/cancel

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->cancelAuctionKMS(
    \Tatum\Model\CancelAuctionKMS $cancel_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Cancel the selling of an asset at the NFT auction

Back to top

createAuction()

Example

#️⃣ Execute command in terminal

✨ php -f createAuction.php

Request

POST /v3/blockchain/auction/sell

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->createAuction(
    \Tatum\Model\CreateAuction $create_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Sell an asset at the NFT auction

2 credits per API call

Create new auction on the auction contract. Before operation, seller must approve spending of the NFT token for the Auction contract using Approve NFT. After auction is created, auction contract transfers the asset to the auction smart contract. Only auction for existing NFTs can be created - seller must be owner of the NFT asset.

This API is supported for the following blockchains:

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

A known issue on Harmony On Harmony, when you are viewing a transaction in the Harmony Blockchain Explorer, the transaction status may be displayed as the following:Error reverted:x0 This is a known issue with the Harmony Blockchain Explorer. This status does not mean that the transaction failed. You can safely ignore it.

Signing a transaction When selling an asset at the NFT auction, 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

createAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f createAuctionCelo.php

Request

POST /v3/blockchain/auction/sell

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->createAuctionCelo(
    \Tatum\Model\CreateAuctionCelo $create_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Sell an asset at the NFT auction

Back to top

createAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f createAuctionCeloKMS.php

Request

POST /v3/blockchain/auction/sell

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->createAuctionCeloKMS(
    \Tatum\Model\CreateAuctionCeloKMS $create_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Sell an asset at the NFT auction

Back to top

createAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f createAuctionKMS.php

Request

POST /v3/blockchain/auction/sell

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->createAuctionKMS(
    \Tatum\Model\CreateAuctionKMS $create_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Sell an asset at the NFT auction

Back to top

generateAuction()

Example

#️⃣ Execute command in terminal

✨ php -f generateAuction.php

Request

POST /v3/blockchain/auction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->generateAuction(
    \Tatum\Model\GenerateAuction $generate_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Create an NFT auction

2 credits per API call

Deploy new smart contract for NFT auction logic. Smart contract enables auction operator to create new auction for NFT (ERC-721/1155). Operator can set a fee in percentage, which will be paid on top of the price of the asset. can be offered for native asset - ETH, BSC, etc. - or any ERC20 token - this is configurable during auction creation. Before auction is created, seller must approve transfer of the NFT to the auction contract. Buyer will bid for the asset from the auction using native asset - send assets along the gid() smart contract call, or via ERC20 token. Buyer of the auction must perform approval for the smart contract to access ERC20 token, before the actual bid() method is called. Once there is higher bid then the actual one, the previous bidder’s funds will be returned to him and new bidder will be the current winning one. When auction ends, anyone can settle the auction - NFT will be sent to the bidder, assets to the seller and fee to the operator. This operation deploys a smart contract on the blockchain.

This API is supported for the following blockchains:

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

Signing a transaction When creating an NFT auction, 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

generateAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f generateAuctionCelo.php

Request

POST /v3/blockchain/auction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->generateAuctionCelo(
    \Tatum\Model\GenerateAuctionCelo $generate_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Create an NFT auction

Back to top

generateAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f generateAuctionCeloKMS.php

Request

POST /v3/blockchain/auction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->generateAuctionCeloKMS(
    \Tatum\Model\GenerateAuctionCeloKMS $generate_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Create an NFT auction

Back to top

generateAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f generateAuctionKMS.php

Request

POST /v3/blockchain/auction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->generateAuctionKMS(
    \Tatum\Model\GenerateAuctionKMS $generate_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Create an NFT auction

Back to top

getAuction()

Example

#️⃣ Execute command in terminal

✨ php -f getAuction.php

Request

GET /v3/blockchain/auction/{chain}/{contractAddress}/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->getAuction(
    string $chain,
    string $contract_address,
    string $id
): \Tatum\Model\GetAuction200Response

Parameters

Return type

\Tatum\Model\GetAuction200Response

Description

Get information about an auctioned asset at the NFT auction

1 credit per API call

Get information about a specific auctioned asset at the NFT auction.

This API is supported for the following blockchains:

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

Back to top

getAuctionFee()

Example

#️⃣ Execute command in terminal

✨ php -f getAuctionFee.php

Request

GET /v3/blockchain/auction/{chain}/{contractAddress}/fee

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->getAuctionFee(
    string $chain,
    string $contract_address
): float

Parameters

Return type

float

Description

Get the NFT auction fee

1 credit per API call

Get the NFT auction fee.

This API is supported for the following blockchains:

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

Back to top

getAuctionFeeRecipient()

Example

#️⃣ Execute command in terminal

✨ php -f getAuctionFeeRecipient.php

Request

GET /v3/blockchain/auction/{chain}/{contractAddress}/recipient

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->getAuctionFeeRecipient(
    string $chain,
    string $contract_address
): \Tatum\Model\GetAuctionFeeRecipient200Response

Parameters

Return type

\Tatum\Model\GetAuctionFeeRecipient200Response

Description

Get the recipient of the NFT auction fee

1 credit per API call

Get the recipient of the NFT auction fee.

This API is supported for the following blockchains:

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

Back to top

settleAuction()

Example

#️⃣ Execute command in terminal

✨ php -f settleAuction.php

Request

POST /v3/blockchain/auction/settle

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->settleAuction(
    \Tatum\Model\SettleAuction $settle_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Settle an NFT auction

2 credits per API call

Settle an auction once it has ended and there is a buyer of the asset at this auction. Settling the auction means that the asset is transferred to the buyer, the amount is transferred to the seller, and the fee is transferred to the fee recipient of the auction. Both seller and buyer can settle the auction.

This API is supported for the following blockchains:

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

The “execution reverted” message When making this API call, you may get the following message:Although one or more Error Occurred [execution reverted] Contract Execution Completed This message is a result of the auction version check and has no impact on completing the API call. You can safely ignore it.

Signing a transaction When settling the NFT auction, 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

settleAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f settleAuctionCelo.php

Request

POST /v3/blockchain/auction/settle

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->settleAuctionCelo(
    \Tatum\Model\SettleAuctionCelo $settle_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Settle an NFT auction

Back to top

settleAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f settleAuctionCeloKMS.php

Request

POST /v3/blockchain/auction/settle

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->settleAuctionCeloKMS(
    \Tatum\Model\SettleAuctionCeloKMS $settle_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Settle an NFT auction

Back to top

settleAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f settleAuctionKMS.php

Request

POST /v3/blockchain/auction/settle

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->settleAuctionKMS(
    \Tatum\Model\SettleAuctionKMS $settle_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Settle an NFT auction

Back to top

updateFeeAuction()

Example

#️⃣ Execute command in terminal

✨ php -f updateFeeAuction.php

Request

PUT /v3/blockchain/auction/fee

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->updateFeeAuction(
    \Tatum\Model\UpdateFeeAuction $update_fee_auction
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the NFT auction fee

2 credits per API call

Update the NFT auction fee.

This API is supported for the following blockchains:

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

Signing a transaction When updating the NFT auction fee, 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

updateFeeAuctionCelo()

Example

#️⃣ Execute command in terminal

✨ php -f updateFeeAuctionCelo.php

Request

PUT /v3/blockchain/auction/fee

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->updateFeeAuctionCelo(
    \Tatum\Model\UpdateFeeAuctionCelo $update_fee_auction_celo
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the NFT auction fee

Back to top

updateFeeAuctionCeloKMS()

Example

#️⃣ Execute command in terminal

✨ php -f updateFeeAuctionCeloKMS.php

Request

PUT /v3/blockchain/auction/fee

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->updateFeeAuctionCeloKMS(
    \Tatum\Model\UpdateFeeAuctionCeloKMS $update_fee_auction_celo_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the NFT auction fee

Back to top

updateFeeAuctionKMS()

Example

#️⃣ Execute command in terminal

✨ php -f updateFeeAuctionKMS.php

Request

PUT /v3/blockchain/auction/fee

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->auction()->updateFeeAuctionKMS(
    \Tatum\Model\UpdateFeeAuctionKMS $update_fee_auction_kms
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Update the NFT auction fee

Back to top