Tatum

Auction

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

Blockchain to work with.

Enum: "ETH" "ONE" "KLAY" "BSC" "MATIC"
feeRecipient
required
string = 42 characters

Address of the recipient of the fee for the trade.

auctionFee
required
number [ 0 .. 10000 ]

Percentage of the selling amount of the NFT asset. 100 - 1%

fromPrivateKey
required
string = 66 characters

Private key of sender address. Private key, or signature Id must be present.

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object

Custom defined fee. If not present, it will be calculated automatically.

gasLimit
required
string^[+]?\d+$

Gas limit for transaction in gas price.

gasPrice
required
string^[+]?\d+$

Gas price in Gwei.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction
Request samples
application/json
{
  • "chain": "ETH",
  • "feeRecipient": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "auctionFee": 150,
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

Blockchain to work with.

Enum: "ETH" "ONE" "BSC" "KLAY" "MATIC"
contractAddress
required
string = 42 characters

Address of the auction smart contract.

nftAddress
required
string = 42 characters

Address of the NFT asset to sell smart contract.

seller
required
string = 42 characters

Address of the seller of the NFT asset.

erc20Address
string = 42 characters

Optional address of the ERC20 token, which will be used as a selling currency of the NFT.

id
required
string [ 1 .. 200 ] characters

ID of the auction. It's up to the developer to generate unique ID

amount
string^[+]?((\d+(\.\d*)?)|(\.\d+))$

Amount of the assets to be sent. For ERC-721 tokens, enter 1.

tokenId
required
string <= 256 characters

ID of token, if transaction is for ERC-721 or ERC-1155.

endedAt
required
number >= 0

Last block, where auction accepts bids.

isErc721
required
boolean

True if asset is NFT of type ERC721, false if ERC1155.

fromPrivateKey
required
string = 66 characters

Private key of sender address. Private key, or signature Id must be present.

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object

Custom defined fee. If not present, it will be calculated automatically.

gasLimit
required
string^[+]?\d+$

Gas limit for transaction in gas price.

gasPrice
required
string^[+]?\d+$

Gas price in Gwei.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction/sell
Request samples
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "nftAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "seller": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "id": "string",
  • "tokenId": "100000",
  • "endedAt": 100000,
  • "isErc721": true,
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

Blockchain to work with.

Enum: "ETH" "ONE" "BSC" "KLAY" "MATIC"
contractAddress
required
string = 42 characters

Address of the auction smart contract.

erc20Address
string = 42 characters

Optional address of the ERC20 token, which will be used as a selling currency of the NFT.

bidder
string = 42 characters

In case of the ERC20 auction, it's possible to bid on behalf of someone else. This value is the address of the bidder, which should approve spending of the ERC20 tokens for the Auction contract. This could be used for a bidding from the custodial wallet address.

id
required
string [ 1 .. 200 ] characters

ID of the auction.

bidValue
required
string^[+]?((\d+(\.\d*)?)|(\.\d+))$

Amount of the assets to be bid. This must include auction fee.

fromPrivateKey
required
string = 66 characters

Private key of sender address. Private key, or signature Id must be present.

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object

Custom defined fee. If not present, it will be calculated automatically.

gasLimit
required
string^[+]?\d+$

Gas limit for transaction in gas price.

gasPrice
required
string^[+]?\d+$

Gas price in Gwei.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction/bid
Request samples
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x487422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "id": "string",
  • "bidValue": "1",
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

The blockchain to work with

Enum: "BSC" "ETH" "KLAY" "MATIC" "ONE"
contractAddress
required
string = 42 characters

The blockchain address of the auction smart contract

id
required
string [ 1 .. 200 ] characters

The ID of the auction

fromPrivateKey
required
string = 66 characters

The private key of the blockchain address from which the fee will be deducted

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object (CustomFee)

The custom defined fee; if not present, will be calculated automatically

gasPrice
required
string^[+]?\d+$

The price for one gas unit (in Gwei)

gasLimit
required
string^[+]?\d+$

The maximum number of gas units that you are willing to spend on processing the transaction at the provided gas price

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction/settle
Request samples
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "id": "string",
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

The blockchain to work with

Enum: "BSC" "ETH" "KLAY" "MATIC" "ONE"
contractAddress
required
string = 42 characters

The blockchain address of the auction smart contract

id
required
string [ 1 .. 200 ] characters

The ID of the auction

fromPrivateKey
required
string = 66 characters

The private key of the blockchain address from which the fee will be deducted

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object (CustomFee)

The custom defined fee; if not present, will be calculated automatically

gasPrice
required
string^[+]?\d+$

The price for one gas unit (in Gwei)

gasLimit
required
string^[+]?\d+$

The maximum number of gas units that you are willing to spend on processing the transaction at the provided gas price

erc20Address
string = 42 characters

Optional address of the ERC20 token, which will be used as a selling currency of the NFT.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction/cancel
Request samples
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "id": "string",
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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.

SecurityX-API-Key
Request
Request Body schema: application/json
One of:
chain
required
string

The blockchain to work with

Enum: "BSC" "ETH" "KLAY" "MATIC" "ONE"
spender
required
string = 42 characters

The blockchain address of the auction/marketplace smart contract

isErc721
required
boolean

Set to "true" if the asset is an NFT; set to "false" is the asset is a Multi Token

tokenId
required
string <= 256 characters

The ID of the asset (NFT or Multi Token)

contractAddress
required
string = 42 characters

The blockchain address of the smart contract from which the asset (NFT or Multi Token) was minted

fromPrivateKey
required
string = 66 characters

The private key of the blockchain address from which the fee will be deducted

nonce
number

The nonce to be set to the transaction; if not present, the last known nonce will be used

object (CustomFee)

The custom defined fee; if not present, will be calculated automatically

gasPrice
required
string^[+]?\d+$

The price for one gas unit (in Gwei)

gasLimit
required
string^[+]?\d+$

The maximum number of gas units that you are willing to spend on processing the transaction at the provided gas price

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

post/v3/blockchain/auction/approve
Request samples
application/json
{
  • "chain": "ETH",
  • "spender": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "isErc721": true,
  • "tokenId": "100000",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}

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
SecurityX-API-Key
Request
path Parameters
chain
required
string

Blockchain to work with

Enum: "ETH" "ONE" "CELO" "MATIC" "BSC"
contractAddress
required
string

Contract address

Example: 0xe6e7340394958674cdf8606936d292f565e4ecc4
id
required
string

Auction ID

Example: 123456
Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403

Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.

500

Internal server error. There was an error on the server while processing the request.

get/v3/blockchain/auction/{chain}/{contractAddress}/{id}
Request samples 
Response samples 
application/json
{
  • "amount": "1",
  • "bidder": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8",
  • "erc20Address": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8",
  • "isErc721": true,
  • "startedAt": "12345",
  • "endedAt": "12349",
  • "nftAddress": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8",
  • "endingPrice": "1.234",
  • "seller": "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8",
  • "highestBid": "1.234"
}
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
    • 



SecurityX-API-Key 
Request 
path Parameters
chain
required
string
Blockchain to work with


 Enum: "ETH" "ONE" "CELO" "MATIC" "BSC"  
contractAddress
required
string
Contract address


 
 Example:  0xe6e7340394958674cdf8606936d292f565e4ecc4
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/blockchain/auction/{chain}/{contractAddress}/fee
Request samples 
Response samples 
application/json
2.25
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
    • 



SecurityX-API-Key 
Request 
path Parameters
chain
required
string
Blockchain to work with


 Enum: "ETH" "ONE" "CELO" "MATIC" "BSC"  
contractAddress
required
string
Contract address


 
 Example:  0xe6e7340394958674cdf8606936d292f565e4ecc4
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


get/v3/blockchain/auction/{chain}/{contractAddress}/recipient
Request samples 
Response samples 
application/json
{
  • "address": "0xe6e7340394958674cdf8606936d292f565e4ecc4"
}
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.


SecurityX-API-Key 
Request 
Request Body schema: application/json
One of:
chain
required
string
Blockchain to work with.


 Enum: "ETH" "ONE" "BSC" "KLAY" "MATIC"  
contractAddress
required
string  = 42 characters 
Address of the marketplace smart contract.


 
feeRecipient
required
string  = 42 characters 
Recipient address of the marketplace fee.


 
fromPrivateKey
required
string  = 66 characters 
Private key of sender address. Private key, or signature Id must be present.


 
nonce
number
The nonce to be set to the transaction; if not present, the last known nonce will be used


 
object
Custom defined fee. If not present, it will be calculated automatically.


 
gasLimit
required
string^[+]?\d+$
Gas limit for transaction in gas price.


 
gasPrice
required
string^[+]?\d+$
Gas price in Gwei.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


put/v3/blockchain/auction/recipient
Request samples 
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "feeRecipient": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
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.


SecurityX-API-Key 
Request 
Request Body schema: application/json
One of:
chain
required
string
The blockchain to work with


 Enum: "ETH" "ONE" "BSC" "KLAY" "MATIC"  
contractAddress
required
string  = 42 characters 
The blockchain address of the auction smart contract


 
auctionFee
required
number  [ 0 .. 10000 ] 
The percentage of the amount that an NFT was sold for that will be sent to the auction as a fee. To set the fee to 1%, set this parameter to 100; to set 10%, set this parameter to 1000; to set 50%, set this parameter to 5000, and so on.


 
fromPrivateKey
required
string  = 66 characters 
The private key of the blockchain address from which the fee will be deducted


 
nonce
number
The nonce to be set to the transaction; if not present, the last known nonce will be used


 
object (CustomFee) 
The custom defined fee; if not present, will be calculated automatically


 
gasPrice
required
string^[+]?\d+$
The price for one gas unit (in Gwei)


 
gasLimit
required
string^[+]?\d+$
The maximum number of gas units that you are willing to spend on processing the transaction at the provided gas price


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.


500
Internal server error. There was an error on the server while processing the request.


put/v3/blockchain/auction/fee
Request samples 
application/json
{
  • "chain": "ETH",
  • "contractAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  • "auctionFee": 150,
  • "fromPrivateKey": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
➔ Next to Key Management System