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:
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.
# OpenAPI definition ```json { "openapi": "3.0.0", "servers": [ { "url": "https://api.tatum.io" } ], "info": { "version": "1.0.1", "title": "SMART CONTRACTS" }, "tags": [ { "name": "Auction" } ], "paths": { "/v3/blockchain/auction/settle": { "post": { "description": "/v3/blockchain/auction/settle
\n2 credits per API call
\nSettle 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:
\nThe \"execution reverted\" message
\nWhen making this API call, you may get the following message:
\nAlthough one or more Error Occurred [execution reverted] Contract Execution Completed
\nThis 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
\nWhen 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.
\nFor 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.
\n", "operationId": "SettleAuction", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SettleAuction" }, { "$ref": "#/components/schemas/SettleAuctionKMS" }, { "$ref": "#/components/schemas/SettleAuctionCelo" }, { "$ref": "#/components/schemas/SettleAuctionCeloKMS" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionHash" }, { "$ref": "#/components/schemas/SignatureId" } ] } } }, "description": "OK" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "$ref": "#/components/responses/Error403" }, "500": { "$ref": "#/components/responses/Error500" } }, "security": [ { "X-API-Key": [] } ], "x-codeSamples": [], "summary": "Settle an NFT auction", "tags": [ "Auction" ] } } }, "components": { "securitySchemes": { "X-API-Key": { "type": "apiKey", "name": "x-api-key", "in": "header", "description": "Your **API key** is used to identify your account & your plan, including the number of API calls per second and total monthly calls you have.\n\nEach key is for individual use only.\n\nIf you don't have a key already you can [Sign up for a Free Tatum account](https://co.tatum.io/signup) to get two keys (testnet and mainnet), allowing up to 5 API calls per second and 1,000,000 Credits.\n\nFor testing purposes, you can use the following key which only works inside docs and has limited functionality (e.g. you cannot create virtual accounts or notification subscriptions with it):\n* t-66a730ccccfd17001c479705-2f597d14ad7543f289a03418\n\nFor more details on limits and plans, [click here](https://docs.tatum.io/docs/plans-limits).\n" } }, "responses": { "Error400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": "validation.failed", "description": "validation.failed", "type": "string" }, "message": { "example": "Request validation failed. Please see data for additional information.", "description": "Request validation failed. Please see data for additional information.", "type": "string" }, "statusCode": { "example": 400, "description": "400", "type": "number" }, "data": { "type": "array", "items": { "type": "object", "required": [ "target" ], "properties": { "target": { "type": "object", "additionalProperties": true, "description": "Request object present in the body of the HTTP request", "example": { "property": 12345 } }, "value": { "type": "number", "description": "Value of the target object which validation is wrong. Can be of any data type, example here is using type number.", "example": 12345 }, "property": { "type": "string", "description": "Property name of the target object which validation is wrong", "example": "property1" }, "constraints": { "type": "object", "additionalProperties": true, "description": "Object of failed constraints for the target object. Key is the constraint, value is detailed description of the failed constraint.", "example": { "min": "property1 must not be less than 50000" } } } } } }, "required": [ "errorCode", "message", "statusCode", "data" ], "type": "object" } } } }, "Error401": { "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header.", "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "errorCode": { "example": "subscription.not.active", "description": "subscription.not.active", "type": "string" }, "message": { "example": "Subscription not active anymore.", "description": "Subscription not active anymore.", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": [ "errorCode", "message", "statusCode" ], "type": "object" }, { "properties": { "errorCode": { "example": "subscription.invalid", "description": "subscription.invalid", "type": "string" }, "message": { "example": "Unable to find valid subscription for '${apiKey}'", "description": "Unable to find valid subscription for '${apiKey}'", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": [ "errorCode", "message", "statusCode" ], "type": "object" } ] } } } }, "Error403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the operation due to logical error or invalid permissions.", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "description": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "description": "403", "type": "number" } }, "required": [ "statusCode", "message" ], "type": "object" } } } }, "Error500": { "description": "Internal server error. There was an error on the server during the processing of the request.", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Internal server error", "description": "Internal server error", "type": "string" }, "statusCode": { "example": 500, "description": "500", "type": "number" } }, "required": [ "statusCode", "message" ], "type": "object" } } } } }, "schemas": { "CustomFee": { "description": "The custom defined fee; if not present, will be calculated automatically", "type": "object", "required": [ "gasLimit", "gasPrice" ], "properties": { "gasPrice": { "type": "string", "description": "The price for one gas unit (in Gwei)", "pattern": "^[+]?\\d+$", "example": "20" }, "gasLimit": { "type": "string", "description": "The maximum number of gas units that you are willing to spend on processing the transaction at the provided gas price", "pattern": "^[+]?\\d+$", "example": "40000" } } }, "TransactionHash": { "type": "object", "properties": { "txId": { "description": "The hash (ID) of the transaction", "example": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9", "type": "string" } }, "required": [ "txId" ] }, "SignatureId": { "type": "object", "properties": { "signatureId": { "format": "uuid", "description": "The internal Tatum ID of the prepared transaction for Key Management Sysytem (KMS) to signsignatureId parameter that you provided in the request body. The signatureId parameter in the request body specifies the signature ID associated with the private key in KMS.",
"example": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6",
"type": "string"
}
},
"required": [
"signatureId"
]
},
"SettleAuction": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": [
"BSC",
"ETH",
"KLAY",
"MATIC",
"ONE"
],
"example": "ETH",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the auction smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID of the auction",
"minLength": 1,
"maxLength": 200
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address from which the fee will be deducted"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transaction; if not present, the last known nonce will be used"
},
"fee": {
"$ref": "#/components/schemas/CustomFee"
}
},
"required": [
"chain",
"contractAddress",
"id",
"fromPrivateKey"
]
},
"SettleAuctionCelo": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": [
"CELO"
],
"example": "CELO",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the auction smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID of the auction",
"minLength": 1,
"maxLength": 200
},
"feeCurrency": {
"type": "string",
"description": "The currency in which the transaction fee will be paid",
"enum": [
"CELO",
"CUSD",
"CEUR"
]
},
"fromPrivateKey": {
"type": "string",
"maxLength": 66,
"example": "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2",
"minLength": 66,
"description": "The private key of the blockchain address from which the fee will be deducted"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transaction; if not present, the last known nonce will be used"
},
"fee": {
"$ref": "#/components/schemas/CustomFee"
}
},
"required": [
"chain",
"contractAddress",
"id",
"feeCurrency",
"fromPrivateKey"
]
},
"SettleAuctionKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": [
"BSC",
"ETH",
"KLAY",
"MATIC",
"ONE"
],
"example": "ETH",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the auction smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID of the auction",
"minLength": 1,
"maxLength": 200
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address from which the fee will be deducted"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the address from which the fee will be deducted that was generated from the mnemonic"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transaction; if not present, the last known nonce will be used"
},
"fee": {
"$ref": "#/components/schemas/CustomFee"
}
},
"required": [
"contractAddress",
"chain",
"id",
"signatureId"
]
},
"SettleAuctionCeloKMS": {
"type": "object",
"properties": {
"chain": {
"description": "The blockchain to work with",
"enum": [
"CELO"
],
"example": "CELO",
"type": "string"
},
"contractAddress": {
"maxLength": 42,
"minLength": 42,
"description": "The blockchain address of the auction smart contract",
"example": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID of the auction",
"minLength": 1,
"maxLength": 200
},
"feeCurrency": {
"type": "string",
"description": "The currency in which the transaction fee will be paid",
"enum": [
"CELO",
"CUSD",
"CEUR"
]
},
"signatureId": {
"type": "string",
"format": "uuid",
"example": "26d3883e-4e17-48b3-a0ee-09a3e484ac83",
"description": "The KMS identifier of the private key of the blockchain address from which the fee will be deducted"
},
"index": {
"type": "number",
"minimum": 0,
"description": "(Only if the signature ID is mnemonic-based) The index of the address from which the fee will be deducted that was generated from the mnemonic"
},
"nonce": {
"type": "number",
"example": 1,
"description": "The nonce to be set to the transaction; if not present, the last known nonce will be used"
},
"fee": {
"$ref": "#/components/schemas/CustomFee"
}
},
"required": [
"chain",
"contractAddress",
"id",
"feeCurrency",
"signatureId"
]
}
}
}
}
```