Token Editions
Last updated
Last updated
A token Edition is a single token. If you want you can set a edition from one of your collections to be minted. Here you are also able to transfer a token if you are its owner to another wallet. Note that this operation also uses gas and can be estimated beforehand.
List all tokens
2022-01-30T10:30:40-03:00
1
Example: 1
10
Example: 10
curl -L \
--url '/{companyId}/token-editions' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"meta": {
"itemCount": 1,
"totalItems": 1,
"itemsPerPage": 1,
"totalPages": 1,
"currentPage": 1
},
"links": {
"first": "http://example.com?page=1",
"prev": "http://example.com?page=1",
"next": "http://example.com?page=2",
"last": "http://example.com?page=3"
},
"items": [
{
"id": "text",
"companyId": "text",
"editionNumber": 1,
"tokenCollection": {
"id": "text",
"companyId": "text",
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"status": "draft",
"contractId": "text",
"subcategoryId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"publishedTokenTemplate": {
"prop1": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
},
"prop2": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
}
},
"quantity": 1,
"initialQuantityToMint": 1,
"initialQuantity": 1,
"rangeInitialToMint": "text",
"quantityMinted": 1,
"rfids": [
"text"
],
"ownerAddress": "text",
"pass": true,
"similarTokens": true,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": true
}
},
"contractId": "text",
"contract": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"royaltyId": "123e4567-e89b-12d3-a456-426614174000",
"address": "text",
"chainId": 1,
"name": "text",
"symbol": "text",
"description": "text",
"image": "text",
"externalLink": "text",
"operators": [
"text"
],
"roles": [
[]
],
"status": "draft",
"contractActionId": "text",
"features": [
"admin:minter"
],
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"tokenCollectionId": "text",
"rfid": "text",
"status": "draft",
"contractAddress": "text",
"ownerAddress": "text",
"chainId": 1,
"tokenId": 1,
"mintedHash": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"nftMinting": {
"id": "text",
"companyId": "text",
"contractId": "text",
"contractAddress": "text",
"ownerAddress": "text",
"sender": "text",
"chainId": 1,
"startEdition": 1,
"endEdition": 1,
"batchNumber": 1,
"status": "created",
"txHash": "text",
"txId": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"metadata": {},
"nfts": [
[]
],
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
},
"nftMintingId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"rawData": {},
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"mintedAddress": "text"
}
]
}
curl -L \
--url '/{companyId}/token-editions/check-rfid?rfid=text' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"used": true
}
Change status to ready to mint by token
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/{id}/ready-to-mint' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"id": "text",
"companyId": "text",
"editionNumber": 1,
"tokenCollection": {
"id": "text",
"companyId": "text",
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"status": "draft",
"contractId": "text",
"subcategoryId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"publishedTokenTemplate": {
"prop1": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
},
"prop2": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
}
},
"quantity": 1,
"initialQuantityToMint": 1,
"initialQuantity": 1,
"rangeInitialToMint": "text",
"quantityMinted": 1,
"rfids": [
"text"
],
"ownerAddress": "text",
"pass": true,
"similarTokens": true,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": true
}
},
"contractId": "text",
"contract": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"royaltyId": "123e4567-e89b-12d3-a456-426614174000",
"address": "text",
"chainId": 1,
"name": "text",
"symbol": "text",
"description": "text",
"image": "text",
"externalLink": "text",
"operators": [
"text"
],
"roles": [
[]
],
"status": "draft",
"contractActionId": "text",
"features": [
"admin:minter"
],
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"tokenCollectionId": "text",
"rfid": "text",
"status": "draft",
"contractAddress": "text",
"ownerAddress": "text",
"chainId": 1,
"tokenId": 1,
"mintedHash": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"nftMinting": {
"id": "text",
"companyId": "text",
"contractId": "text",
"contractAddress": "text",
"ownerAddress": "text",
"sender": "text",
"chainId": 1,
"startEdition": 1,
"endEdition": 1,
"batchNumber": 1,
"status": "created",
"txHash": "text",
"txId": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"metadata": {},
"nfts": [
[]
],
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
},
"nftMintingId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"rawData": {},
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
}
Estimate gas to mint tokens
quantity of token to mint
1
curl -L \
--url '/{companyId}/token-editions/{id}/estimate-gas/mint?quantityToMint=1' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"totalGas": 1,
"totalGasPrice": {
"safe": "text",
"proposed": "text",
"fast": "text"
}
}
Estimate gas to burn
curl -L \
--url '/{companyId}/token-editions/{id}/estimate-gas/burn' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"totalGas": 1,
"totalGasPrice": {
"safe": "text",
"proposed": "text",
"fast": "text"
}
}
Get a token by id
curl -L \
--url '/{companyId}/token-editions/{id}' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"id": "text",
"companyId": "text",
"editionNumber": 1,
"tokenCollection": {
"id": "text",
"companyId": "text",
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"status": "draft",
"contractId": "text",
"subcategoryId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"publishedTokenTemplate": {
"prop1": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
},
"prop2": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
}
},
"quantity": 1,
"initialQuantityToMint": 1,
"initialQuantity": 1,
"rangeInitialToMint": "text",
"quantityMinted": 1,
"rfids": [
"text"
],
"ownerAddress": "text",
"pass": true,
"similarTokens": true,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": true
}
},
"contractId": "text",
"contract": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"royaltyId": "123e4567-e89b-12d3-a456-426614174000",
"address": "text",
"chainId": 1,
"name": "text",
"symbol": "text",
"description": "text",
"image": "text",
"externalLink": "text",
"operators": [
"text"
],
"roles": [
[]
],
"status": "draft",
"contractActionId": "text",
"features": [
"admin:minter"
],
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"tokenCollectionId": "text",
"rfid": "text",
"status": "draft",
"contractAddress": "text",
"ownerAddress": "text",
"chainId": 1,
"tokenId": 1,
"mintedHash": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"nftMinting": {
"id": "text",
"companyId": "text",
"contractId": "text",
"contractAddress": "text",
"ownerAddress": "text",
"sender": "text",
"chainId": 1,
"startEdition": 1,
"endEdition": 1,
"batchNumber": 1,
"status": "created",
"txHash": "text",
"txId": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"metadata": {},
"nfts": [
[]
],
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
},
"nftMintingId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"rawData": {},
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"mintedAddress": "text"
}
Estimate gas to transfer token
curl -L \
--url '/{companyId}/token-editions/{id}/estimate-gas/transfer?toAddress=text' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"totalGas": 1,
"totalGasPrice": {
"safe": "text",
"proposed": "text",
"fast": "text"
}
}
Get last transfer or burn transaction
curl -L \
--url '/{companyId}/token-editions/{id}/get-last/{type}' \
--header 'x-w3block-api-key: YOUR_API_KEY'
{
"toAddress": "text",
"sender": "text",
"status": "created",
"txHash": "text",
"chainId": 80001,
"metadata": {
"status": "text",
"message": "text"
}
}
Retry a bulk mint by collection
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/retry-bulk-by-collection' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"jobId": "text"
}'
No Content
Change status to ready to mint
Array of token ids
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/ready-to-mint' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"editionId": []
}'
No Content
Burn token
curl -L \
--request DELETE \
--url '/{companyId}/token-editions/burn' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"tokens": [
"text"
]
}'
No Content
Change rfid by id
zf4pg538qx
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/{id}/rfid' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"rfid": "zf4pg538qx"
}'
{
"id": "text",
"companyId": "text",
"editionNumber": 1,
"tokenCollection": {
"id": "text",
"companyId": "text",
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"status": "draft",
"contractId": "text",
"subcategoryId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"publishedTokenTemplate": {
"prop1": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
},
"prop2": {
"type": "SELECT",
"config": {
"required": {},
"label": "text",
"tooltip": "text",
"placeholder": "text",
"order": 1,
"childrenType": "SELECT",
"range": {
"min": 1,
"max": 1
},
"options": [
"text"
],
"float": true
},
"children": {}
}
},
"quantity": 1,
"initialQuantityToMint": 1,
"initialQuantity": 1,
"rangeInitialToMint": "text",
"quantityMinted": 1,
"rfids": [
"text"
],
"ownerAddress": "text",
"pass": true,
"similarTokens": true,
"settings": {
"sendWebhookWhenTokenEditionIsUpdated": true
}
},
"contractId": "text",
"contract": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"royaltyId": "123e4567-e89b-12d3-a456-426614174000",
"address": "text",
"chainId": 1,
"name": "text",
"symbol": "text",
"description": "text",
"image": "text",
"externalLink": "text",
"operators": [
"text"
],
"roles": [
[]
],
"status": "draft",
"contractActionId": "text",
"features": [
"admin:minter"
],
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z",
"transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
"maxSupply": 1
},
"tokenCollectionId": "text",
"rfid": "text",
"status": "draft",
"contractAddress": "text",
"ownerAddress": "text",
"chainId": 1,
"tokenId": 1,
"mintedHash": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"nftMinting": {
"id": "text",
"companyId": "text",
"contractId": "text",
"contractAddress": "text",
"ownerAddress": "text",
"sender": "text",
"chainId": 1,
"startEdition": 1,
"endEdition": 1,
"batchNumber": 1,
"status": "created",
"txHash": "text",
"txId": "text",
"mintedAt": "2025-04-10T15:55:28.650Z",
"metadata": {},
"nfts": [
[]
],
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
},
"nftMintingId": "text",
"name": "text",
"description": "text",
"mainImage": "text",
"tokenData": {},
"rawData": {},
"deletedAt": "2025-04-10T15:55:28.650Z",
"createdAt": "2025-04-10T15:55:28.650Z",
"updatedAt": "2025-04-10T15:55:28.650Z"
}
Transfer token
Array of token ids
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/transfer-token' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"toAddress": "text",
"editionId": []
}'
No Content
Need user with one of these roles: superAdmin, admin
curl -L \
--request PATCH \
--url '/{companyId}/token-editions/{id}/transfer-token' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"toAddress": "text"
}'
No Content
["0x82dbB0A14F79f50c8f8e0D50FC9F1ef30Aeb6C79","0x39926ceceb3cc78ab2cced96f217df3e7bed48c1"]
curl -L \
--request PATCH \
--url '/tokens/check-collection-token-holder' \
--header 'x-w3block-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"walletAddresses": [
"0x82dbB0A14F79f50c8f8e0D50FC9F1ef30Aeb6C79",
"0x39926ceceb3cc78ab2cced96f217df3e7bed48c1"
],
"collections": [
{
"contractAddress": "0x389dd295657a6fb2336aa33e40aeb8fb81f97fe4",
"chainId": 80001,
"startTokenId": 1,
"endTokenId": 100,
"metadataRequirements": [
[]
],
"collectionId": "123e4567-e89b-12d3-a456-426614174000",
"erc20ContractId": "123e4567-e89b-12d3-a456-426614174000",
"requiredAmount": 10
}
]
}'
No Content
Need user with one of these roles: superAdmin, admin